List Merchants

GET

/api/admin/merchants

curl --request GET \
  --url https://example.com/api/admin/merchants \
  --header 'Authorization: Bearer <token>'

List all merchants (paged), across every tenant.

Authorizations

• Bearer

Parameters

Query Parameters

Search

string

Page

integer format: int32

PageSize

integer format: int32

Responses

200

OK

Media type application/json

object

items

Array<object>

nullable

object

id

string format: uuid

name

string

nullable

description

string

nullable

contactEmail

string

nullable

contactPhone

string

nullable

country

string

nullable

timeZone

string

nullable

isActive

boolean

gatewayConfigured

boolean

createdAt

string format: date-time

updatedAt

string format: date-time

paychoiceEnvironment

string

Allowed values: Staging Production

merchantGuidConfigured

boolean

paychoiceMerchantProfileId

string

nullable

billingRetryOffsetsDays

string

nullable

billingTerminalAction

string

Allowed values: Cancel Suspend

bankSettlementWindowDays

integer format: int32

page

integer format: int32

pageSize

integer format: int32

totalCount

integer format: int32

totalPages

integer format: int32

hasNextPage

boolean

hasPreviousPage

boolean

Example

{
  "items": [
    {
      "paychoiceEnvironment": "Staging",
      "billingTerminalAction": "Cancel"
    }
  ]
}