v1

latestOpenAPI 3.0.32026-07-2488203535.0 KB

Gateway Features

Merchants

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.

<details> <summary>Usage</summary> This is a query to get all merchant accounts under your partner account. </details>

post/v4/merchants/reports

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

Required. Value must be between 1-1000.

idsstring[]

An array of merchant ids.

parentAffiliateIdstring

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

typestring

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

searchstring

"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

offsetstring

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

Response

Success

objectType'serviceConfig'

The type of object that was returned as a result of the request.

reportIdnumber

The ID of the report.

offsetnumber

The first N skipped results.

maxResultsnumber

The max number results.

totalResultsnumber

The total number of results.

hasMoreboolean

If are there more results for the search.