Endpoints

List merchants

Lists the merchants belonging to the calling master. Always scoped to the caller. There is no way to widen it. Paged.

GET
/v1/merchants

Authorization

bearerAuth
AuthorizationBearer <token>

A partner API token issued to a Master Account. Send Authorization: Bearer <token> on every request. Tokens are issued and revoked by a SuperAdmin in the backoffice, not through this API.

In: header

Query Parameters

page?integer

1-based page number. Defaults to 1.

Default1
Range1 <= value
pagesize?integer

Page size. Defaults to 25. Use 0 to return all merchants in one call (unpaged).

Default25
Range0 <= value

Response Body

application/json

application/json

application/json

{
  "items": [
    {
      "merchantid": 0,
      "merchantcode": "string",
      "apitoken": "string",
      "status": 0,
      "statuslabel": "string",
      "businessname": "string",
      "businesslegalname": "string",
      "businessemail": "string",
      "businesstelephone": "string",
      "contactfirstname": "string",
      "contactsurname": "string",
      "contactemail": "string",
      "datecreated": "2019-08-24T14:15:22Z"
    }
  ],
  "total": 0,
  "page": 0,
  "pagesize": 0
}
{
  "error": {
    "code": "unauthorized",
    "message": "A valid bearer token is required.",
    "requestid": "8f3c1a9b2d7e4f60"
  }
}
{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Retry after the period indicated.",
    "requestid": "8f3c1a9b2d7e4f60"
  }
}

On this page