Get Merchant List

GET 
/merchants

Use this endpoint to view a list of the merchants.

Note

There are no request parameters for this endpoint, Also change limit in the URI to whatever integer value of items you want to receive.

Request

Query Parameters

limit integer
Limit's the amount of items that will be returned.
Example: 25

Header Parameters

Authorization string
appToken created by /auth/token Format: Bearer xxxxxx...
Example: Bearer <appToken>

Responses

200

Ok

application/json

Schema

Schema

meta

object

A key for grouping different types of API data.

itemsinteger

The number of items in the database. It is equal to or smaller than the limit’s value.

limitstring

The maximum number of results to return.

moreboolean

A true/false value that indicates whether “items” or “limit” allows more results.

data

object[]

A key for grouping results.

Array [

idstring

The merchant identification string in Digitzs.

attributes

object

A key for grouping identification and payment information.

accountNamestring

The name of the individual or business associated with the account.

accountTypestring

The account type (Personal or Business).

createddate-time

The date and time that the payment was created.

typestring

The transaction type. Must equal “merchants”.

]

Example (from schema)

{
  "meta": {
    "items": 0,
    "limit": "string",
    "more": true
  },
  "data": [
    {
      "id": "string",
      "attributes": {
        "accountName": "string",
        "accountType": "string",
        "created": "2024-07-29T15:51:28.071Z",
        "type": "string"
      }
    }
  ]
}

ok

{
  "link": {
    "self": "x"
  },
  "meta": {
    "limit": 25,
    "items": 25,
    "more": true
  },
  "data": [
    {
      "id": "merchantId",
      "attributes": {
        "accountName": "Huyen Dinh",
        "accountType": "business",
        "created": "2019-10-10T19:27:00.680Z"
      },
      "type": "merchants"
    }
  ]
}