Create a new customer

post

https://sandbox-api.walapay.io/v1/customers

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

type

string

enum

required

Type of customer (must be INDIVIDUAL).

Allowed:

referenceId

string

If provided, this will be used as the internal customer ID. Must be a valid UUID v4 or CUID.

capabilities

array of strings

Defaults to USD,OTHER

The payment capabilities this individual should have access to. If not provided, the individual will have access to all capabilities.

capabilities

Allowed:

firstName

string

required

length ≤ 100

First name of the individual.

middleName

string

length ≤ 100

Middle name of the individual.

lastName

string

required

length ≤ 100

Last name of the individual.

transliteratedFirstName

string

length ≤ 100

Required when the firstName includes any non Latin-1 characters.
Latin-1 accepted characters: À-ÖØ-ßà-öø-ÿ; Latin-1 accepted symbols: -~.
Examples of alphabets that require transliteration: Arabic, Chinese, Russian, etc.
Example: "张三" would be "Zhang San".

transliteratedMiddleName

string

length ≤ 100

Required when the middleName includes any non Latin-1 characters.
Latin-1 accepted characters: À-ÖØ-ßà-öø-ÿ; Latin-1 accepted symbols: -~.
Examples of alphabets that require transliteration: Arabic, Chinese, Russian, etc.
Example: "张三" would be "Zhang San".

transliteratedLastName

string

length ≤ 100

Required when the lastName includes any non Latin-1 characters.
Latin-1 accepted characters: À-ÖØ-ßà-öø-ÿ; Latin-1 accepted symbols: -~.
Examples of alphabets that require transliteration: Arabic, Chinese, Russian, etc.
Example: "张三" would be "Zhang San".

string

required

length ≤ 255

Email address of the individual.

phone

string

required

Phone number of the individual.

phoneCountryCode

string

enum

Country code for phone number of the individual. Required if the phone number country does not match the country of the individual's address. ISO 3166-1 alpha-2 format.

ipAddress

string

IP address of the individual.

address

object

required

Current address of the individual.
This must use Latin-1 characters only.
Latin-1 accepted characters: À-ÖØ-ßà-öø-ÿ; Latin-1 accepted symbols: -~.
Examples of alphabets that require transliteration: Arabic, Chinese, Russian, etc.
Example: "张三" would be "Zhang San".
We recommend using a transliteration package to ensure the address is valid.

transliteratedAddress

object

Required when the address includes any non Latin-1 characters.
Latin-1 accepted characters: À-ÖØ-ßà-öø-ÿ; Latin-1 accepted symbols: -~.
Examples of alphabets that require transliteration: Arabic, Chinese, Russian, etc.
Example: "张三" would be "Zhang San".

dateOfBirth

date

required

Date of birth of the individual.

accountPurpose

string

enum

Purpose of the account. Required for customers over 60 or living in high risk regions.

accountPurposeExplanation

string

A detailed explanation of how you plan to use the account. Required if accountPurpose is OTHER.

actingAsIntermediary

boolean

The individual is acting as an intermediary by moving funds on behalf of others. Required for customers over 60 or living in high risk regions.

sourceOfFunds

string

enum

Source of funds for the individual. Required for customers over 60 or living in high risk regions.

employmentStatus

string

enum

Current employment status of the individual. Required for customers over 60 or living in high risk regions.

Allowed:

mostRecentOccupation

string

enum

The individual's most recent occupation using a Standard Occupational Classification (SOC) code. Must be a valid 6-digit SOC code from the approved list. Required for customers over 60 or living in high risk regions.

expectedMonthlyPaymentsUSD

string

enum

The expected monthly volume of payments the customer will be sending or receiving. Required for customers over 60 or living in high risk regions.

Allowed:

taxIdentificationNumber

string

length ≤ 50

Tax identification number of the individual.
It must correspond to the country the individual lives in.
Visit the Requirements for Individuals page to see the list of acceptable tax identification types.

governmentIssuedIdentification

object

required

Government issued identification document for the individual. Visit the Requirements for Individuals page to see the list of acceptable government issued identification types.

supportingDocuments

array of objects

Supporting documents for the individual. Visit the Requirements for Individuals page to see the list of acceptable documents.

supportingDocuments

Responses

201The customer has been successfully created.

400Bad request.