Skip to main content
POST
/
refund-chargeback
/
refund
/
merchant
/
api
/
refund
Initiate Refund
curl --request POST \
  --url https://api.payaza.africa/live/refund-chargeback/refund/merchant/api/refund \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "transaction_reference": "APRQWE1001",
  "refund_amount": 0.05,
  "refund_reason": "Refund"
}
'
{
  "message": "Operation Completed",
  "data": {
    "message": "Refund Processed Successfully",
    "refund_transaction_reference": "RF20230228-LDUUSD",
    "payment_transaction_reference": "APRQWE1001",
    "status": "SUCCESS",
    "original_transaction_amount": 0.05,
    "refunded_amount": 0.05,
    "successful": true
  }
}

Authorizations

​
Authorization
string
header
required

Payaza {{Public API Key in Base 64}}

Body

application/json
​
transaction_reference
string
required

Unique reference of the original transaction to be refunded.

Example:

"APRQWE1001"

​
refund_amount
number<double>
required

Amount to be refunded.

Example:

0.05

​
refund_reason
string | null

Reason for the refund.

Example:

"Refund"

Response

Initiate Refund Response

​
message
string

General status message.

Example:

"Operation Completed"

​
data
object