Skip to main content
POST
Confirm a QR payout (Bolivia, Brazil)

Authorizations

Authorization
string
header
required

Session JWT (from register/login) or API key (pk_...). X-API-Key: <token> is accepted as an alternative header.

Headers

Idempotency-Key
string

Alternative to the idempotency_key body field.

Body

application/json
provider_reference
string
required

From the scan step.

amount
string
required

Local amount as a positive decimal string.

country
enum<string>
default:BO
Available options:
BO,
BR
currency
enum<string>
default:BOB
Available options:
BOB,
USD,
BRL
description
string
settlement_asset
enum<string>

Virtual balance to debit for this operation. Accepted values are USDT, USDC, BTC, GOLD, SILVER, PLATINUM, BOB, MXN and ARS. Fiat execution currently returns 503 pricing_unavailable. Omit to use your account's default settlement asset.

Available options:
USD,
USDT,
USDC,
BTC,
GOLD,
SILVER,
PLATINUM,
BOB,
MXN,
ARS
idempotency_key
string

Response

Idempotency replay of an existing QR payout.

payout_id
string<uuid>
account_id
string<uuid>
idempotency_key
string
country
string
currency
string
method
string
local_amount
string
fx_rate
string

Your account's rate at execution time (local units per 1 USDT).

rate_source
enum<string>

Execution rate provenance. lot, blend or spot; omitted for historical rows without attribution.

Available options:
lot,
blend,
spot
usdt_amount
string
fee
string
total_debit
string
settlement_asset
enum<string>

Virtual balance the operation was actually debited from.

Available options:
USD,
USDT,
USDC,
BTC,
GOLD,
SILVER,
PLATINUM
settlement_amount
string

Exact amount debited from the settlement asset's balance (in that asset's units). Equals total_debit when the asset is USDT. If the payout fails this exact amount is refunded — never re-quoted.

settlement_rate
string

Effective USD price per unit of the settlement asset used to convert the USDT total ("1" for USDT/USDC).

beneficiary
object
description
string
status
enum<string>

pending with compliance_pending: true means technical beneficiary screening is queued before any debit or core dispatch. After screening passes, pending can use compliance_dispatch_pending, compliance_dispatching or core_unreachable while the debit remains held.

Available options:
pending,
processing,
completed,
failed
status_code
string

Normalized state detail. compliance_pending is pre-debit; compliance_dispatch_pending, compliance_dispatching and core_unreachable are durable post-screening transition codes.

status_message
string
funds_debited
boolean

False before a pending technical-screening payout is debited. True after screening passes and the debit/hold exists, including pending dispatch transitions.

predebit_failure
boolean

True when screening or a hard compliance gate ended the payout before any debit. It is distinct from a failed payout whose debit was later refunded.

compliance_pending
boolean

True only while technical screening is queued before any debit or core dispatch; false after the screening process result is accepted.

bank_reference
string

Bank/rail transaction reference (e.g. the bank's transfer id, which the beneficiary can use to cross-check the payment with their bank). On US ACH/wire/SWIFT it is the CBF reference returned immediately at create; on other corridors it stays empty until the rail reports it.

uetr
string

UETR/SWIFT gpi tracking identifier reported by the bank after execution; empty until available.

imad
string

Domestic wire/ACH tracking identifier reported by the bank after execution; empty until available.

created_at
string<date-time>
updated_at
string<date-time>
idempotency_hit
boolean

Present (true) when the response is an idempotent replay.

receipt_url
string<uri>

Present only when a receipt exists, normally after debit and a final-state transition. Omitted while the payout is pending technical screening before debit.