Create a customer

Needs create Beneficiary. Local rails use rail: local with accountNumber and routingNumber; neither may contain : (400 VALIDATION_ERROR naming the field). An identifier of the other rail (an iban or swiftCode on a local customer, an accountNumber or routingNumber on a swift one) is 400 VALIDATION_ERROR. fullName, entityType, addressCountryCode and addressLine1 are required and cannot be blank.
customerReference is optional and binds the new customer (LEGACY_UNSET is 400 RESERVED_CUSTOMER_REFERENCE). Send currency: a customer with no currency has no identity yet, so declarations and inline payouts do not find, bind or match it until a currency is set. A currency that is sent must be one of USD, AED, EUR, GBP, else 400 VALIDATION_ERROR. Once strict mode is on a currency is required and an IBAN must pass its checksum.
If an active customer with the same identity (rail, account identifier, currency) exists, bound or not, the create is 409 CUSTOMER_EXISTS; error.details.customerId names it only when the credential may read that customer. A create never reuses or binds an existing customer.
The response is the customer as the credential may read it: a withheld field is absent, and a customer the credential may not read comes back as { customerId } only. A scoped credential that writes a field it cannot read gets 403 FIELD_EXCLUDED.
Rate limit: 20 / minute.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
length ≤ 100
string
required

Not blank

string
enum
required
Allowed:
string

Required when rail is swift. Not accepted when rail is local. Must pass its checksum once strict mode is on.

string

Required when rail is swift (a missing or empty code is refused). Not accepted when rail is local.

string

Required when rail is local. Not accepted when rail is swift. Must not contain :.

string

Required when rail is local. Not accepted when rail is swift. Must not contain :.

string
enum
Allowed:
string
enum
required
Allowed:
string
required

ISO 3166-1 alpha-2, not blank

string
required
length ≤ 50

Not blank

string
length ≤ 50
string
length ≤ 50
string
length ≤ 50
string | null

Optional. Binds the new customer; null is read as not sent. LEGACY_UNSET is refused with RESERVED_CUSTOMER_REFERENCE.

Headers
string

Optional; echoed so you can thread your logs with ours.

Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json