Skip to main content
Refund a completed payment in full or in part. Refunds are nested under the payment intent.

​
Create a refund

curl https://api.orqex.com/v1/payment/intents/TRX123/refunds \
  -H "Authorization: Bearer sk_live_xxx" \
  -H "Content-Type: application/json" \
  -H "X-Idempotency-Key: refund-1024" \
  -d '{
    "amount": 5000,
    "reason": "Customer request"
  }'

​
Request body

​
amount
integer
required
Amount to refund, in minor units (e.g. 5000 for 50.00). Minimum 1.
​
reason
string
Optional reason, stored for your records.
​
metadata
object
Up to 10 arbitrary key/value pairs.

​
Response

​
id
string
Public refund id (e.g. re_...).
​
type
string
full or partial.
​
status
string
pending, processing, completed or failed.
A completed partial refund moves the payment to partially_refunded; a full refund to refunded.

​
List & retrieve

curl https://api.orqex.com/v1/payment/intents/TRX123/refunds \
  -H "Authorization: Bearer sk_live_xxx"