v1

latestOpenAPI 3.0.1Apache 2.02026-07-248286406.8 KB

User

Create a user

This POST endpoint is used to create a new user in MassPay. <br> You can use this endpoint to create a new user with the specified user details in JSON format in the request Body. <br> 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. <br> The response will include details about the newly created user.

post/payout/user

Request body

internal_user_idstring 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 + , - . / _ ~ |

address1string

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

address2string

The user's street address, line 2.

citystring

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

state_provincestring

The user's state/province.

postal_codestring

The user's postal code.

countrystring required

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

first_namestring required

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

middle_namestring

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

last_namestring required

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

emailstring required

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

languagestring

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

mobile_numberstring

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

business_namestring

Company legal name (Only if Business account)

date_of_birthstring 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.

notify_userboolean

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

Example request

{
  "internal_user_id": "4324-rOzk",
  "address1": "2000 main st",
  "address2": "apt D",
  "city": "Santa Monica",
  "state_province": "CA",
  "postal_code": "90405",
  "country": "USA",
  "first_name": "John",
  "last_name": "Doe",
  "email": "jdoe@gmail.com",
  "language": "en",
  "mobile_number": "16502000226",
  "business_name": "ABC Company",
  "date_of_birth": "1975-03-24",
  "metadata": {
    "group_id": 541
  }
}

Response

Successfully created.

user_tokenstring uuid required

Token representing the user that was just created

status'ACTIVE' | 'LOCKED' | 'DEACTIVE' | 'CLOSED' required

The status of the user

created_onstring YYYY-MM-DDThh:mm:ss required

The timestamp the user was created in the system. Using UTC timestamp.ISO 8601

internal_user_idstring 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 + , - . / _ ~ |

address1string

The user's street address.

address2string

The user's street address, line 2.

citystring

The user's city.

state_provincestring

The user's state/province.

postal_codestring

The user's postal code.

countrystring

The user's country code. ISO_3166-1_alpha-3 code

first_namestring required

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

middle_namestring

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

last_namestring required

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

emailstring required

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

languagestring

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

mobile_numberstring

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

business_namestring

Company legal name (Only if Business account)

timezonestring required

User's computed timezone

date_of_birthstring date

Date of birth. (optional). Minimum 18 years old

metadataobject

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

activation_urlstring

If the user does not have an activated account yet, an activation URL will be provided.

Example response

{
  "user_token": "123e4567-e89b-12d3-a456-426614174000",
  "created_on": "2019-07-07T23:03:05",
  "internal_user_id": "4324-rOzk",
  "address1": "2000 main st",
  "address2": "apt D",
  "city": "Santa Monica",
  "state_province": "CA",
  "postal_code": "90405",
  "country": "USA",
  "first_name": "John",
  "last_name": "Doe",
  "email": "jdoe@gmail.com",
  "language": "en",
  "mobile_number": "16502000226",
  "business_name": "ABC Company",
  "timezone": "America/Los_Angeles",
  "date_of_birth": "1975-03-24",
  "metadata": {
    "group_id": 541
  }
}