Create Refund Transaction

URL

The endpoint and http method information used to refund wallet transaction are stated below.

HTTP Method URL
POST /payment/v1/wallet-transactions/:walletTransactionId/refunds

Request Parameters

The expected parameters to be sent in requests to refund wallet transaction are listed under the table and subheadings below.

Parameter Name Type Mandatory Description
refundPrice decimal Yes Amount to be refunded

Response Parameters

Parameters returned as a result of refund wallet transaction are also subject to the rules specified in the Response Formats section of the API documentation home page. In the absence of a systematic or fictional error, the sub-parameters of the object returned in the data parameter are as follows:

Parameter Name Type Description
id number ID of the wallet refund transaction
createdDate date The date that the refund is created
refundStatus Status The refund status. See: Refund Status
refundPrice decimal The amount that refunded
authCode string authCode value retrieved from bank for the payment
hostReference string hostReference value retrieved from bank for the payment
transId string transId value retrieved from bank for the payment
transactionId number ID value of the transaction that refund to the wallet then refunded back from member's wallet
transactionType string Type of the transaction that refund to the wallet then refunded back from member's wallet PAYMENT: Payment Refund, PAYMENT_TX: Refund of Payment Transaction, WALLET_TX: Refund of Wallet Transaction
paymentError PaymentError Error that occurred while refund of wallet transaction see: Payment Error Info
walletTransactionId number ID of the wallet transaction that refunded

Sample Codes

You can review the sample codes in the open source Craftgate API clients.