Enum ve Model Referansı
PF Gateway API'de kullanılan tüm enum ve model tanımları.
Bu sayfa, API'de kullanılan tüm enum tipleri ve ortak model tanımlarını içerir.
Enum Tipleri
PaymentType
Ödeme işlem tipi.
| Değer | Açıklama |
|---|---|
Auth | Doğrudan satış — tutar anında çekilir |
PreAuth | Ön provizyon — tutarı bloke eder |
PostAuth | Ön provizyon tamamlama |
TransactionType
İşlem tipi.
| Değer | Açıklama |
|---|---|
Auth | Satış |
PreAuth | Ön provizyon |
Return | İade |
PostAuth | Ön provizyon tamamlama |
Reverse | İptal |
Void | Void işlemi |
Refund | Geri ödeme |
TransactionStatus
İşlem durumu.
| Değer | Açıklama |
|---|---|
Pending | Beklemede |
Fail | Başarısız |
Success | Başarılı |
Returned | İade edildi |
PartiallyReturned | Kısmi iade edildi |
Reversed | İptal edildi |
Closed | Kapatıldı |
PartiallyClosed | Kısmi kapatıldı |
CardBrand
Kart markası.
| Değer | Açıklama |
|---|---|
Undefined | Tanımsız |
UnionPay | UnionPay |
Amex | American Express |
Visa | Visa |
Troy | Troy |
MasterCard | MasterCard |
CardNetwork
Kart ağı / programı.
| Değer | Açıklama |
|---|---|
Unknown | Bilinmiyor |
CardFinans | CardFinans |
World | World |
Paraf | Paraf |
Maximum | Maximum |
Axess | Axess |
Advantage | Advantage |
Bonus | Bonus |
BankKart | BanKart |
SaglamKart | SaglamKart |
CardType
Kart tipi.
| Değer | Açıklama |
|---|---|
Unknown | Bilinmiyor |
Credit | Kredi kartı |
Debit | Banka kartı |
QRCode | QR Kod |
CardSubType
Kart alt tipi.
| Değer | Açıklama |
|---|---|
Unknown | Bilinmiyor |
Classic | Klasik |
Business | Ticari |
ProfileCardType
Profil kart tipi (taksit sorgulamada kullanılır).
| Değer | Açıklama |
|---|---|
Credit | Kredi kartı |
Debit | Banka kartı |
International | Uluslararası kart |
Amex | American Express |
Wallet | Cüzdan |
QRCode | QR Kod |
IntegrationMode
Entegrasyon modu.
| Değer | Açıklama |
|---|---|
Unknown | Bilinmiyor |
Api | Doğrudan API entegrasyonu |
Hpp | Hosted Payment Page |
ManuelPaymentPage | Manuel ödeme sayfası |
LinkPaymentPage | Link ödeme sayfası |
OnUs | On-us işlem |
LinkType
Ödeme link tipi.
| Değer | Açıklama |
|---|---|
SingleUse | Tek kullanımlık |
MultipleUse | Çok kullanımlık |
LinkAmountType
Link tutar tipi.
| Değer | Açıklama |
|---|---|
FixedAmount | Sabit tutar |
VariableAmount | Değişken tutar |
ChannelStatus
Link kanal durumu.
| Değer | Açıklama |
|---|---|
Active | Aktif |
Passive | Pasif |
Expired | Süresi dolmuş |
Cancelled | İptal edilmiş |
ChannelPaymentStatus
Link ödeme durumu.
| Değer | Açıklama |
|---|---|
Pending | Beklemede |
Success | Başarılı |
Failed | Başarısız |
Expired | Süresi dolmuş |
NotificationMethod
Bildirim yöntemi.
| Değer | Açıklama |
|---|---|
None | Bildirim yok |
Sms | SMS ile bildirim |
Email | E-posta ile bildirim |
Both | SMS ve e-posta |
ReturnStatus
İade durumu.
| Değer | Açıklama |
|---|---|
NoAction | İşlem yok |
Pending | Beklemede |
Approved | Onaylandı |
Rejected | Reddedildi |
ReturnApprovalStatus
İade onay durumu.
| Değer | Açıklama |
|---|---|
None | Onay gerektirmez |
PendingApproval | Onay bekliyor |
Approved | Onaylandı |
MerchantVposStatus
Üye işyeri VPOS durumu.
| Değer | Açıklama |
|---|---|
WaitingForApproval | Onay bekliyor |
ReadyToPay | Ödemeye hazır |
RejectedByIKS | IKS tarafından reddedildi |
Ortak Modeller
BankTransactionDetail
Banka işlem detayları. Provision, Reverse ve Return yanıtlarında kullanılır.
{
"bankRrnNo": "012345678901",
"bankTansId": "TXN123",
"bankAuthCode": "AUTH01",
"bankReturnCode": "00"
}| Alan | Tip | Açıklama |
|---|---|---|
bankRrnNo | string | null | Banka referans numarası (RRN) |
bankTansId | string | null | Banka işlem ID'si |
bankAuthCode | string | null | Banka onay kodu |
bankReturnCode | string | null | Banka dönüş kodu |
ProvisionModel
Provizyon detayı. İşlem sorgulama yanıtında provisionList içinde kullanılır.
{
"amount": 250.00,
"transactionStatus": "Success",
"transactionType": "Auth",
"transactionDate": "2026-01-15T14:30:00"
}| Alan | Tip | Açıklama |
|---|---|---|
amount | number | Provizyon tutarı |
transactionStatus | TransactionStatus | İşlem durumu |
transactionType | TransactionType | İşlem tipi |
transactionDate | string | null | İşlem tarihi |
FilterMerchantDto
Üye işyeri bilgileri. Link Provizyon yanıtında kullanılır.
| Alan | Tip | Açıklama |
|---|---|---|
id | string (UUID) | Üye işyeri ID'si |
name | string | null | Üye işyeri adı |
number | string | null | Üye işyeri numarası |
tradeRegistrationNumber | string | null | Ticaret sicil numarası |
taxAdministration | string | null | Vergi dairesi |
TransactionReferenceStatusResponse
İşlem referans durumu. SoftPOS sorgulama yanıtında kullanılır.
| Alan | Tip | Açıklama |
|---|---|---|
isRefunded | boolean | null | İade edildi mi |
isVoided | boolean | null | İptal edildi mi |
orderId | string | null | Sipariş numarası |
amount | number | İşlem tutarı |
transactionDateISO | string (date-time) | İşlem tarihi (ISO format) |