Find Alias - Safepay Raastwire

Find Alias

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

import requests

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

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}/alias/{alias-id}', 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}/alias/{alias-id}",
  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}/alias/{alias-id}"

	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}/alias/{alias-id}")
  .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}/alias/{alias-id}")

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

{
  "api_version": "v1",
  "data": {
    "id": "2",
    "token": "als_962c42c4-06a1-482f-a227-970453f29eb9",
    "merchant_id": "mer_63b32978-8af7-41b8-88fc-d027be766f77",
    "aggregator_merchant_id": "am_01fa1fd6-d8aa-47c7-a4c3-a1ac0a76ae36",
    "alias_type": "TILL_CODE",
    "alias_value": "542185757",
    "status": "Active",
    "start_date": "2025-08-20",
    "expiration_date": "2035-08-20",
    "opening_date": "2025-08-20",
    "closing_date": "2035-08-20",
    "created_at": "2025-08-20T09:47:27Z",
    "updated_at": "2025-08-25T11:46:52Z",
    "alias_record_id": "448589"
  }
}

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

GET

aggregators

{raast-aggregator-id}

alias

{alias-id}

Find Alias

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

import requests

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

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}/alias/{alias-id}', 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}/alias/{alias-id}",
  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}/alias/{alias-id}"

	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}/alias/{alias-id}")
  .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}/alias/{alias-id}")

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

{
  "api_version": "v1",
  "data": {
    "id": "2",
    "token": "als_962c42c4-06a1-482f-a227-970453f29eb9",
    "merchant_id": "mer_63b32978-8af7-41b8-88fc-d027be766f77",
    "aggregator_merchant_id": "am_01fa1fd6-d8aa-47c7-a4c3-a1ac0a76ae36",
    "alias_type": "TILL_CODE",
    "alias_value": "542185757",
    "status": "Active",
    "start_date": "2025-08-20",
    "expiration_date": "2035-08-20",
    "opening_date": "2025-08-20",
    "closing_date": "2035-08-20",
    "created_at": "2025-08-20T09:47:27Z",
    "updated_at": "2025-08-25T11:46:52Z",
    "alias_record_id": "448589"
  }
}

{
  "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"

alias-id

string

required

The unique identifier for the alias

Example:

"als_962c42c4-06a1-482f-a227-970453f29eb9"

Response

This response contains details of an alias

Standard response structure for successful operations

api_version

string

The current version of the API spec

Example:

"v1"

data

object

Raast alias record

Show child attributes