Search Payments
All successful or unsuccessful payments in the past can be queried using the Craftgate API.
URL
The endpoint and http method information to query payment are stated below.
Request Parameters
Payment query can be done using the following parameters.
ID of payment
ID of payment transactions
Buyer member ID related to the payment
ID value of related sub-merchant
conversationId value that sent in payment request by merchant
externalId value that sent in payment request by merchant
ID of merchant POS that payment is recieved
orderId value retrieved from bank related to the payment
See: Payment Types
See: Payment Status
paymentChannel value sent by the merchant in the payment request
First 8 digits of card that payment is done
Last 4 digits of card that payment is done
Payment currency See: Currencies
Minimum paid price collected in payment
Maximum paid price collected in payment
Installment number of payment
Whether the payment is 3D Secure payment
Minimum payment create date to filter payments
Maximum payment create date to filter payments
Page number for pagination
Page size for pagination
Response Parameters
The parameters returned as a result of the payment are also subject to the rules specified in the Response Formats section of the API documentation home page. The object structure in the response is as follows:
ID of the payment
The date that payment created
Total amount of the payment
Total amount paid by the buyer. The amount also included in collected from wallet for payments that fully or partially collected from the wallet. Müşterinin ödediği toplam tahsilat tutarı.
The amount collected from wallet
Payment currency See: Currencies
Buyer member ID related to the payment
Installment number of the payment
conversationId value that sent in payment request by merchant
externalId value that sent in payment request by merchant
See: Payment Types
See: Payment Status
paymentChannel value sent by the merchant in the payment request
Indicates whether the payment is 3D Secure payment
Interest rate to calculate paid price that buyer will pay
Interest amount. Equal to the difference between paidPrice and price values
Bank commission rate
Bank commission rate amount
Indicates whether the payment was made with a stored card
Exist for the payments fully or partially collected from the card. First 8 digits of the card
Exist for the payments fully or partially collected from the card. Last 4 digits of the card
authCode value retrieved from bank related to the payment
hostReference value retrieved from bank related to the payment
transId value retrieved from bank related to the payment
orderId value retrieved from bank related to the payment
Type of the card. Exist for the payments fully or partially collected from the card (See: Card Types)
Card association. Exist for the payments fully or partially collected from the card
Brand of card. Exist for the payments fully or partially collected from the card
Card holder name surname
Card holder name surname retrieved from bank
Name of card issuer bank
Payment status retrieved from bank for 3D secure payment
Retry count while payment is done
Refundable amount
Status of refund see: Payment Refund Status
POS info that payment is received.
Loyalty info that used in payment.
Detail information of the error, if the payment received an error.
If there is refund information for the payment, it contains the detail information about the refund.
Sample Codes
You can review the sample codes in the open source Craftgate API clients.