Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.gr4vy.com/llms.txt

Use this file to discover all available pages before exploring further.

After a transaction has been captured (either through a direct sale or separate authorization and capture), a payment service likely proceeds with clearing the payments, after which they settle the funds to an account. Once the funds have been settled by a payment service, the settlement reports are imported and reconciled. Those entries are matched against the transactions in the system. Any transaction is marked as settled by matching the imported transaction level data to the transactions in the system using the reconciliation_id, and any fees are attached 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, the dashboard marks it as having a Settled status. At the API level, the status of a transaction remains capture_succeeded, and instead a few new fields are introduced to indicate 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 settlements can be queried using the GET/transactions/:transaction_id/settlements API. Each settlement record represents an imported record that matches the transaction in the system. The object contains settlement data pulled from the settlement report. Where available the object shows 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": [
    {
      "type": "settlement"
      "id": "f9261931-283f-4332-9e47-f6cfa6751cda",
      "merchant_account_id": "default",
      "created_at": "2025-09-20T03:04:55.000+00:00",
      "updated_at": "2025-09-20T03:04:55.000+00:00",
      "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": 1.2,
      "commission": 25,
      "interchange": null,
      "markup": null,
      "scheme_fee": null,
      "payment_service_report_id": "01924d8d-a656-7aa6-a825-9ad2d9712640",
      "payment_service_report_file_ids": [
        "01924d8e-1408-744d-81df-80540142790e"
      ],
      "transaction_id": "11048b49-993b-4b14-978f-a79c820e1063"
    }
  ]
}