v1

latestOpenAPI 3.0.1Apache 2.02026-07-248286406.8 KB

User

Updated user

This PUT endpoint is used to update the profile information of a user with the provided user token. <br> 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. <br> The response will contain the updated user information in a JSON format.

put/payout/user/{user_token}

Path parameters

user_tokenstring required

user token that need to be updated

Headers

Idempotency-Keystring

Unique key to prevent duplicate processing

Request body

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

The status of the user

created_onstring YYYY-MM-DDThh:mm:ss

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 required

The user's street address.

address2string

The user's street address, line 2.

citystring required

The user's city.

state_provincestring required

The user's state/province.

postal_codestring required

The user's postal code.

countrystring required

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

first_namestring required

The user's first name.

middle_namestring

The user's middle name.

last_namestring required

The user's last name.

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

Example request

{
  "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",
  "date_of_birth": "1975-03-24",
  "metadata": {
    "group_id": 541
  }
}

Response

successful operation

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)