MAmasspay
User

Lookup an existing user

This GET endpoint is used to lookup whether a user with the provided email and first name exists in the MassPay system. <br> To use this endpoint, you need to provide the email, first_name, and internal_user_id as Query parameters in the URL. <br> The endpoint will then search for the user based on the provided information and return a JSON response indicating whether the user exists or not. If the user exists, the response will also contain the user's details, user_token, first_name, last_name and internal_user_id.

get/payout/user/lookup

Request

Query parameters

emailstring required

User's email address. Required if First Name is provided

first_namestring required

User's first name. Required if email is provided

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 + , - . / _ ~ |. Required if email and first name are not provided

Headers

Idempotency-Keystring

Unique key to prevent duplicate processing

Response

Found a matching user

user_tokenstring required

The token of the found user

first_namestring required

First name of the user

last_namestring required

Last name of the user

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

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

The status of the user

Example response

{
  "user_token": "usr_f4741aa2-9f39-4358-8247-2409e3fc2715",
  "internal_user_id": "4324-rOzk"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.