List Settlement Batches

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

import requests

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

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', 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",
  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"

	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")
  .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")

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": {
    "batches": [
      {
        "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",
        "created_at": "2026-04-13T11:30:02Z"
      }
    ],
    "next_cursor": "65",
    "count": {
      "filtered_count": "36",
      "total_count": "36"
    }
  }
}

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

GET

aggregators

{raast-aggregator-id}

settlements

batches

List Settlement Batches

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

import requests

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

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', 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",
  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"

	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")
  .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")

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": {
    "batches": [
      {
        "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",
        "created_at": "2026-04-13T11:30:02Z"
      }
    ],
    "next_cursor": "65",
    "count": {
      "filtered_count": "36",
      "total_count": "36"
    }
  }
}

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

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

cursor

integer<int64>

Cursor for pagination. Pass the previous response next_cursor, or omit/0 for the first page.

Example:

0

limit

integer<int32>

Page size. Default 30. Maximum 100. 0 is treated as the default.

Example:

30

direction

enum<string>

Sort direction on the underlying numeric id. Must be uppercase ASC or DESC. Invalid or empty values default to DESC.

Available options:

ASC,

DESC

Example:

"DESC"

batch_id

string

Restrict results to a single settlement batch token (sb_…, exactly 39 characters).

Example:

"sb_1328a110-2cf5-4e13-993e-55792ec6b76c"

status

enum<integer>

Filter by settlement batch status integer enum (0=BATCH_CREATED, 1=BATCH_PROCESSING, 2=BATCH_COMPLETED, 3=BATCH_FAILED). Response status is the string enum name.

Available options:

0,

1,

2,

3

Example:

2

Response

Paginated list of settlement batches.

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