Retrieve a settlement

Request

Retrieve a single settlement by its ID.

Required scope: settlement:read

Security

accountId and apiKey

Path

idstring, (uuid)required

The unique identifier of the settlement to retrieve.

curl -i -X GET \
  'https://api.test.easypay.pt/2.0/settlement/{id}' \
  -H 'AccountId: 2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6' \
  -H 'ApiKey: eae4aa59-8e5b-4ec2-887d-b02768481a92'

Responses

Successful response with a settlement

Bodyapplication/json

idstring, (uuid)required

Unique identifier for the settlement.

Example:"f6a7b8c9-d0e1-2345-fabc-456789012306"

created_atstring, (date-time)required

Timestamp when the settlement was created. Always present.

Example:"2026-02-05T09:30:00Z"

updated_atstring or null, (date-time)required

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

Example:"2025-10-01T00:00:00Z"

namestringrequired

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

Example:"1006"

descriptionstringrequired

Human-readable description of the settlement.

Example:"EASYPAY-1977225-42185-161-998590696"

statusstringrequired

Current status of the settlement.

Enum:"IN_TRANSIT""SUCCEEDED""FAILED"

Example:"IN_TRANSIT"

total_amountobject(Money)required

Total amount of the settlement

number_of_itemsintegerrequired

Number of transactions included in the settlement.

Example:2

destinationobjectrequired

Where the settled funds are sent.

Response

{
  "id": "e5f6a7b8-c9d0-1234-efab-345678901205",
  "created_at": "2026-02-01T11:00:00Z",
  "updated_at": null,
  "name": "1005",
  "description": "EASYPAY-5-8895-1005-CIN002",
  "status": "SUCCEEDED",
  "total_amount": {
    "currency": "EUR",
    "amount": "320.75"
  },
  "number_of_items": 7,
  "destination": {
    "type": "IBAN",
    "details": { … }
  }
}