Updated user

put

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

This PUT endpoint is used to update the profile information of a user with the provided user token.
You need to provide the user_token in the URL path to identify the user whose information you want to update. The updated information should be provided in the request Body as a JSON object. This endpoint can be used to update various profile information, such as the user's name, email address, phone number, and more.
The response will contain the updated user information in a JSON format.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

user_token

string

required

user token that need to be updated

Body Params

Updated user object

status

string

enum

required

The status of the user

Allowed:

created_on

string

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

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

required

The user's street address.

address2

string

The user's street address, line 2.

city

string

required

The user's city.

state_province

string

required

The user's state/province.

postal_code

string

required

The user's postal code.

country

string

required

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

first_name

string

required

The user's first name.

middle_name

string

The user's middle name.

last_name

string

required

The user's last name.

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). Minimum 18 years old

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.

Headers

Idempotency-Key

string

Unique key to prevent duplicate processing

Responses

200successful operation

400Bad request.

401Unauthorized.

403Forbidden.

404Not found.

405Method Not Allowed.

500Internal server error.

504Gateway Time-out.