Skip to main content
POST
Add a payee address

Authorizations

Authorization
string
header
required

Your secret key: sk_test_… on the sandbox host, sk_live_… on live. A key on the wrong host gets a 401 wrong_environment. Keys are secret. Keep them on your server, never in a browser or app.

Headers

Idempotency-Key
string

Optional. Makes a retry safe, as on money-moving creates.

Maximum string length: 255

Path Parameters

id
string
required
Example:

"payee_c8pnahcrxqzd3z8d"

Body

application/json
type
enum<string>
required
Available options:
bank_account
currency
enum<string>
required

Must match the payee's currency if it's already set.

Available options:
usd,
eur,
gbp
Example:

"eur"

rail
enum<string>
required

usd: ach or wire, your choice. eur: sepa. gbp: faster_payments.

Available options:
ach,
wire,
sepa,
faster_payments
Example:

"sepa"

owner_type
enum<string>
required
Available options:
individual,
business
Example:

"individual"

beneficiary_name
string
required

The account holder's name. For business it's also the company name sent to the bank.

Maximum string length: 35
Example:

"Maria Lopez"

bank_name
string
required
Maximum string length: 100
Example:

"ABN AMRO"

account_number
string
required

ach / wire: the account number. sepa: the IBAN (spaces are removed). faster_payments: 8 digits.

Example:

"NL91ABNA0417164300"

beneficiary_address
object
required
routing_code
string

ach / wire: the 9-digit routing number (required). faster_payments: the 6-digit sort code (required). sepa: the BIC, 8 or 11 characters (optional).

account_type
enum<string>

On ach and wire only.

Available options:
checking,
savings

Response

The new address.

id
string
required
Example:

"address_7m3kq9xwd2hr5tna"

payee_id
string
required
Example:

"payee_c8pnahcrxqzd3z8d"

type
enum<string>
required
Available options:
bank_account
currency
enum<string>
required
Available options:
usd,
eur,
gbp
Example:

"eur"

rail
enum<string>
required

Every payout to this address goes on this rail.

Available options:
ach,
wire,
sepa,
faster_payments
Example:

"sepa"

owner_type
enum<string>
required
Available options:
individual,
business
beneficiary_name
string
required
Example:

"Maria Lopez"

bank_name
string
required
Example:

"ABN AMRO"

account_number_last4
string
required
Example:

"4300"

routing_code
string | null
required

The routing number, BIC or sort code. null for a SEPA account sent without a BIC.

Example:

null

account_type
enum<string> | null
required

On ach and wire only.

Available options:
checking,
savings,
null
Example:

null

beneficiary_address
object
required
status
enum<string>
required
Available options:
active,
inactive
created_at
string<date-time>
required
Example:

"2026-10-26T10:01:00Z"