Skip to main content
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. A similar process occurs for transaction modifications, such as refunds or chargebacks. Once the funds have been settled by a payment service, the settlement reports are imported and reconciled. Those entries are matched against the corresponding system records (transactions, refunds). A system record is marked as settled by matching the imported settlement entries using the reconciliation_id, and any fees are attached to the matching record. See more about the ingestion and scheduling of the settlement reports in the settlement reporting section.

Settled status

Once a record has been settled, the dashboard marks it as having a Settled status. At the API level, the status of a record does not change, and instead a few new fields are introduced to indicate a record is settled. An example of a settled transaction:

Settlement record

Additional information about the settlements can be queried using the following API endpoints: Each settlement record represents an imported record that matches the record in the system. The object contains settlement data pulled from the settlement report. Where available the object shows the 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. An example of a transaction settlement: