Create a refund (reversal)
Create a reversal (refund) for a succeeded payment.
Authorization
apiKey Merchant API key. Publishable keys (pk_test_* / pk_live_) are safe for browser/frontend use and carry a limited scope set (sessions, payment_instruments, customers, orders writes; products, product_prices, payment_links reads). Secret keys (sk_test_ / sk_live_*) grant full admin access and must only be used server-side.
In: header
Path Parameters
1 <= lengthRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://loading/v1/api/payment/string/reversals" \ -H "Content-Type: application/json" \ -d '{ "refund_amount": 5000, "tags": { "reason": "customer_request" } }'{
"success": true,
"timestamp": "2026-02-06T12:00:00.000Z",
"message": "Refund created successfully",
"data": {
"id": "TRxxxxxxxxxxxxxxxxxx",
"type": "REVERSAL",
"amount": 5000,
"state": "PENDING",
"tags": {
"reason": "customer_request"
},
"created_at": "2026-02-06T12:00:00.000Z"
}
}{
"success": false,
"timestamp": "2019-08-24T14:15:22Z",
"error": {
"code": "string",
"message": "string",
"details": null
}
}{
"success": false,
"timestamp": "2019-08-24T14:15:22Z",
"error": {
"code": "string",
"message": "string",
"details": null
}
}{
"success": false,
"timestamp": "2019-08-24T14:15:22Z",
"error": {
"code": "string",
"message": "string",
"details": null
}
}{
"success": false,
"timestamp": "2019-08-24T14:15:22Z",
"error": {
"code": "string",
"message": "string",
"details": null
}
}{
"success": false,
"timestamp": "2019-08-24T14:15:22Z",
"error": {
"code": "string",
"message": "string",
"details": null
}
}Create a payment (customer charge)
Charge a customer's payment instrument. Body mirrors Finix's POST /transfers payload. The merchant defaults to the API-key/JWT context but can be overridden for sub-merchant routing.
Get a payment by ID
Retrieve a payment by its ID. `expand` accepts comma-separated keys: merchant, merchant_identity, instrument, parent. `scope=company` widens scoping from the auth context's primary merchant to all the company's merchants.