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

List aliases

cURL

curl --request GET \
  --url https://api.getsafepay.com/raastwire/v1/aggregators/{raast-aggregator-id}/aliases \
  --header 'X-SFPY-AGGREGATOR-SECRET-KEY: <api-key>'

import requests

url = "https://api.getsafepay.com/raastwire/v1/aggregators/{raast-aggregator-id}/aliases"

headers = {"X-SFPY-AGGREGATOR-SECRET-KEY": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-SFPY-AGGREGATOR-SECRET-KEY': '<api-key>'}};

fetch('https://api.getsafepay.com/raastwire/v1/aggregators/{raast-aggregator-id}/aliases', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getsafepay.com/raastwire/v1/aggregators/{raast-aggregator-id}/aliases",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-SFPY-AGGREGATOR-SECRET-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getsafepay.com/raastwire/v1/aggregators/{raast-aggregator-id}/aliases"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-SFPY-AGGREGATOR-SECRET-KEY", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.getsafepay.com/raastwire/v1/aggregators/{raast-aggregator-id}/aliases")
  .header("X-SFPY-AGGREGATOR-SECRET-KEY", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getsafepay.com/raastwire/v1/aggregators/{raast-aggregator-id}/aliases")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-SFPY-AGGREGATOR-SECRET-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "api_version": "v1",
  "data": {
    "alias": [
      {
        "id": "5",
        "token": "als_3b5bbe1d-350e-4a33-9b0d-63386f87a328",
        "merchant_id": "mer_553dad9b-3984-4131-8842-84983e922351",
        "alias_type": "TILL_CODE",
        "alias_value": "541661038",
        "status": "Active",
        "start_date": "2026-01-06",
        "expiration_date": "2036-01-06",
        "opening_date": "2026-01-06",
        "closing_date": "2036-01-06",
        "created_at": "2026-01-06T09:27:14Z",
        "updated_at": "2026-01-06T09:27:14Z",
        "alias_record_id": "464449"
      }
    ],
    "count": "4"
  }
}

{
  "api_version": "v1",
  "error": {
    "code": "error.unauthorized_access",
    "message": "partner access key is required in request header"
  }
}

Authorizations

X-SFPY-AGGREGATOR-SECRET-KEY · string · header · required

Path Parameters

raast-aggregator-id · string · required

The unique identifier for the aggregator

Example:

"agg_2288490a-2176-4de5-b373-0ffb6f8e2e6e"

Query Parameters

limit · integer

offset · integer

alias_type · enum<string>

Available options: TILL_CODE

status · enum<string>

Filter aliases by status.

Available options: Active, Suspended

merchant_identifier · string

start_date · string<date>

expiration_date · string<date>

Response

200

application/json

This response contains a paginated list of aliases

Standard response structure for successful operations

api_version · string

The current version of the API spec

Example:

"v1"

data · object

Contains the response data

Show child attributes