Sign in
Settlement Operations

List Settlement Job Runs

List settlement-engine job runs visible to the aggregator.

Results are scoped to jobs that created settlement batches containing settlement transactions for this aggregator. Use this to inspect ledger poster, ledger settler, and payout generator runs related to your settlement activity.

get/v1/aggregators/{raast-aggregator-id}/settlements/job-runs

Request

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

job_idstring
Example:job_76b08225-5372-46db-9acb-086ac9c2f7d6

Restrict results to a single job run token (job_…, exactly 40 characters).

job_type1 | 2 | 3
Example:2

Filter by job type integer enum (1=LEDGER_POSTER_JOB, 2=LEDGER_SETTLER_JOB, 3=PAYOUT_GENERATOR_JOB). Response job_type is the string enum name.

job_status1 | 2 | 3
Example:2

Filter by job status integer enum (1=JOB_STATUS_STARTED, 2=JOB_STATUS_SUCCESS, 3=JOB_STATUS_FAILED). Response status is the string enum name.

start_dateinteger
Example:1744531200

Inclusive lower bound on job started_at, as a Unix timestamp in seconds.

end_dateinteger
Example:1744617600

Inclusive upper bound on job ended_at, as a Unix timestamp in seconds. Must be greater than or equal to start_date when both are set.

Response

Paginated list of settlement-engine job runs.

api_versionstring

The current version of the API spec

Example response

{
  "api_version": "v1",
  "data": {
    "job_run": [
      {
        "id": "42",
        "token": "job_76b08225-5372-46db-9acb-086ac9c2f7d6",
        "job_type": "LEDGER_SETTLER_JOB",
        "status": "JOB_STATUS_SUCCESS",
        "started_at": "2025-03-13T09:12:34Z",
        "ended_at": "2025-03-13T09:12:34Z",
        "created_at": "2025-03-13T09:12:34Z"
      }
    ],
    "next_cursor": "42",
    "count": {
      "filtered_count": "1",
      "total_count": "5"
    }
  }
}

Changes

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