Sign in
Settlement Reports

List Settlement Report Exports

List settlement report export for aggregator.

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

Request

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

Path parameters

aggregator_idstring required
Example:agg_b49985f2-e099-412e-8eb2-98756059cc0d

Aggregator identifier that owns the settlement report exports.

Query parameters

settlement_batch_idstring
Example:sb_6eb80843-eb2b-4df2-b85f-25d50f03d2a1

Filter report exports by settlement batch identifier.

merchant_idstring
Example:mer_0e4b3a32-754b-483a-9c85-80581dbef4cf

Filter report exports by merchant identifier.

kindstring

Filter report exports by report kind (1=REPORT_KIND_SEED, 2=REPORT_KIND_BATCH, 3=REPORT_KIND_MERCHANT).

status1 | 2 | 3 | 4 | 5 | 6
Example:3

Filter report exports by processing status (1=PENDING, 2=RUNNING, 3=SUCCEEDED, 4=FAILED, 5=SEEDED, 6=RETRYING).

started_at_frominteger
Example:1711929600

Include report exports started at or after this Unix timestamp.

started_at_tointeger
Example:1712016000

Include report exports started at or before this Unix timestamp.

date_frominteger
Example:1711929600

Include report exports created on or after this Unix timestamp.

date_tointeger
Example:1712016000

Include report exports created on or before this Unix timestamp.

limitstring
Example:20

Maximum number of records to return.

offsetstring
Example:0

Number of records to skip before listing results.

Response

Paginated list of settlement report export jobs.

api_versionstring

The current version of the API spec

Example response

{
  "api_version": "v1",
  "data": {
    "report_exports": [
      {
        "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,
        "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": "2025-03-13T09:12:34Z",
        "finished_at": "2025-03-13T09:12:34Z",
        "created_at": "2025-03-13T09:12:34Z",
        "updated_at": "2025-03-13T09:12:34Z",
        "partner_id": "partner_37e414c3-c0cc-4541-9bea-ab5a22964bd8",
        "version": 1
      }
    ],
    "count": "4"
  }
}

Changes

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