Read Settlement Report Export

Read one settlement report export and retrieve a signed download URL when available.

GET /v1/aggregators/{raast-aggregator-id}/settlements/report-exports/{report-export-id}

Read Settlement Report Export

cURL

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

import requests

url = "https://api.getsafepay.com/raastwire/v1/aggregators/{raast-aggregator-id}/settlements/report-exports/{report-export-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/report-exports/{report-export-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/report-exports/{report-export-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/report-exports/{report-export-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/report-exports/{report-export-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/report-exports/{report-export-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

200

{
  "api_version": "v1",
  "data": {
    "report_export": {
      "id": "58",
      "token": "rpt_7670f587-0396-4939-ba4b-585ca67983a2",
      "settlement_batch_id": "sb_6eb80843-eb2b-4df2-b85f-25d50f03d2a1",
      "merchant_id": "mer_0e4b3a32-754b-483a-9c85-80581dbef4cf",
      "kind": "REPORT_KIND_MERCHANT",
      "status": "REPORT_STATUS_SUCCEEDED",
      "attempts": 1,
      "error_message": "",
      "s3_key": "reports/partner_37e414c3-c0cc-4541-9bea-ab5a22964bd8/sb_6eb80843-eb2b-4df2-b85f-25d50f03d2a1/mer_0e4b3a32-754b-483a-9c85-80581dbef4cf/merchant-settlement-report-1775215823-v1.csv",
      "record_count": "2",
      "file_size": "1234",
      "started_at": "2026-04-03T11:30:24Z",
      "finished_at": "2026-04-03T11:30:24Z",
      "created_at": "2026-04-03T11:30:09Z",
      "updated_at": "2026-04-03T11:30:24Z",
      "partner_id": "partner_37e414c3-c0cc-4541-9bea-ab5a22964bd8",
      "version": 1
    },
    "signed_url": "https://raast-settlement-reports.s3.us-east-1.amazonaws.com/reports/partner_37e414c3-c0cc-4541-9bea-ab5a22964bd8/sb_6eb80843-eb2b-4df2-b85f-25d50f03d2a1/mer_0e4b3a32-754b-483a-9c85-80581dbef4cf/merchant-settlement-report-1775215823-v1.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-SignedHeaders=host&X-Amz-Signature=example"
  }
}

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

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

Path Parameters

aggregator_id · string · required

Aggregator identifier that owns the settlement report exports.

Example:

"agg_b49985f2-e099-412e-8eb2-98756059cc0d"

report_export_id · string · required

Settlement report export identifier.

Example:

"rpt_7670f587-0396-4939-ba4b-585ca67983a2"

Response

200

application/json

Settlement report export job details.

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