Skip to main content
POST
Create recipient
Body is a common section + a type-specific section keyed on transferType. Call GET /recipients/requirements first for the live field list.
Scope recipients:write · rate-limited

Headers

string
required
API key.
string
Optional. Up to 255 url-safe characters (≥8). Replays the cached response within 24 hours; mismatched bodies on the same key return 409 IDEMPOTENCY_KEY_REUSED.

Request body

Common

string
required
string
required
ISO 3166-1 alpha-2.
string
"business" (default) or "individual".
string
Required when isBusiness="business".
string
Required when isBusiness="individual".
string
Required when isBusiness="individual".
string
E.164.
object
object
Map of stringstring. Echoed back on reads.

Type-specific

string
required
"fiat"
object[]
required
One entry per (currency, rail). Send only fields the chosen rail needs.

Response

string
UUID.
string
boolean
string
string
string
string
ISO 3166-1 alpha-2.
string
Inferred from country when omitted.
string
object
string
"fiat" or "stablecoin".
object
Chain ID → address, when transferType is "stablecoin".
object
Map of stringstring.
string
"pending", "accepted", or "rejected".
string
ISO 8601.
string
ISO 8601.