Payments
Merchants

Lists all Merchants that have been created.

get/payments/merchants

Request

Query parameters

pageinteger

The page number to retrieve.

pageSizeinteger

The number of Merchants to retrieve per page (default is 50).

qstring

Filter the Merchants by name.

Response

Returns a list of Merchant objects.

pageSizeinteger required

The number of Merchants retrieved per page.

nextPageinteger nullable required

The next page number to retrieve. If there are no additional Merchants, this will be null.

totalinteger required

The total count of all Merchants, after any filters.

Example response

{
  "data": [
    {
      "id": "merchant_eead1d640d7c",
      "name": "Ollivanders Wand Shop",
      "website": "https://www.ollivanders.co.uk",
      "categoryCode": "5945",
      "business": {
        "legalName": "Ollivanders Wand Shop Ltd",
        "address": {
          "line1": "Diagon Alley",
          "city": "London",
          "postalCode": "WD1 1AA",
          "country": "gb"
        }
      },
      "networkTokens": {
        "enrolment": [
          {
            "cardBrand": "mastercard",
            "tokenRequestorIdentifier": "50165156978",
            "status": "active"
          },
          {
            "cardBrand": "visa",
            "tokenRequestorIdentifier": "40238123804",
            "status": "active"
          },
          {
            "cardBrand": "american-express",
            "tokenRequestorIdentifier": null,
            "status": "inactive"
          }
        ]
      },
      "applePay": {
        "domains": [
          {
            "merchantUuid": "merchant_eead1d640d7c",
            "domain": "store.ollivanders.co.uk",
            "status": "active"
          }
        ]
      },
      "createdAt": 1692972623233,
      "updatedAt": 1692972623768
    }
  ]
}

Changes

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      the response property // became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property ///// became required for the status

    • info

      the response property ///// became required for the status

    • info

      the response property // became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property ///// became required for the status

    • info

      the response property ///// became required for the status

    • info

      the //// response's property pattern ^[0-9a-zA-Z _\-¡-￿]+$ was added for the status

    • info

      the //// response's property pattern ^[À-ÖØ-öø-ǿa-zA-Z0-9().\-_#,;/@$!% ]+$ was added for the status

    • info

      the //// response's property pattern ^[À-ÖØ-öø-ǿa-zA-Z0-9().\-_#,;/@$!% ]+$ was added for the status

    • info

      the //// response's property pattern ^[0-9a-zA-Z ]*$ was added for the status

    • info

      the /// response's property pattern ^[a-zA-Z0-9 ]{1,60}$ was added for the status

    • info

      the // response's property pattern ^[a-zA-Z0-9 ]{1,60}$ was added for the status

    • info

      added the required property ///// to the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the new optional query request parameter pageSize

    • info

      added the new optional query request parameter q

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status