The endpoint and http method information to search refund transactions are stated below.
| HTTP Method | URL |
|---|---|
GET |
/payment-reporting/v1/refund-transactions |
Refund transactions search can be done using the following parameters.
| Parameter Name | Type | Required | Description |
|---|---|---|---|
id |
number |
No | ID of refund item to search |
paymentId |
number |
No | ID of payment |
paymentTransactionId |
number |
No | ID of payment transaction |
buyerMemberId |
number |
No | ID of buyer member associated with the payment |
conversationId |
string |
No | conversationId value that sent in payment refund request by merchant |
status |
Status |
No | Returns SUCCESS for successful refunds; FAILURE for failed refunds See: Refund Status |
currency |
Currency |
No | The currency that collection is done in. See: Currencies |
isAfterSettlement |
boolean |
No | Whether the refund is after the payout |
minPaidPrice |
decimal |
No | Minimum amount of refund |
maxPaidPrice |
decimal |
No | Maximum amount of refund |
minCreatedDate |
date |
No | Minimum date of refund |
maxCreatedDate |
date |
No | Maximum date of refund |
page |
number |
No | Page number for pagination |
size |
number |
No | Page size for pagination |
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:
| Parameter Name | Type | Description |
|---|---|---|
id |
number |
ID of refund item |
createdDate |
date |
Date and time that refund is done |
status |
RefundStatus |
Returns SUCCESS for successful refunds; FAILURE for failed refunds |
refundDestinationType |
string |
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 |
refundPrice |
decimal |
Refunded amount for payment item |
refundBankPrice |
decimal |
Refunded bank amount for payment item |
refundWalletPrice |
decimal |
Refunded wallet amount for payment item |
conversationId |
string |
conversationId value that sent in payment refund request by merchant |
authCode |
string |
authCode value of the payment transaction related to the refund |
hostReference |
string |
hostReference value of the payment transaction related to the refund |
transId |
string |
transId value of the payment transaction related to the refund |
isAfterSettlement |
boolean |
Whether the refund is after the payou |
paymentType |
PaymentType |
See: Payment Types |
error |
PaymentError |
Error detail info, returns if the refund is failed. See: Payment Error Groups |
paymentTransactionId |
number |
ID of payment transaction for the refund |
You can review the sample codes in the open source Craftgate API clients.