Skip to content

Latest commit

 

History

History
36 lines (27 loc) · 1.06 KB

list-merchants-response.md

File metadata and controls

36 lines (27 loc) · 1.06 KB

List Merchants Response

The response object returned by the ListMerchant endpoint.

Structure

ListMerchantsResponse

Fields

Name Type Tags Description Getter
Errors List<Error> Optional Information on errors encountered during the request. List getErrors()
Merchant List<Merchant> Optional The requested Merchant entities. List getMerchant()
Cursor Integer Optional If the response is truncated, the cursor to use in next request to fetch next set of objects. Integer getCursor()

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"
    }
  ]
}