Search Transaction Refunds
URL
The endpoint and http method information to search refund transactions are stated below.
Request Parameters
Refund transactions search can be done using the following parameters.
ID of refund item to search
ID of payment
ID of payment transaction
ID of buyer member associated with the payment
conversationId value that sent in payment refund request by merchant
Returns SUCCESS for successful refunds; FAILURE for failed refunds See: Refund Status
The currency that collection is done in. See: Currencies
Whether the refund is after the payout
Minimum amount of refund
Maximum amount of refund
Minimum date of refund
Maximum date of refund
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 refund item
Date and time that refund is done
Returns SUCCESS for successful refunds; FAILURE for failed refunds
If refund destination is card or payment provider, this value returns as PROVIDER. If refund destination is wallet, this value returns as WALLET. See: Refund Type
Refunded amount for payment item
Refunded bank amount for payment item
Refunded wallet amount for payment item
conversationId value that sent in payment refund request by merchant
authCode value of the payment transaction related to the refund
hostReference value of the payment transaction related to the refund
transId value of the payment transaction related to the refund
Whether the refund is after the payou
See: Payment Types
Error detail info, returns if the refund is failed. See: Payment Error Groups
ID of payment transaction for the refund
Sample Codes
You can review the sample codes in the open source Craftgate API clients.