Settlements

List settlements

Settlement records with their period, amounts and status.

GET/v1/settlements

Bearer tokenReturns JSONSuccess 200

netAmount is what is paid to you: the cash collected minus the handling fee and anything netted off.

Request

Headers

Field	Type	Description
`Authorization`required	`string`	The access token from Get token, as "Bearer <token>".

Query parameters

Field	Type	Description
`status`optional	`pending \| processing \| paid \| failed \| on_hold`	Only settlements with this status.
`from`optional	`string`	On or after this time (ISO 8601, UTC).
`to`optional	`string`	On or before this time (ISO 8601, UTC).

Example request

curl -X GET "https://api.swiftazu.com/v1/settlements" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Response

Example response · 200

{
  "settlements": [
    {
      "id": "a1c6f0de-7b53-4b0e-8a39-64f1f3f0b9d4",
      "periodStart": "2026-09-24T00:00:00.000Z",
      "periodEnd": "2026-10-01T00:00:00.000Z",
      "currency": "AED",
      "status": "paid",
      "grossAmount": "1260.00",
      "handlingFee": "25.20",
      "nettedAmount": "0.00",
      "netAmount": "1234.80",
      "paidAt": "2026-10-02T09:00:00.000Z"
    }
  ]
}

Errors

Every call can also return the shared errors listed on the Overview page. Overview