Search Refunds
URL
The endpoint and http method information to search payment refund are stated below.
Request Parameters
Payment refund search can be done using the following parameters.
ID of refund
ID of payment
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
Minimum amount of refund
Maximum amount of refund
Minimum date that refund is created to search
Maximum date that refund is created to search
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
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.
Refunded amount
Refunded bank amount
Refunded wallet amount
conversationId value that sent in payment refund request by merchant
authCode value of the payment related to the refund
hostReference value of the payment related to the refund
transId value of the payment related to the refund
See: Payment Types
Error detail info, returns if the refund is failed. See: Payment Error Groups
ID of payment for the refund
Sample Codes
You can review the sample codes in the open source Craftgate API clients.