Skip to main content
POST
/
payment
/
intents
/
{paymentIntentId}
/
refunds
Create a refund
curl --request POST \
  --url https://api.orqex.com/v1/payment/intents/{paymentIntentId}/refunds \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 2,
  "reason": "<string>",
  "metadata": {}
}
'
{
  "message": "<string>",
  "data": {
    "id": "re_abc123",
    "amount": {
      "value": 5000,
      "formatted": "50.00 XOF",
      "short": "50 XOF",
      "currency": "XOF"
    },
    "reason": "<string>",
    "failure_code": "<string>",
    "failure_message": "<string>",
    "metadata": {},
    "completed_at": "<string>",
    "failed_at": "<string>",
    "created_at": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Project secret key, e.g. sk_live_..., sent as Authorization: Bearer sk_....

Headers

​
X-Idempotency-Key
string

Safely retry a write without duplicating it. 8-128 chars.

Required string length: 8 - 128

Path Parameters

​
paymentIntentId
string
required

Public payment intent id, e.g. TRX....

Body

application/json
​
amount
integer
required

Amount to refund, in minor units (e.g. 5000 for 50.00). Minimum 1.

Required range: x >= 1
​
reason
string

Optional reason for the refund, stored for your records.

Maximum string length: 500
​
metadata
object

Up to 10 arbitrary key/value pairs, stored on the refund.

Response

Created

​
message
string
​
data
object