Merchants

Create Merchant

post/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

Request body

merchant_external_idstring required

Client-supplied identifier that remains stable across Safepay integrations

ibanstring required

Settlement IBAN used for Raast payouts

namestring required

Merchant display name

enabledboolean

Indicates whether the merchant should be active immediately after creation

raast_merchant_idstring required

Identifier of the previously onboarded Raast merchant to associate

Example request

{
  "rate_card": {
    "ratecard_kind": "RateCardKind_fixed"
  }
}

Response

This response contains details of a merchant

api_versionstring

The current version of the API spec

Example response

{
  "api_version": "v1",
  "data": {
    "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"
  }
}

Changes

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