API Reference
Client PortalAPI StatusWebsite

Create a payout.

post
https://www.bankingcircleconnect.com/api/v1/digital-assets/payouts

Idempotency-Key required. Specify either fromAmount or toAmount; server quotes the other side.

Body Params

Caller-generated unique value for retry detection.

Payout request — create body. Specify either source-side or destination-side
amount; the server quotes the other.

from
object
required

Fiat source (BC account). Only the account number is accepted; currency is derived server-side.

to
object
required

Digital-asset destination.

amount
required

Source- or destination-side amount.

string | null
^[\x20-\x7E]*$

Caller-supplied reconciliation reference. No PII.

Headers
string
required
length ≤ 100
^[A-Za-z0-9._:-]{1,100}$

Caller-generated unique value for retry detection. Retained for 10 days; duplicate within the retention window returns 409 IDEMPOTENCY_KEY_REUSED with the original resource id.

Responses

Updated 2 days ago

Did this page help you?
Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 days ago

Did this page help you?