Skip to main content
GET
/
v1
/
aggregators
/
{raast-aggregator-id}
/
account-info
Read Account Info
curl --request GET \
  --url https://api.getsafepay.com/raastwire/v1/aggregators/{raast-aggregator-id}/account-info \
  --header 'X-SFPY-AGGREGATOR-SECRET-KEY: <api-key>'
import requests

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

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}/account-info', 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}/account-info",
  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}/account-info"

	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}/account-info")
  .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}/account-info")

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": {
    "iban": "PK91ALFH0005001007079203",
    "type": "CAS_CONST_UNSPECIFIED",
    "currency": "PKR",
    "servicer_member_id": "ALFHPKKA",
    "name": "MIRZA",
    "is_default": false,
    "dba": "",
    "mcc": "",
    "account_title": "Title-1 1007079203",
    "account_type": "Account"
  }
}
{
  "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

​
iban
string

IBAN to fetch account information for; optional when alias parameters are supplied.

Example:

"PK91ALFH0005001007079203"

​
with_title_fetch
boolean

When true, include account title details in the response.

Example:

true

​
alias_type
enum<string>

Alias type used for lookup; only MOBILE is supported currently.

Available options:
MOBILE
Example:

"MOBILE"

​
alias_value
integer

Alias value to resolve; must be provided when alias_type is supplied.

Example:

3472840476

Response

This response contains Raast account information details

Standard response structure for successful operations

​
api_version
string

The current version of the API spec

Example:

"v1"

​
data
object

Raast account metadata resolved by IBAN or alias lookup