---
title: "Retrieve collected next settlement amount"
method: GET
path: "/billing/merchant/nextSettlement/{merchantId}"
---

# Retrieve collected next settlement amount

`GET /billing/merchant/nextSettlement/{merchantId}`

## Request

- Base URL: `https://api-sandbox.ezypay.com/v2`
- URL: `https://api-sandbox.ezypay.com/v2/billing/merchant/nextSettlement/{merchantId}`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://identity-sandbox.ezypay.com/token`

Retrieves the collected amount till date.

## Path parameters

- `merchantId` string, required

## Headers

- `merchant` string, required

## Response `200`

200

- object
  - `id` string
  - `number` string
  - `legalName` string
  - `name` string
  - `settlementScheduleDTO` object
    - `intervalUnit` string
    - `interval` integer
    - `nextSettlementDate` string
    - `lastSettlementDate` string
  - `amount` object
    - `currency` string
    - `value` number
    - `type` string

## Other responses

- `400`: 400

## Changes

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

[Operation history](https://skmtc.dev/ezypay/apis/vault/changes/billing/merchant/nextSettlement/:merchantId/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)