Merchants

List Merchants

get/v1/aggregators/{raast-aggregator-id}/merchants

Request

Base URL: https://api.getsafepay.com/raastwire
URL: https://api.getsafepay.com/raastwire/v1/aggregators/{raast-aggregator-id}/merchants
Auth: API key in header X-SFPY-AGGREGATOR-SECRET-KEY

Path parameters

raast-aggregator-idstring required

Example:agg_2288490a-2176-4de5-b373-0ffb6f8e2e6e

The unique identifier for the aggregator

Query parameters

limitstring

Example:10

Maximum number of merchants to return in a single page

offsetstring

Example:0

Cursor offset used for pagination

enabledstring

Example:true

Filter merchants by their enabled status

merchant_identifiersstring

Example:am_1234567890

Comma-separated list of merchant identifiers to match

namesstring

Example:Test Merchant

Comma-separated list of merchant names to match

Response

This response contains a paginated list of merchants linked to an aggregator

api_versionstring

The current version of the API spec

Example response

{
  "api_version": "v1",
  "data": {
    "merchants": [
      {
        "bank_account": {
          "created_at": "2025-03-13T09:12:34Z",
          "updated_at": "2025-03-13T09:12:34Z"
        },
        "raast_merchant": {
          "created_at": "2025-03-13T09:12:34Z",
          "updated_at": "2025-03-13T09:12:34Z"
        },
        "rate_card": {
          "ratecard_kind": "RateCardKind_fixed",
          "created_at": "2025-03-13T09:12:34Z",
          "updated_at": "2025-03-13T09:12:34Z"
        },
        "created_at": "2025-03-13T09:12:34Z",
        "updated_at": "2025-03-13T09:12:34Z"
      }
    ],
    "count": "2"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.