API documentation

Everything you need to integrate with the Gini v2 Third-Party API.

Getting started API reference Store API Finance API Settings API Insights API Wholesale API Resources

Finance API

Settlements

List your settlement batches and read any one in full, including the transactions it settled — the same data as the dashboard's Settlements screen. Read-only.

List settlements

Your settlement batches, newest first, each with its gross, fee and net. Paginated.

GET /api/v2.0/third-party/settlements

Signed

Query parameters

Field	Type	Required	Description
`types`	array	Optional	Filter by rail — any of Cash, aqsati, epay. Repeat as types[]=aqsati&types[]=epay.
`from`	string	Optional	Start date (YYYY-MM-DD), inclusive, on the settlement date.
`to`	string	Optional	End date (YYYY-MM-DD), inclusive.
`per_page`	integer	Optional	1–100, default 15.

Response

{
    "data": [
        {
            "id": 12,
            "uuid": "9b1c…",
            "type": "epay",
            "date": "2026-09-01",
            "amount": "500000.00",
            "fee": "25000.00",
            "client_discount": "25000.00",
            "client_amount_with_discount": "475000.00",
            "transactions_count": 40,
            "debt_payments_count": 1,
            "debt_deducted": 10000
        }
    ],
    "links": [],
    "meta": []
}

Notes

type is Cash, aqsati or epay.
amount is the gross; client_amount_with_discount is the net that landed; client_discount is the fee.
debt_deducted and debt_payments_count report debt recovered from this settlement.

Get a settlement

One settlement with its transactions.

GET /api/v2.0/third-party/settlements/{settlement}

Signed

Response

{
    "data": {
        "id": 12,
        "uuid": "9b1c…",
        "type": "epay",
        "date": "2026-09-01",
        "amount": "500000.00",
        "client_amount_with_discount": "475000.00",
        "transactions": [
            {
                "id": 900,
                "order_id": 700,
                "amount": "12500.00",
                "fee": "625.00",
                "client_amount_with_discount": "11875.00",
                "is_paid": true
            }
        ]
    }
}

Notes

A settlement that is not yours returns HTTP 404 — ids are never resolved unscoped.

Settlement stats

Aggregate figures for the same filter set — count, gross, net and the derived fee. Accepts the same types/from/to parameters as the list.

GET /api/v2.0/third-party/settlements/stats

Signed

Notes

fee is derived as gross − net, so gross = fee + net exactly (matches the dashboard header).

Export a settlement

Queue an .xlsx of one settlement's transactions. Returns 202; you are notified when the file is ready, and that completion notification is itself readable through the Notifications endpoint.

POST /api/v2.0/third-party/settlements/{settlement}/export

Signed

Export filtered settlements

Queue one .xlsx of every transaction across the settlements matching a rail + date filter. Accepts the same types/from/to as the list. Returns 202; you are notified when it is ready.

The file has two sheets. Settled is the filtered settlement transactions. Not paid out yet is money collected from customers that has not been batched into a settlement — it honours the rail filter but ignores from/to, which filter settlement dates these rows do not have.

POST /api/v2.0/third-party/settlements/export

Signed

Previous Operators Next Debts