Read Settlement Batch
curl --request GET \
--url https://api.getsafepay.com/raastwire/v1/aggregators/{raast-aggregator-id}/settlements/batches/{settlement-batch-id} \
--header 'X-SFPY-AGGREGATOR-SECRET-KEY: <api-key>'import requests
url = "https://api.getsafepay.com/raastwire/v1/aggregators/{raast-aggregator-id}/settlements/batches/{settlement-batch-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}/settlements/batches/{settlement-batch-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}/settlements/batches/{settlement-batch-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}/settlements/batches/{settlement-batch-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}/settlements/batches/{settlement-batch-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}/settlements/batches/{settlement-batch-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": {
"settlement_batch": {
"id": "200",
"token": "sb_1328a110-2cf5-4e13-993e-55792ec6b76c",
"file_name": "",
"date": "1970-01-01T00:00:00Z",
"status": "BATCH_COMPLETED",
"version": 1,
"created_by_job_id": "job_76b08225-5372-46db-9acb-086ac9c2f7d6",
"partner_id": "partner_37e414c3-c0cc-4541-9bea-ab5a22964bd8",
"artifacts": [
{
"id": "21",
"batch_id": "sb_1328a110-2cf5-4e13-993e-55792ec6b76c",
"artifact_type": "BATCH_ARTIFACT_TYPE_SETTLEMENT_FILE",
"file_name": "CEP Safepay 20260723113002 sb_1328a110-2cf5-4e13-993e-55792ec6b76c.xls",
"s3_key": "settlement-batches/partner_37e414c3-c0cc-4541-9bea-ab5a22964bd8/sb_1328a110-2cf5-4e13-993e-55792ec6b76c/CEP Safepay 20260723113002 sb_1328a110-2cf5-4e13-993e-55792ec6b76c.xls",
"presigned_url": "https://example-bucket.s3.amazonaws.com/settlement-batches/...",
"created_at": "2026-07-23T11:30:06Z"
}
],
"charge_snapshot": {
"id": "8",
"batch_id": "sb_1328a110-2cf5-4e13-993e-55792ec6b76c",
"gross_amount": "8100",
"net_amount": "7814",
"fee_amount": "39",
"sales_tax_on_fee_amount": "4",
"sales_tax_withholding_amount": "162",
"income_tax_withholding_amount": "81",
"digital_tax_amount": "0",
"created_at": "2026-07-23T11:30:06Z"
},
"created_at": "2026-04-13T11:30:02Z"
}
}
}{
"code": "error.bad_request",
"message": "Invalid request parameters"
}{
"api_version": "v1",
"error": {
"code": "error.unauthorized_access",
"message": "partner access key is required in request header"
}
}{
"code": "error.not_found",
"message": "Requested resource not found"
}Settlement Operations
Read Settlement Batch
Retrieve one settlement batch by token, including downloadable batch artifacts and the batch-level charge snapshot when available.
Per-merchant settlement snapshot rows are exposed through the dedicated snapshots list endpoint, not embedded on this response.
GET
/
v1
/
aggregators
/
{raast-aggregator-id}
/
settlements
/
batches
/
{settlement-batch-id}
Read Settlement Batch
curl --request GET \
--url https://api.getsafepay.com/raastwire/v1/aggregators/{raast-aggregator-id}/settlements/batches/{settlement-batch-id} \
--header 'X-SFPY-AGGREGATOR-SECRET-KEY: <api-key>'import requests
url = "https://api.getsafepay.com/raastwire/v1/aggregators/{raast-aggregator-id}/settlements/batches/{settlement-batch-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}/settlements/batches/{settlement-batch-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}/settlements/batches/{settlement-batch-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}/settlements/batches/{settlement-batch-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}/settlements/batches/{settlement-batch-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}/settlements/batches/{settlement-batch-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": {
"settlement_batch": {
"id": "200",
"token": "sb_1328a110-2cf5-4e13-993e-55792ec6b76c",
"file_name": "",
"date": "1970-01-01T00:00:00Z",
"status": "BATCH_COMPLETED",
"version": 1,
"created_by_job_id": "job_76b08225-5372-46db-9acb-086ac9c2f7d6",
"partner_id": "partner_37e414c3-c0cc-4541-9bea-ab5a22964bd8",
"artifacts": [
{
"id": "21",
"batch_id": "sb_1328a110-2cf5-4e13-993e-55792ec6b76c",
"artifact_type": "BATCH_ARTIFACT_TYPE_SETTLEMENT_FILE",
"file_name": "CEP Safepay 20260723113002 sb_1328a110-2cf5-4e13-993e-55792ec6b76c.xls",
"s3_key": "settlement-batches/partner_37e414c3-c0cc-4541-9bea-ab5a22964bd8/sb_1328a110-2cf5-4e13-993e-55792ec6b76c/CEP Safepay 20260723113002 sb_1328a110-2cf5-4e13-993e-55792ec6b76c.xls",
"presigned_url": "https://example-bucket.s3.amazonaws.com/settlement-batches/...",
"created_at": "2026-07-23T11:30:06Z"
}
],
"charge_snapshot": {
"id": "8",
"batch_id": "sb_1328a110-2cf5-4e13-993e-55792ec6b76c",
"gross_amount": "8100",
"net_amount": "7814",
"fee_amount": "39",
"sales_tax_on_fee_amount": "4",
"sales_tax_withholding_amount": "162",
"income_tax_withholding_amount": "81",
"digital_tax_amount": "0",
"created_at": "2026-07-23T11:30:06Z"
},
"created_at": "2026-04-13T11:30:02Z"
}
}
}{
"code": "error.bad_request",
"message": "Invalid request parameters"
}{
"api_version": "v1",
"error": {
"code": "error.unauthorized_access",
"message": "partner access key is required in request header"
}
}{
"code": "error.not_found",
"message": "Requested resource not found"
}Authorizations
Path Parameters
The unique identifier for the aggregator
Example:
"agg_2288490a-2176-4de5-b373-0ffb6f8e2e6e"
Settlement batch token. Must start with sb_ and be exactly 39 characters.
Example:
"sb_1328a110-2cf5-4e13-993e-55792ec6b76c"
Was this page helpful?