v1

latestOpenAPI 3.1.0MIT2026-08-0659118508.8 KB

Settlements

Retrieve a settlement

Retrieve a single settlement by its ID.

Required scope: <code style="background:#e8f0fe;color:#1a73e8;padding:2px 8px;border-radius:12px;font-size:0.85em">settlement:read</code>

get/settlement/{id}

Path parameters

idstring uuid required

The unique identifier of the settlement to retrieve.

Response

Successful response with a settlement

idstring uuid required

Unique identifier for the settlement.

created_atstring date-time required

Timestamp when the settlement was created. Always present.

updated_atstring date-time nullable required

Timestamp when the settlement was last updated, or null when it has never been updated.

namestring required

Human-readable name of the settlement (its batch reference).

descriptionstring required

Human-readable description of the settlement.

status'IN_TRANSIT' | 'SUCCEEDED' | 'FAILED' required

Current status of the settlement.

number_of_itemsinteger required

Number of transactions included in the settlement.

Example response

{
  "id": "f6a7b8c9-d0e1-2345-fabc-456789012306",
  "created_at": "2026-02-05T09:30:00Z",
  "updated_at": "2025-10-01T00:00:00Z",
  "name": "1006",
  "description": "EASYPAY-1977225-42185-161-998590696",
  "status": "IN_TRANSIT",
  "total_amount": {
    "amount": 0.12,
    "currency": "EUR"
  },
  "number_of_items": 2,
  "destination": {
    "type": "IBAN",
    "details": {
      "iban": "PT50007974951304464003280"
    }
  }
}