Skip to main content
POST
/
v2
/
account
/
beneficiaries
/
bank-accounts
/
usd
Create USD bank-account beneficiary
curl --request POST \
  --url https://api.example.com/v2/account/beneficiaries/bank-accounts/usd/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "alias": "<string>",
  "bankAccountNumber": "<string>",
  "bankRoutingNumber": "<string>",
  "bankBeneficiaryName": "<string>",
  "bankName": "<string>",
  "description": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

subAccountId
string<uuid>

Operate against a sub-account of the authenticated main account.

Body

application/json

Passthrough body. Note the platform service uses JSON tag bankBeneficiaryName for the beneficiary name field — the V2-facing schema mirrors that exactly.

alias
string
required
bankAccountNumber
string
required
bankRoutingNumber
string
required
bankBeneficiaryName
string
required
bankName
string
required
description
string
beneficiaryAddress
object
bankAddress
object

Response

OK

id
string<uuid>