Skip to main content
POST
Create recipient

Authorizations

Authorization
string
header
required

Client API Key or Client Session Token (CST). Pass as a Bearer token in the Authorization header.

Headers

Idempotency-Key
string

Optional key to deduplicate retries.

Body

application/json
name
string
required
details
object
required

Recipient details. For onchain recipients, schema and address are defaulted from chainId when omitted; provide them explicitly for an external wallet. For fiat beneficiaries, include the bank schema and account fields.

chainId
string

CAIP-2 chain id used to default an onchain recipient's schema and address.

isExternal
boolean

Set true for external wallets and fiat beneficiaries; disables Portal-wallet defaulting.

Response

Recipient created

data
object