Sign in

v1

latestOpenAPI 3.0.32026-07-2488203535.0 KB
Gateway Features
Users

Get Merchant or Partner User Info

❗️ Never Use Real API Keys

Never use real API Keys when testing. The gateway allows Partners to create Test Merchant Accounts. Testing should always use keys from the Test Accounts and never keys from a Standard Account.

<details> <summary>Usage</summary> This will return information on all users associated with a specific merchant or sub-affiliate account. </details>
post/v4/users/search

Headers

Content-Typestring required

The Content-Type representation header is used to indicate the original media type of the resource (prior to any content encoding applied for sending).

Authorizationstring required

Your v4 API key that was generated in the Partner portal.

Request body

maxResultsstring required

Number of max results, any integer number from 1 to 1000.

merchantIdstring

Merchant ID.

affiliateIdstring

Affiliate ID. To get user information for a sub-affiliate account, pass in affiliateId instead of merchantId.

Response

Success

idstring

ID of merchant or partner.

createdstring date-time

Timestamp when the merchant/partner was created.

updatedstring date-time

Timestamp when the merchant/partner was last updated.

firstNamestring

First name of the merchant/partner.

lastNamestring

Last name of the merchant/partner.

titlestring

Title of the merchant/partner.

emailstring

Email address of the merchant/partner.

usernamestring

Username of the merchant/partner.

isTwoFactorEnabledboolean

Indicates if two-factor authentication is enabled for the merchant/partner.

viewVersioninteger

Version of the view.

mainUserboolean

Indicates if the merchant/partner is the main user.

hasUsedCredentialsForApiLoginboolean

Indicates if the merchant/partner has used credentials for API login.

gatewayTitlestring

Title of the gateway.