Refund transaction
User can refund any existing transaction after being settled. It can only be performed on transactions, which have been authorised and settled. Authenticate this request using HTTP Basic Auth by adding a bearer token to the header, e.g. Authentication: Bearer {{access_token}}. You can get the {{access_token}} from the create token request.'''
Path Parameters
- transaction_id string required
The id of the transaction
- application/json
Request Body
- partial_refund boolean required
Default value:
false
If the transaction is a partial refund, then it set to be true. Default value is false.
- amount number
Amount is required if it’s a partial refund. The amount must not be greater than the original received amount minus any already refunded amount.
- reference string
Amount is required if it’s a partial refund. The amount must not be greater than the original received amount minus any already refunded amount.
- 200
Response Headers
- application/json
- Schema
- Example (from schema)
- Example
Schema
- success boolean
- message string
- amount number
- reference string
- transaction_id string
{
"success": true,
"message": "string",
"amount": 0,
"reference": "string",
"transaction_id": "string"
}
{
"success": true,
"message": "Refunded successfully",
"amount": 1.01,
"reference": "refund note",
"transaction_id": "BL-2349AGB"
}