list-merchants-response.md

List Merchants Response

The response object returned by the ListMerchant endpoint.

Structure

List Merchants Response

Fields

Name	Type	Tags	Description
errors	Array<Error Hash>	Optional	Information on errors encountered during the request.
merchant	Array<Merchant Hash>	Optional	The requested Merchant entities.
cursor	Integer	Optional	If the response is truncated, the cursor to use in next request to fetch next set of objects.

Example (as JSON)

{
  "merchant": [
    {
      "business_name": "Apple A Day",
      "country": "US",
      "created_at": "2021-12-10T19:25:52.484Z",
      "currency": "USD",
      "id": "DM7VKY8Q63GNP",
      "language_code": "en-US",
      "main_location_id": "9A65CGC72ZQG1",
      "status": "ACTIVE"
    }
  ],
  "errors": [
    {
      "category": "MERCHANT_SUBSCRIPTION_ERROR",
      "code": "INVALID_EXPIRATION",
      "detail": "detail6",
      "field": "field4"
    }
  ],
  "cursor": 124
}