Sign in
Aggregators

Get Aggregator

Changed on
get/v1/aggregators/{raast-aggregator-id}

Request

  • Base URL: https://api.getsafepay.com/raastwire
  • URL: https://api.getsafepay.com/raastwire/v1/aggregators/{raast-aggregator-id}
  • 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

Response

This response contains details of an aggregator

api_versionstring

The current version of the API spec

Example response

{
  "api_version": "v1",
  "data": {
    "token": "agg_tok_2b42c4d0",
    "partner_id": "partner_123456",
    "bank_account_id": "ba_2cab1524-805d-4a09-8e51-924ddf3f43ea",
    "name": "Example Aggregator",
    "is_active": true,
    "is_super": true,
    "vault_enabled": true,
    "bank_account": {
      "created_at": "2025-03-13T09:12:34Z",
      "updated_at": "2025-03-13T09:12:34Z"
    },
    "keys": [
      {
        "id": "ak_da8f1c10-346a-4be8-895a-b6187a9a9662",
        "token": "ak_tok_fede37a6",
        "key_id": "key_live_e111f1c10",
        "aggregator_id": "agg_2288490a-2176-4de5-b373-0ffb6f8e2e6e",
        "is_active": true,
        "name": "Primary Production Key",
        "secret": "sk_live_uMPN7cX2b1",
        "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"
  }
}

Changes

  • e54fafc46fd7Revision changes
    • info

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

    • info

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

  • 6b9011c7c29aRevision changes
    • breaking

      the // response's property type changed from string to no type, and format from date-time to no format for status

    • breaking

      the //// response's property type changed from string to no type, and format from date-time to no format for status

    • breaking

      the //// response's property type changed from string to no type, and format from date-time to no format for status

    • breaking

      the // response's property type changed from string to no type, and format from date-time to no format for status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      added to the // response property allOf list for the response status

    • info

      added to the //// response property allOf list for the response status

    • info

      added to the //// response property allOf list for the response status

    • info

      added to the // response property allOf list for the response status