List Settlement Transactions

List settlement payout transactions for the aggregator by default.

Set only_transactions=true to list underlying payment/refund ledger transactions instead. When listing settlement transactions, populate settlement_transactions; when listing general transactions, populate transactions.

GET /v1/aggregators/{raast-aggregator-id}/settlements/transactions

List Settlement Transactions

cURL

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

200

{
  "api_version": "v1",
  "data": {
    "settlement_transactions": [
      {
        "id": "49",
        "token": "stxn_75549797-f2c6-421d-8dd7-ce39995534b8",
        "settlement_batch_id": "sb_1328a110-2cf5-4e13-993e-55792ec6b76c",
        "aggregator_id": "agg_8fd114c0-1364-4953-8773-62551397ffe1",
        "aggregator_merchant_id": "am_7c9594a6-962d-49c7-94e9-64d9cf285969",
        "raast_merchant_id": "mer_e1a38d10-0064-4d7b-a700-f4ba483efb05",
        "status": "SETTLEMENT_TXN_POSTED",
        "attempt": 1,
        "gross_amount": "300",
        "fee_amount": "0",
        "net_amount": "294",
        "sales_tax_on_fee_amount": "0",
        "sales_tax_withholding_amount": "4",
        "income_tax_withholding_amount": "2",
        "digital_tax_amount": "0",
        "debitor_account_id": "acct_f72d1825-31cc-43a2-a7f6-4463443a1c46",
        "creditor_account_id": "acct_7f073fa9-e248-4f96-8e7c-99ddcd282124",
        "failure_reason": "",
        "created_at": "2026-04-13T11:30:02Z",
        "updated_at": "2026-04-13T11:30:04Z"
      }
    ],
    "transactions": [],
    "next_cursor": "49",
    "count": {
      "filtered_count": "1",
      "total_count": "1"
    }
  }
}

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"

only_transactions · boolean

When true, return general payment/refund transactions in transactions instead of settlement payouts in settlement_transactions.

Example:

false

settlement_batch_id · string

Filter by settlement batch token (sb_…).

Example:

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

settlement_txn_id · string

Filter by settlement transaction token (stxn_…, exactly 41 characters).

Example:

"stxn_75549797-f2c6-421d-8dd7-ce39995534b8"

settlement_txn_status · enum<integer>

Filter settlement transactions by status integer enum (1=SETTLEMENT_TXN_ACK_PENDING, 2=SETTLEMENT_TXN_POSTED, 3=SETTLEMENT_TXN_FAILED, 4=SETTLEMENT_TXN_REJECTED). Response status is the string enum name.

Available options: 1, 2, 3, 4

Example:

2

txn_id · string

Filter general transactions by token (txn_…, exactly 40 characters). Used with only_transactions=true.

Example:

"txn_8ffa984c-f0cb-4835-8eee-89c9ca673dad"

txn_status · enum<integer>

Filter general transactions by status integer enum (1=TXN_LEDGER_POSTED, 2=TXN_SETTLEMENT_SCHEDULED, 3=TXN_SETTLEMENT_DISPATCHED, 4=TXN_SETTLEMENT_CONFIRMED, 5=TXN_SETTLEMENT_REVERSED). Response status is the string enum name.

Available options: 1, 2, 3, 4, 5

Example:

4

Response

200

application/json

Paginated list of settlement payouts or general transactions.

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