Sign in

v1

latestOpenAPI 3.1.02026-07-242325051.4 MB
Merchants

Merchants:List

Get a list (without pagination) of all your merchants.

get/v2/merchants/list

Query parameters

eq'ACTIVE' | 'INACTIVE'

Filter on the exact merchant status.

neq'ACTIVE' | 'INACTIVE'

Filter out the specified merchant status.

Filter by merchant status.

{
  "eq": "ACTIVE",
  "neq": "INACTIVE"
}
eq'ENABLED' | 'DISABLED'

Filter on the exact merchant payout status.

neq'ENABLED' | 'DISABLED'

Filter out the specified merchant payout status.

Filter by merchant payout status.

{
  "eq": "ENABLED",
  "neq": "DISABLED"
}
eq'REGISTERED' | 'ONBOARDING' | 'ACCEPTED'

Filter on the exact merchant boarding status.

neq'REGISTERED' | 'ONBOARDING' | 'ACCEPTED'

Filter out the specified merchant boarding status.

Filter by merchant boarding status.

{
  "eq": "REGISTERED",
  "neq": "ACCEPTED"
}

Response

OK

totalinteger nullable

The total items the collection contains

Example response

{
  "merchants": [
    {
      "code": "M-1234-4321",
      "name": "GMS Demo Merchant",
      "status": "ACTIVE",
      "payoutStatus": "DISABLED",
      "boardingStatus": "REGISTERED"
    }
  ],
  "total": 10
}