Skip to main content
POST
Settle a payment request by card-provider reference
Settles a payment request you identify by its card-provider reference instead of its ID: the account comes from paymentRequestReference.cardProviderReference (type + referenceId) and the request from its externalId. Behavior and response — including the { "fiat": <number>, "crypto": "<string>" } amount objects — match settling by ID. Send a unique idempotencyKey; repeating the same key and body returns the original result. Concept guide: Payment requests

Authorizations

Body

application/json

Settles a payment request identified by its card-provider reference.

paymentRequestReference
object
required

Identifies a payment request by the card-provider reference of its account plus the request's externalId — used by the "by reference" settle/reverse endpoints.

amount
number
required

Final settlement amount, in the authorized fiat currency

currency
string
required

Must match the authorized currency

Minimum string length: 1
idempotencyKey
string
required

Unique key to prevent duplicate operations on retry

Minimum string length: 1

Response

Settlement accepted; on-chain processing is asynchronous

success
boolean

Indicates whether the request was successful

result
object