Refund Transaction

Refund a previously successful transaction.

Endpoint Information

Name: Payment Transaction Refund
Method: POST
URL: {{BASE_URL}}/api/v1/payment-transaction/refund

Description

Initiate a full or partial refund for a transaction. Note that not all payment solutions support refunds via API.

Authentication

Type: Basic Auth

• Username: App Key
• Password: Secret Key

Request Body

Content-Type: application/json

{
  "reference": "w27Wd5JaIl",
  "amount": "151",
  "merchantAccountId": "100012"
}

Parameters

Parameter	Type	Required	Description
reference	string	Yes	The reference of the original transaction to refund
amount	number	Yes	The amount to refund
merchantAccountId	string	Yes	Your merchant account ID

Response

Success Response

{
  "success": true,
  "message": "Refund request success.",
  "data": {
    "processor_reference": "5047869357",
    "processor_reference_time": "2025-07-11 09:54:59",
    "processor_status": "Refunded",
    "status": "Refunded",
    "amount": "120"
  }
}

Failed Response

{
  "success": false,
  "message": "Refund not allowed for this solution.",
  "errors": [
    "Refund not allowed for this solution."
  ]
}

Response Fields

Field	Type	Description
success	boolean	Refund success status
message	string	Response message
data.status	string	New status of the transaction (e.g., "Refunded")
data.amount	string	Refunded amount

Usage

Use this endpoint to refund customers. Ensure the original transaction reference is correct.

Related Endpoints

• Transaction List - Find transaction references