Create a user

post

https://{environment}.masspay.io/{VERSION}/payout/user

This POST endpoint is used to create a new user in MassPay.
You can use this endpoint to create a new user with the specified user details in JSON format in the request Body.
To use this endpoint, you need to provide the internal_user_id, country, first_name, last_name, and email as required parameters in the Request Body.
The response will include details about the newly created user.

Body Params

Created user object

internal_user_id

string

required

A client-defined identifier for the user. This is the unique ID assigned to the user on your system. Max 75 characters. Allows letters, numbers, and + , - . / _ ~ |

address1

string

The user's street address. Required in order to process a payout.

address2

string

The user's street address, line 2.

city

string

The user's city. Required in order to process a payout.

state_province

string

The user's state/province.

postal_code

string

The user's postal code.

country

string

required

The user's country code. ISO_3166 code. Required in order to process a payout.

first_name

string

required

The user's first name. (If Business account, the first name of the representative)

middle_name

string

The user's middle name. (If Business account, the middle name of the representative)

last_name

string

required

The user's last name. (If Business account, the last name of the representative)

string

required

The user's e-mail address. Must be unique. Cannot have two users with the same e-mail address.

language

string

length between 2 and 2

The user's preferred language of communication. If not provided, defaults to English (en)

mobile_number

string

(Optional) Mobile number of user. Allows for SMS notifications upon availability of funds

business_name

string

Company legal name (Only if Business account)

date_of_birth

date

Date of birth. Optional when creating a user, but required before processing a payout unless explicitly exempted by compliance. Users must be at least 18 years old, unless a lower age is approved by compliance.

metadata

object

Optional JSON object with attributes that can later be searched to locate this user. Do not include PII as this object is not encrypted.

notify_user

boolean

Defaults to false

Should we notify the user via email that their user has been created in the system? They will receive instructions to establish such account.

Responses

201Successfully created.

400Bad request.

401Unauthorized.

403Forbidden.

404Not found.

405Method Not Allowed.

500Internal server error.

504Gateway Time-out.