---
title: "List settlements"
method: GET
path: "/billing/settlements"
---

# List settlements

`GET /billing/settlements`

## Request

- Base URL: `https://api-sandbox.ezypay.com/v2`
- URL: `https://api-sandbox.ezypay.com/v2/billing/settlements`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://identity-sandbox.ezypay.com/token`

Retrieve a list of settlements and filter the results using the available options.

## Query parameters

- `from` string
- `until` string
- `limit` integer
- `cursor` string

## Request body

- object
  - `merchant` string, required: Merchant ID

## Response `200`

200

- object
  - `data` object[]
    - `number` string
    - `date` string
    - `revenue` object
      - `currency` string
      - `value` number
      - `type` unknown
    - `deduction` object
      - `currency` string
      - `value` number
      - `type` unknown
    - `amount` object
      - `currency` string
      - `value` number
      - `type` unknown
    - `settlementPayoutMethod` object
      - `id` unknown
      - `paymentMethodToken` string
      - `bank` object
        - `accountHolderName` string
        - `last4` string
        - `bankNumber` string
        - `branchNumber` unknown
        - `suffixNumber` unknown
    - `status` string
    - `failedSettlementReason` object
      - `code` string
      - `description` string
    - `createdOn` string
  - `paging` object
    - `nextUrl` unknown
    - `nextCursor` integer
    - `limit` integer
    - `totalCount` integer

## Other responses

- `400`: 400

## Changes

- **2026-11-03** `924be4030f56`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/ezypay/apis/vault/changes/billing/settlements/get.md)

---

[API](https://skmtc.dev/ezypay/apis/vault.md) - [All operations](https://skmtc.dev/ezypay/apis/vault/llms.txt) - [OpenAPI document](https://skmtc.dev/ezypay/apis/vault/revisions/924be4030f56?raw)