Skip to main content
POST
Settle a payment request
Settles a reserved payment request. The call returns 202 Accepted with status: SETTLING and its executions PENDING; the request becomes SETTLED once those transfers confirm on-chain. amount is the final figure in the authorized currency, and the executions that run follow from how it compares to the authorized amount: Send a unique idempotencyKey; repeating the same key and body returns the original result. Concept guide: Payment requests
amount, settlementAmount, and settledAmount come back as objects — { "fiat": <number>, "crypto": "<string>" }. To settle a request by its card-provider reference instead of its ID, use settle by reference.

Authorizations

Path Parameters

paymentRequestId
string<uuid>
required

Unique payment request identifier

Body

application/json
amount
number
required

Final settlement amount, in the authorized fiat currency

currency
string
required

Must match the authorized currency

Maximum string length: 10
idempotencyKey
string
required

Unique key to prevent duplicate operations on retry

Maximum string length: 255

Response

Settlement accepted; on-chain processing is asynchronous

success
boolean

Indicates whether the request was successful

result
object