List merchants

curl https://api.cash.app/network/v1/merchants \
     -H "Accept: Accept" \
     -H "X-Region: X-Region" \
     -H "X-Signature: X-Signature" \
     -H "User-Agent: User-Agent"

{
  "merchants": [
    {
      "id": "MMI_4vxs5egfk7hmta3qx2h6rp91x",
      "brand_id": "BRAND_8ereg0tug2yiik8vx24xpe5br",
      "name": "Example Business Name",
      "country": "US",
      "currency": "USD",
      "category": "5432",
      "reference_id": "external-id",
      "status": "ACTIVE",
      "created_at": "2022-01-01T12:00:00Z",
      "updated_at": "2022-01-05T12:00:00Z",
      "address": {
        "country": "US",
        "address_line_1": "1215 4th Ave",
        "address_line_2": "Suite 2300",
        "locality": "Seattle",
        "postal_code": "98161-1001",
        "administrative_district_level_1": "Washington"
      },
      "site_url": "string",
      "metadata": {},
      "default_fee_plans": {
        "in_app_fee_plan_id": "FEE_kewjsmjt35t8qhzyjeqcst5me",
        "in_person_fee_plan_id": "FEE_kewjsmjt35t8qhzyjeqcst5me",
        "online_fee_plan_id": "FEE_kewjsmjt35t8qhzyjeqcst5me"
      }
    }
  ],
  "cursor": "string"
}

Returns a list of merchants matching the given query parameters.

This endpoint is rate limited to 50 QPS.

Scopes: MERCHANTS_READ

Query parameters

reference_idstringOptional1-1024 characters

Filters results to only include merchants with a reference_id matching the given value.

cursorstringOptional>=1 character

A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query.

limitintegerOptional1-100Defaults to 50

Maximum number of merchants to return.

Response

merchantslist of objects

List of merchants matching the given query parameters.

cursorstring>=1 character

The pagination cursor to be used in a subsequent request. If empty, this is the final response.

Errors

400

Bad Request Error

Headers

Query parameters

Response

Errors

Headers

Query parameters

Response

Errors