Skip to main content
POST
/
refunds
Create Refund
curl --request POST \
  --url https://api-sandbox.pavewaygroup.com/v1/refunds \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "transaction_id": "<string>",
  "amount": "<string>",
  "reason": "<string>",
  "notes": "<string>"
}
'
{
  "status_code": 200,
  "response_type": "success",
  "data": {
    "id": "658dc...",
    "refund_id": "rf_abc123...",
    "amount": "1000",
    "currency": "XAF",
    "status": "succeeded",
    "reason": "requested_by_customer"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.pavewaygroup.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Authentication

Include your Secret Key in the Authorization header as a Bearer token.

​
Request Body

​
transaction_id
string
required
The ID of the original successful transaction.
​
amount
string
Refund amount in smallest currency unit. If omitted, a full refund is issued.
​
reason
string
Code for the refund reason: requested_by_customer, duplicate, fraudulent, other.
​
notes
string
Additional context for the refund (up to 500 characters).

​
Response

​
id
string
Unique identifier for the transaction/refund wrapper.
​
refund_id
string
The specific ID of the refund (e.g., rf_...).
​
amount
string
The amount refunded.
​
currency
string
The currency code.
​
status
string
Status of the refund (succeeded, pending, failed).
​
reason
string
Reason for the refund.
{
  "status_code": 200,
  "response_type": "success",
  "data": {
    "id": "658dc...",
    "refund_id": "rf_abc123...",
    "amount": "1000",
    "currency": "XAF",
    "status": "succeeded",
    "reason": "requested_by_customer"
  }
}