Skip to main content
POST
Poll a bank payout
Provider sandbox on this deployment. Our backend targets the bank provider’s sandbox: bank details are test details, no real transfer settles, and settlement lands on a testnet (read network from GET /v1/config). Known limits: only the EUR/IBAN rail is wired for the simulated pay-in, and identity checks run on test-mode applicants. Every response says which environment answered in its environment field.
Currently being connected, docs updating. This endpoint answers mock: true: ids, shapes and statuses are real and deterministic from your input, every money figure is the placeholder 1234567.89, and nothing is sent to a provider. Integrate against the shape; do not compute anything from the figures.

Authorizations

Authorization
string
header
required

Your API key, issued by us and shown once at creation.

Body

application/json
id
string
required

The payout id from the create call.

Minimum string length: 1
Example:

"bpo_77c2e1f4309a6d5b"

Response

The payout state.

environment
enum<string>
required

Which environment answered. sandbox: at least one money upstream is the provider's sandbox - no real money moves there, and the card corridor is the sandbox's asset (read GET /v1/config), not the documented production one. production: every configured upstream is real. Derived from the configured upstream hosts at boot, never a flag.

Available options:
sandbox,
production
Example:

"sandbox"

mock
boolean
required

Always true on this endpoint: the provider behind it is currently being connected, docs updating. Ids, shapes and statuses are real and deterministic from your input; every money figure is the placeholder 1234567.89; nothing is sent to a provider. The field disappears the day the provider is wired, so branch on its presence, not its value.

Example:

true

id
string
required

The payout id, echoed back.

status
enum<string>
required

pending: created, waiting for the user's stablecoin at the deposit address. converting: the stablecoin landed and is being converted. sent: left the provider, NOT arrived. settled: reached the card or bank account - the one state to tell the user about. rejected: the provider refused it. returned: sent and came back. While the payout providers are being connected every payout answers pending.

Available options:
pending,
converting,
sent,
settled,
rejected,
returned
Example:

"pending"

updatedAt
string
required

ISO 8601 of the last change.

Example:

"2026-09-08T18:02:19.000Z"

reason
string

Present on rejected and returned: why, in the provider's words.