Create a new beneficiary
Create a new beneficiary with their account details for payouts. Idempotent: if any submitted account (IBAN or NGN crAccount+bankCode) matches an existing active beneficiary for this client, the existing beneficiary is returned unchanged instead of creating a duplicate.
Authorizations
Enter Auth0 JWT token
Headers
Optional. Names an owned sub-account (UUID) to act on. Omit to act at the master (tenant) level. Naming an account this key does not own returns 403 not_account_owner.
Body
Array of payment accounts for this beneficiary
Country code (ISO 3166-1 alpha-2, e.g., "DE", "GB", "US")
2"DE"
Full name of the beneficiary (2-100 characters)
2 - 100"John Doe"
Address line 1 of the beneficiary (max 200 characters)
200"Hauptstraße 123"
Address line 2 of the beneficiary (max 200 characters)
200"Apt 4B, 3rd Floor"
City of the beneficiary. May be required depending on corridor; use GET /v1/payouts/requirements to check.
100"Berlin"
Country subdivision code (e.g., US state code "NY", "CA")
50"NY"
Date of birth in YYYY-MM-DD format (individual beneficiaries only). Optional here; when Travel Rule screening is enabled, POST /v1/payouts rejects a crypto payout to an individual beneficiary that has none.
"1985-05-20"
Email address of the beneficiary
"john.doe@example.com"
UUID of an existing beneficiary. If provided, other fields are ignored and the existing beneficiary is referenced.
"cc82fa1d-fc7a-478c-a734-d3bce40464e7"
Middle name of the beneficiary (max 100 characters)
100"James"
Optional notes about the beneficiary (max 500 characters)
500"Regular client, prefers SEPA Instant"
Postal code of the beneficiary
20"10115"
Beneficiary type. Defaults to "individual" if not provided.
individual, business "individual"
Response
Beneficiary created successfully
Array of associated payment accounts
Country code (ISO 3166-1 alpha-2)
"DE"
ISO timestamp when the beneficiary was created
"2024-01-15T10:30:00Z"
Unique identifier for the beneficiary
"123e4567-e89b-12d3-a456-426614174000"
Full name of the beneficiary
"John Doe"
Beneficiary status
active, inactive, suspended "active"
Beneficiary type
individual, business "individual"
ISO timestamp when the beneficiary was last updated
"2024-01-15T10:30:00Z"
The sub-account this beneficiary belongs to. Absent on the workspace’s own. A headerless list is a rollup over both, so this is what tells them apart.
Address line 1 of the beneficiary
"Hauptstraße 123"
Address line 2 of the beneficiary
"Apt 4B, 3rd Floor"
City of the beneficiary
"Berlin"
Country subdivision code (e.g., US state code "NY", "CA")
"NY"
Date of birth in YYYY-MM-DD format (individual beneficiaries only).
"1985-05-20"
Email address of the beneficiary
"john.doe@example.com"
Middle name of the beneficiary
"James"
Notes about the beneficiary
"Regular client, prefers SEPA Instant"
Postal code of the beneficiary
"10115"