Create a recipient
Save a payout destination for one of your users.
What goes inside account depends on the rail you pick with account_type. Send the same recipient twice and you get the one that already exists back, with a 202 instead of a 201.
Headers
Version applied to this request. It wins over your account's pinned version — see Versioning.
"2026-04-14"
A value you generate for this call. Retrying with the same one returns the first recipient instead of saving a second.
Reusing it with a different body is rejected with a 409.
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
Body
There is no holder_name: the holder is taken from first_name and last_name, or from company_name for a company.
The user this recipient belongs to.
Where the money should go. account_type decides which other fields belong here.
- Option 1
- Option 2
- Option 3
Whether the recipient is a person or a company. individual when you omit it.
individual, business Given name, for a person.
Middle name, for a person.
Family name, for a person.
Registered name, for a company.
Phone number.
Email address.
The recipient's own address, which is not the bank's. Required on the ACH and WIRE rails, and it has to be this object — a plain string is rejected with a 400.
Your own key/value pairs, returned unchanged. Up to 50 keys. A key is 1 to 40 characters and cannot contain [ or ]; a value is up to 500 characters.
Response
The recipient was saved.
One recipient. A name or contact field you never set is left out altogether rather than returned empty.
Recipient UUID. Send it on a payout or a quotation.
Whether the recipient is a person or a company. Available options: individual, business. See Recipient values.
Given name of a person.
Middle name of a person.
Family name of a person.
Registered name of a company.
Phone number.
Email address.
The recipient's own address, which is not the bank's. It comes back as an object when a city is on file, as a plain string when only free text was stored, and is absent when neither is.
Which rail the money travels on. Available options: ACH, WIRE, WALLET. See Recipient values.
Where the money goes. Which fields you get depends on account_type — a wallet, an ACH account, or a wire account.
- Option 1
- Option 2
- Option 3
When the recipient was created, as an ISO 8601 timestamp.
When it last changed, as an ISO 8601 timestamp.
Key/value pairs you attached. {} when you attached none.