POST
cURL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer Token, Where accessToken is the access token used to authenticate the request.

Headers

Accept-Language
string
default:en

Preferred language for the response

Body

application/json
merchantAccountNumber
integer
required

The unique identifier of the merchant account

Example:

35253486

userId
string
required

The unique identifier of the user to retrieve

Example:

"8"

Response

200 - application/json

Success - Merchant user details retrieved

userId
string

The unique identifier of the user

Example:

"user-id-123"

firstName
string

The first name of the user

Example:

"John"

lastName
string

The last name of the user

Example:

"Phiri"

emailAddress
string<email>

The email address of the user

Example:

"john.phiri@example.com"

phoneNumber
string

The phone number of the user. May be an empty string if not set

Example:

"1234567890"

isEmailConfirmed
boolean

Indicates whether the user's email address has been confirmed

Example:

true

roleName
string

The human-readable description of the user's role

Example:

"Merchant Administrator"

statusCode
string

The status code of the merchant user account (e.g., "A" for Active, "I" for Inactive, "C" for Closed)

Example:

"A"

statusName
string

The human-readable status name of the merchant user account

Example:

"Active"

capturedBy
string

The email of the user who created this merchant user association

Example:

"user@example.com"

dateCaptured
string<date-time>

The date and time when the merchant user association was created in UTC format

Example:

"2025-11-01T10:30:00.000Z"

modifiedBy
string

The email of the user who last modified the merchant user. May be null or empty if never modified

Example:

"user@example.com"

dateModified
string<date-time>

The date and time when the merchant user was last modified in UTC format. May be null if never modified

Example:

"2025-11-03T09:15:00.000Z"