The endpoint and http method information to refund a payment transaction are stated below.
| HTTP Method | URL |
|---|---|
POST |
/payment/v1/refund-transactions |
The parameters expected to be sent in the requests to be made to refund are listed under the table and sub-headings below.
| Parameter Name | Type | Required | Description |
|---|---|---|---|
paymentTransactionId |
number |
Yes | ID of the payment transaction that that requested to be refunded |
conversationId |
string |
No | "boomerang" value that can be sent with the request and received with the response. It can be used to associate different requests with each other. Usually, the order number is used that is stored in merchant own system. |
refundPrice |
number |
No | Refund price |
refundDestinationType |
RefundDestinationType |
No | See: Refund Type |
chargeFromMe |
boolean |
No | Should the refund is charged by using merchant's balance? Can be used in case of insufficient sub-merchant balance in marketplace payment |
| Parameter Name | Type | Description |
|---|---|---|
id |
number |
ID of the transaction refund |
conversationId |
string |
Value of theconversationId parameter sent in the payment initiation request |
createdDate |
date |
The date that the payment transaction is refunded |
status |
string |
See: Refund Status Type |
isAfterSettlement |
boolean |
Returns true if payment transaction is refunded after settlement |
refundPrice |
decimal |
Price of the transaction refund |
refundBankPrice |
decimal |
Bank price of the transaction refund |
refundWalletPrice |
decimal |
Wallet price of the transaction refund |
refundDestinationType |
RefundDestinationType |
See: Refund Type |
authCode |
string |
authCode value retrieved from bank for the transaction refund |
hostReference |
string |
hostReference value retrieved from bank for the transaction refund |
transId |
string |
transId value retrieved from bank for the transaction refund |
currency |
Currency |
Currency of the transaction refund. See: Currencies |
paymentTransactionId |
number |
ID of the payment transaction to be refunded |
paymentId |
number |
ID of the payment to be refunded |
You can review the sample codes in the open source Craftgate API clients.