Reconciling settlement records

After a transaction has been captured (either through a direct sale or separate authorization and capture) your payment service will likely proceed with clearing the payments, after which they will settle the funds to your account.

Once the funds have been settled by your payment service, we will ingest the settlement reports and reconcile those entries against the transactions in our system. We will mark any transaction to as settled by matching the ingested transaction level data to the transactions in our system using the reconciliation_id, and attach any of the fees to the transaction record.

See more about the ingestion and scheduling of the settlement reports in the settlement reporting section.

​

Settled status

Once a transaction has been settled, our dashboard will mark it a having a Settled status.

At the API level, the status of a transaction will remain capture_succeeded, and instead we have introduced a few new fields to indicated a transaction is settled.

{
  "type": "transaction",
  "id": "fe26475d-ec3e-4884-9553-f7356683f7f9",
  ...
  "settled_currency": "GBP",
  "settled_amount": 1000,
  "settled": true,
  ...
}

​

Settlement record

Additional information about the settlement you be queries using the GET/transactions/:transaction_id/settlements API. Each settlement record represents an ingested record that matches the transaction in our system. The object contains settlement data pulled from the settlement report. Where available the object will show the transaction cost, settlement currency, the raw report reference and settlement date. The amount stored in the settlement corresponds to the net_credit in the settlement report. This value could, in theory, be zero when a transaction was made for a low amount with a minimum fixed commission.

{
  "items": [
    {
    "unique_id": "b7c1234d-1d15-4596-8dac-ff428959a737",
    "posted_at": "2013-07-16T19:23:00.000+00:00",
    "ingested_at": "2013-07-16T19:23:00.000+00:00",
    "currency": "EUR",
    "amount" :  "1299",
    "exchange_rate": "100",
    "commission": "25",
    "interchange": "",
    "markup": "",
    "scheme_fee": "",
    "payment_service_id": "faaad066-30b4-4997-a438-242b0752d7e1",  
    "payment_service_definition_id": "stripe-card",
    "payment_service_display_name": "Stripe (Main)",
    "payment_service_report_id": "01924d8d-a656-7aa6-a825-9ad2d9712640",
    "payment_service_report_file_ids":  "01924d8e-1408-744d-81df-80540142790e",
    "payment_service_transaction_id":  "pi-3Q0PfDKBcZIIN9aV01gEXVS",
    "transaction_id": "11048b49-993b-4b14-978f-a79c820e1063"
    }
  ],
}