Skip to main content
POST
Reverse a recorded out-of-band payment

Authorizations

Authorization
string
header
required

Merchant API key bearer token. Legacy wire prefixes api_key_ and api_ are also accepted.

Path Parameters

id
string
required

Invoice TypeID (inv_...) the allocation belongs to.

Example:

"inv_01hxy8m1nqk9g3x3y3p0azq2va"

allocationId
string
required

Invoice payment allocation TypeID (invpay_...) to reverse.

Example:

"invpay_01hxy8m1nqk9g3x3y3p0azq2r1"

Body

application/json

Reversal payload with merchant scope. No idempotency key: only an applied allocation can be reversed, so a replay is rejected rather than duplicated.

merchantId
string
required

Merchant TypeID (mer_...) used for authorization scope.

Response

Payment reversed. Returns the invoice with its balance reduced, plus the reversed allocation.

invoice
object
required
allocation
object
required