Aliases

List aliases

Retrieve a paginated list of aliases created. It supports pagination, filtering by alias_type, status, merchant_identifier, start_date and expiration_date.

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

Request

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

Query parameters

limitinteger
offsetinteger
alias_type'TILL_CODE'
status'Active' | 'Suspended'

Filter aliases by status.

merchant_identifierstring
start_datestring date
expiration_datestring date

Response

This response contains a paginated list of aliases

api_versionstring

The current version of the API spec

Example response

{
  "api_version": "v1",
  "data": {
    "count": "4"
  }
}

Changes

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