Initiate Refund

The API allows merchants to process refunds for transactions. It enables full or partial refunds, providing flexibility in handling customer transactions.

Request Body

Field Name	Type	Required	Description
transactionReference	string	true	A unique reference identifier for the original transaction.
refundReference	string	true	A unique reference identifier for the refund transaction.
refundAmount	decimal	true	The amount to be refunded.
refundReason	string	true	The reason for initiating the refund.
customerNote	string	false	An optional note from the customer regarding the refund.
destinationAccountNumber	string	true	The account number where the refund should be credited.
destinationAccountBankCode	string	true	The bank code of the destination account.

Response Body

Field Name	Type	Description
requestSuccessful	boolean	Indicates whether the request was processed successfully.
responseMessage	string	A message indicating the status of the refund request.
responseCode	string	A code representing the outcome of the request.
transactionReference	string	The reference ID of the original transaction.
refundReference	string	The reference ID of the refund transaction.
refundAmount	decimal	The amount that is being refunded.
refundReason	string	The reason provided for initiating the refund.
customerNote	string	An optional note from the customer regarding the refund.
refundType	string	Indicates whether the refund is partial or full.
refundStatus	string	The current status of the refund request (e.g., "PENDING").
refundStrategy	string	The method used to process the refund (e.g., "MERCHANT_WALLET").
comment	string	Additional comments about the refund status.
completedOn	string	The timestamp when the refund was completed, or null if pending.
createdOn	string	The timestamp when the refund request was created.

Request

Authorization

OAuth 2.0

Client Credentials

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Token URL: {{tpGatewayHostUrl}}/security/authenticate

Body Params application/json

Example

{
  "transactionReference": "907600205586897868208896590539",
  "refundReference": "969118661",
  "refundAmount": 10,
  "refundReason": "Order cancelled!",
  "customerNote": "An optional note",
  "destinationAccountNumber": "4032350505",
  "destinationAccountBankCode": "000012"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Response

application/json

Bodyapplication/json

Example

{
  "requestSuccessful": true,
  "responseMessage": "success",
  "responseCode": "0",
  "responseBody": {
    "transactionReference": "907600205586897868208896590539",
    "refundReference": "969118661",
    "refundAmount": 10,
    "refundReason": "Order cancelled!",
    "customerNote": "An optional note",
    "refundType": "PARTIAL_REFUND",
    "refundStatus": "PENDING",
    "refundStrategy": "MERCHANT_WALLET",
    "comment": "Sample narration",
    "completedOn": null,
    "createdOn": "25/01/2024 01:35:27 AM"
  }
}

🟠400| Source | Error | When |

🟠401| Source | Error | When |

🟠403| Source | Error | When |

🟠404| Source | Error | When |

🔴500| Source | Error | When |

Request Body#

Response Body#

Request

Request Code Samples

Responses

Request Body

Response Body