The endpoint and http method information to search payment refund are stated below.
| HTTP Method | URL |
|---|---|
GET |
/payment-reporting/v1/refunds |
Payment refund search can be done using the following parameters.
| Parameter Name | Type | Required | Description |
|---|---|---|---|
id |
number |
No | ID of refund |
paymentId |
number |
No | ID of payment |
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 |
minPaidPrice |
decimal |
No | Minimum amount of refund |
maxPaidPrice |
decimal |
No | Maximum amount of refund |
minCreatedDate |
date |
No | Minimum date that refund is created to search |
maxCreatedDate |
date |
No | Maximum date that refund is created to search |
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 |
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. |
refundPrice |
decimal |
Refunded amount |
refundBankPrice |
decimal |
Refunded bank amount |
refundWalletPrice |
decimal |
Refunded wallet amount |
conversationId |
string |
conversationId value that sent in payment refund request by merchant |
authCode |
string |
authCode value of the payment related to the refund |
hostReference |
string |
hostReference value of the payment related to the refund |
transId |
string |
transId value of the payment related to the refund |
paymentType |
PaymentType |
See: Payment Types |
error |
PaymentError |
Error detail info, returns if the refund is failed. See: Payment Error Groups |
paymentId |
number |
ID of payment for the refund |
You can review the sample codes in the open source Craftgate API clients.