---
updatedAt: 2025-11-13T21:59:37.000Z
agentTools:
  projectIndex: https://developer.ezypay.com/llms.txt
---

# Retrieve collected next settlement amount

Retrieves the collected amount till date.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "billing",
    "version": "2.1.0"
  },
  "servers": [
    {
      "url": "https://api-sandbox.ezypay.com/v2"
    }
  ],
  "security": [
    {}
  ],
  "paths": {
    "/billing/merchant/nextSettlement/{merchantId}": {
      "get": {
        "summary": "Retrieve collected next settlement amount",
        "description": "Retrieves the collected amount till date.",
        "operationId": "retrieve-collected-next-settlement-amount",
        "parameters": [
          {
            "name": "merchant",
            "in": "header",
            "description": "Merchant ID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "merchantId",
            "in": "path",
            "description": "Merchant ID",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"id\": \"d88a4910-072e-4228-8e92-8e93dbbc6732\",\n    \"number\": \"65698\",\n    \"legalName\": \"mfe NameNZ\",\n    \"name\": \"mfe EVAtest1\",\n    \"settlementScheduleDTO\": {\n        \"intervalUnit\": \"DAY\",\n        \"interval\": 1,\n        \"nextSettlementDate\": \"2019-05-18\",\n        \"lastSettlementDate\": \"2019-05-17\"\n    },\n    \"amount\": {\n        \"currency\": \"NZD\",\n        \"value\": 483.4,\n        \"type\": \"FIXED_AMOUNT\"\n    }\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string",
                      "example": "d88a4910-072e-4228-8e92-8e93dbbc6732"
                    },
                    "number": {
                      "type": "string",
                      "example": "65698"
                    },
                    "legalName": {
                      "type": "string",
                      "example": "mfe NameNZ"
                    },
                    "name": {
                      "type": "string",
                      "example": "mfe EVAtest1"
                    },
                    "settlementScheduleDTO": {
                      "type": "object",
                      "properties": {
                        "intervalUnit": {
                          "type": "string",
                          "example": "DAY"
                        },
                        "interval": {
                          "type": "integer",
                          "example": 1,
                          "default": 0
                        },
                        "nextSettlementDate": {
                          "type": "string",
                          "example": "2019-05-18"
                        },
                        "lastSettlementDate": {
                          "type": "string",
                          "example": "2019-05-17"
                        }
                      }
                    },
                    "amount": {
                      "type": "object",
                      "properties": {
                        "currency": {
                          "type": "string",
                          "example": "NZD"
                        },
                        "value": {
                          "type": "number",
                          "example": 483.4,
                          "default": 0
                        },
                        "type": {
                          "type": "string",
                          "example": "FIXED_AMOUNT"
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": false,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```