Settlement Reports

Create Settlement Report Export

Create an asynchronous settlement report export job for a batch or merchant scope.

post/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.

Request body

settlement_batch_idstring required

Settlement batch identifier to export.

merchant_idstring

Optional merchant identifier for merchant-level report exports type REPORT_KIND_MERCHANT. Empty if the report exports are of type REPORT_KIND_BATCH.

kind'REPORT_KIND_BATCH' | 'REPORT_KIND_MERCHANT' required

Export scope kind.

Example request

{
  "settlement_batch_id": "sb_6eb80843-eb2b-4df2-b85f-25d50f03d2a1",
  "merchant_id": "mer_e1a38d10-0064-4d7b-a700-f4ba483efb05",
  "kind": "REPORT_KIND_BATCH"
}

Response

Settlement report export job created successfully.

api_versionstring

The current version of the API spec

Example response

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

Changes

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