Ana içeriğe geç

Detaylı Ödeme Sorgulama

Ödeme sorgulamak için kullanılan endpoint ve http metod bilgisi aşağıda verilmiştir.

URL

GET/payment-reporting/v1/payments/:id

İstek Parametreleri

Ödeme sorgulama sadece ödeme id değeri kullanılarak yapılabilir.

id
number
zorunlu

Sorgulanmak istenen ödeme ID değeri

Dönüş Parametreleri

Ödeme işleminin sonucunda dönen parametreler de API dokümantasyonu giriş sayfasındaki Dönüş Formatları bölümünde belirtilen kurallara tabidir. Dönen cevaptaki obje yapısı aşağıda belirtilmiştir:

id
number

Ödemenin ID'si

createdDate
date

Ödemenin gerçekleştirildiği tarih

price
decimal

Ödemenin toplam sepet tutarı

paidPrice
decimal

Müşterinin ödediği toplam tahsilat tutarı. Tamamı ya da bir kısmı cüzdandan tahsil edilen ödemelerde cüzdandan tahsil edilecek tutar da bu tutara dahildir

walletPrice
decimal

Cüzdandan tahsil edilen tutar

currency
string

Ödemeye ilişkin para birimi. bkz: Para Birimleri

Değerler:
TRY
USD
EUR
GBP
CNY
ARS
BRL
AED
IQD
AZN
KZT
buyerMemberId
number

Alıcı üyeyle ilişkilendirilmiş ödemelerde yer alan, ilgili üyenin ID'sini belirten değer

installment
number

Ödemenin taksit sayısı.

conversationId
string

Üye işyeri tarafından ödeme isteği içerisinde gönderilen conversationId değeri

externalId
string

Üye işyeri tarafından ödeme isteği içerisinde gönderilen externalId değeri

paymentType
PaymentType
Değerler:
CARD_PAYMENT
DEPOSIT_PAYMENT
WALLET_PAYMENT
CARD_AND_WALLET_PAYMENT
BANK_TRANSFER
APM
paymentGroup
PaymentGroup
Değerler:
PRODUCT
LISTING_OR_SUBSCRIPTION
paymentSource
PaymentSource
Değerler:
API
CHECKOUT_FORM
PAY_BY_LINK
paymentStatus
PaymentStatus
Değerler:
FAILURE
SUCCESS
INIT_THREEDS
CALLBACK_THREEDS
WAITING
paymentPhase
PaymentPhase
Değerler:
AUTH
PRE_AUTH
POST_AUTH
paymentChannel
string

Üye işyeri tarafından ödeme isteği içerisinde gönderilen paymentChannel değeri

isThreeDS
boolean

Ödemenin 3D Secure ile gerçekleştirilip gerçekleştirilmediği

merchantCommissionRate
decimal

Son kullanıcıya yansıtılan vade farkı oranı

merchantCommissionRateAmount
decimal

Son kullanıcıya yansıtılan vade farkı tutarı. paidPrice ile price arasındaki farka eşittir

bankCommissionRate
string

Banka komisyon oranı

bankCommissionRateAmount
string

Banka komisyon tutarı

paidWithStoredCard
boolean

Ödemenin saklı kartla gerçekleştirilip gerçekleştirilmediğini belirtir

binNumber
string

Tamamı ya da bir kısmı karttan tahsil edilen ödemelerde yer alır. Kartın ilk 8 hanesini belirtir.

lastFourDigits
string

Tamamı ya da bir kısmı karttan tahsil edilen ödemelerde yer alır. Kartın son 4 hanesini belirtir

authCode
string

Ödemeye ilişkin banka tarafından verilen authCode değeri

hostReference
string

Ödemeye ilişkin banka tarafından verilen hostReference değeri

transId
string

Ödemeye ilişkin banka tarafından verilen transId değeri

orderId
string

Ödemeye ilişkin banka tarafından verilen orderId değeri

cardType
CardType

(bkz: Kart Tipleri) Tamamı ya da bir kısmı karttan tahsil edilen ödemelerde yer alır. Kartın tipini ifade eder

Değerler:
CREDIT_CARD
DEBIT_CARD
PREPAID_CARD
cardAssociation
CardAssociation

Tamamı ya da bir kısmı karttan tahsil edilen ödemelerde yer alır. Kartı sağlayan kart kuruluşunu ifade eder

Değerler:
VISA
MASTER_CARD
AMEX
TROY
JCB
UNION_PAY
MAESTRO
DISCOVER
DINERS_CLUB
cardBrand
string

Tamamı ya da bir kısmı karttan tahsil edilen ödemelerde yer alır. Kart ailesini ifade eder

cardHolderName
string

Kart sahibinin adı/soyadı

bankCardHolderName
string

Bankada kayıtlı olan kart sahibi adı/soyadı

cardIssuerBankName
string

Kartın ait olduğu banka

mdStatus
string

Ödemeye ait bankadan dönülen durum

retryCount
string

Ödeme alınırken yapılan farklı deneme sayısı

refundablePrice
string

İade edilebilecek tutar bilgisi

refundStatus
PaymentRefundStatus

Ödeme iade edilme durum bilgisi bkz: İade Edilme Durumları

Değerler:
NO_REFUND
NOT_REFUNDED
PARTIAL_REFUNDED
FULLY_REFUNDED
buyerMember
MemberResponse

Ödemede alıcı bilgisi gönderildiyse, alıcıya ait detay

pos
MerchantPos

Ödemenin alındığı pos bilgileri

loyalty
Loyalty

Ödemede kullanılmış olan ödül bilgileri

paymentError
PaymentError

Ödeme aşamasında herhangi bir hata oluşursa hataya ait detayları içerir

refunds
ReportingPaymentRefundResponse[]

Ödemeye ait iade bilgileri varsa, iadelere ait detay bilgileri içerir

Örnek Kodlar

Açık kaynak kodlu Craftgate API client'larındaki örnek kodları inceleyebilirsiniz.

Loading..