Get Merchant List

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.

Usage This is a query to get all merchant accounts under your partner account.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Required. Value must be between 1-1000.

ids
array of strings

An array of merchant ids.

ids
string

"parentAffiliateId": "1" // An affiliate id. Only merchants under this affiliate will be returned, rather than the full tree.

string

"type": "gateway" // Only available options are gateway, test, splitFunding, mobile.

string

"search": "Asdf" Performs a search on this text as a case-insensitive search on any of the following: email, company name, first and last name, phone number, external id, or username

string

"offset": 0 // Like all reports and search endpoints, you can specify the offset, which is the start point for the responses

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

string
required

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

Response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json