Settlement Operations

List Settlement Snapshots

List per-merchant settlement snapshots persisted for a settlement batch, including payout IBAN, account title, and amount breakdowns.

count.filtered_count reflects optional filters; count.total_count is the batch total before those filters.

get/v1/aggregators/{raast-aggregator-id}/settlements/batches/{settlement-batch-id}/snapshots

Request

Base URL: https://api.getsafepay.com/raastwire
URL: https://api.getsafepay.com/raastwire/v1/aggregators/{raast-aggregator-id}/settlements/batches/{settlement-batch-id}/snapshots
Auth: API key in header X-SFPY-AGGREGATOR-SECRET-KEY

Query parameters

cursorinteger

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

limitinteger

Example:30

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

direction'ASC' | 'DESC'

Example:DESC

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

settlement_txn_idstring

Example:stxn_9d5bd7bd-863a-487f-944c-f15d30d9bbc5

Filter by settlement transaction token (stxn_…).

merchant_idstring

Example:mer_ce6df98c-cdde-48bf-bc32-464cecac2ee3

Filter by Raast merchant token (mer_…).

Response

Paginated list of settlement snapshots for a batch.

api_versionstring

The current version of the API spec

Example response

{
  "api_version": "v1",
  "data": {
    "settlement_snapshots": [
      {
        "id": "44",
        "batch_id": "sb_1328a110-2cf5-4e13-993e-55792ec6b76c",
        "settlement_transaction_id": "stxn_9d5bd7bd-863a-487f-944c-f15d30d9bbc5",
        "merchant_id": "mer_ce6df98c-cdde-48bf-bc32-464cecac2ee3",
        "aggregator_id": "agg_b49985f2-e099-412e-8eb2-98756059cc0d",
        "iban": "PK36SCBL0000001123456702",
        "account_title": "OPTIVOLVE DIGITAL",
        "gross_amount": "7900",
        "net_amount": "7620",
        "fee_amount": "39",
        "sales_tax_on_fee_amount": "4",
        "sales_tax_withholding_amount": "158",
        "income_tax_withholding_amount": "79",
        "digital_tax_amount": "0",
        "currency": "PKR",
        "created_at": "2025-03-13T09:12:34Z"
      }
    ],
    "next_cursor": "44",
    "count": {
      "filtered_count": "1",
      "total_count": "5"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.