🔁 Initiate Refund

Use this endpoint to initiate a refund for a specific order.

💡 Good to Know

You must include your secret API key in the request header using api-key.
Refunds can be full or partial depending on whether the amount is specified.

📮 Endpoint

POST https://payment-api-service.transactpay.ai/payment/order/refund

🔐 Headers

Header	Type	Required	Description
`api-key`	string	✅ Yes	Your Transactpay secret API key
`Content-Type`	string	✅ Yes	Must be `application/json`

📦 Sample Request Payload

{
  "reference": "{{orderreference}}",
  "reason": "Customer requested a refund",
  "amount": "5000"
}

🧾 Request Body Parameters

Key	Type	Required	Description
`reference`	string	✅ Yes	Unique identifier for the original order
`reason`	string	❌ No	Reason for the refund (optional, but recommended)
`amount`	string	❌ No	Refund amount. If omitted, the full order amount is refunded automatically.

⚠️
Important Notes

Omitting the amount will result in a full refund.

To process a partial refund, simply specify the amount.

📤 Sample cURL Request

curl -X POST https://payment-api-service.transactpay.ai/payment/order/refund \
  -H "api-key: YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "reference": "ORD-12345",
    "reason": "Product not received",
    "amount": "2500"
}'

✅ Sample Success Response

{
  "status": true,
  "message": "Refund has been initiated",
  "data": {
    "reference": "ORD-12345",
    "amount_refunded": "2500",
    "status": "pending"
  }
}

🕓
Note
Refunds may take a short time to complete depending on the payment method used.

{
    "reference": "{{orderreference}}",
    "Reason": "",
    "Amount": ""
}