List reconciliations | Runledger API

{
  "object": "string",
  "data": [
    {
      "id": "rec_2qW5eR8tYu",
      "object": "string",
      "date": "2023-01-15",
      "status": "running",
      "payment_provider": "stripe",
      "totals": [
        {
          "currency": "string",
          "ledger_amount": 1,
          "provider_amount": 1
        }
      ],
      "breaks": [
        {
          "type": "missing_in_ledger",
          "currency": "string",
          "description": "string",
          "expected": 1,
          "actual": 1,
          "ledger_reference": "string",
          "provider_reference": "string"
        }
      ],
      "livemode": true,
      "created_at": "2024-01-15T09:30:00Z",
      "checked_count": 1,
      "completed_at": "2024-01-15T09:30:00Z"
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}

Once a day, for each connected provider, Runledger matches every top-up and invoice payment in its ledger against that provider’s records and reports any break. reconciliation.breaks_found fires when one doesn’t match.

Authentication

AuthorizationBearer

A secret key (rl_sk_test_..., rl_sk_live_...) or a restricted key with limited scopes (rl_rk_test_..., rl_rk_live_...). A restricted key can carry agent: true and an expires_at, and is what a coding agent should hold. Keys end in a checksum so secret scanners can recognize them. People create, roll and revoke keys in the dashboard; GET /v1/api_keys lists them, masked.

Query parameters

statusenumOptional

Only reconciliations with this status.

Allowed values:

payment_providerstringOptional

Only reconciliations of this provider. There is one run per provider per day.

date_afterdateOptional

Only reconciliations on or after this date.

date_beforedateOptional

Only reconciliations before this date.

limitintegerOptional1-100Defaults to 20

Maximum number of objects to return, from 1 to 100.

cursorstringOptional

The next_cursor from the previous page.

Response

A page of reconciliations.

object"list"

datalist of objects

has_moreboolean

next_cursorstringOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

429

Too Many Requests Error

500

Internal Server Error