Settlement Operations

List Settlement Batches

List settlement batches for the aggregator with cursor-based pagination.

Query status using the integer enum; responses serialize status as the string enum name. Amounts elsewhere in settlement operations are returned in the lowest currency denomination (paisa).

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

Request

Base URL: https://api.getsafepay.com/raastwire
URL: https://api.getsafepay.com/raastwire/v1/aggregators/{raast-aggregator-id}/settlements/batches
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.

batch_idstring

Example:sb_1328a110-2cf5-4e13-993e-55792ec6b76c

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

status0 | 1 | 2 | 3

Example:2

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.

Response

Paginated list of settlement batches.

api_versionstring

The current version of the API spec

Example response

{
  "api_version": "v1",
  "data": {
    "batches": [
      {
        "id": "200",
        "token": "sb_1328a110-2cf5-4e13-993e-55792ec6b76c",
        "date": "2025-03-13T09:12:34Z",
        "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": "2025-03-13T09:12:34Z"
          }
        ],
        "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"
          }
        ],
        "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": "2025-03-13T09:12:34Z"
        },
        "created_at": "2025-03-13T09:12:34Z"
      }
    ],
    "next_cursor": "65",
    "count": {
      "filtered_count": "1",
      "total_count": "5"
    }
  }
}

Changes

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