BAbanqzinc
Merchants

Get all merchants

Changed on

Get all merchants

get/api/v1/merchants

Request

Query parameters

partner_idstring uuid

Filter merchants by partner ID. Required for admin tokens without partner context.

Response

Success

successboolean required

Indicates if the request was successful

Example response

{
  "success": true,
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174001",
      "brand_name": "Example Brand",
      "uri": "https://example-merchant.com",
      "category_code": "4816",
      "country": "GB",
      "settlement_currency": "EUR",
      "multi_account_setting": true,
      "refund_retention_rate": "0.0500",
      "client_id": "merchant_123",
      "has_client_secret": true,
      "account_owners": []
    }
  ]
}

Changes

  • b372e7d5563dRevision changes
    • breaking

      the / response's property type changed from string to no type for status

    • warning

      removed the optional property / from the response with the status

    • info

      added the new optional query request parameter partner_id

    • 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

      added subschema #1 subschema #2 to the / response property allOf list for the response status

    • info

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

    • info

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

  • 6637b341d86dRevision changes
    • info

      endpoint added