EZezypay

Retrieve collected next settlement amount

Changed on

Retrieves the collected amount till date.

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

Path parameters

merchantIdstring required

Merchant ID

Headers

merchantstring required

Merchant ID

Response

200

idstring
numberstring
legalNamestring
namestring

Example response

{
  "id": "d88a4910-072e-4228-8e92-8e93dbbc6732",
  "number": "65698",
  "legalName": "mfe NameNZ",
  "name": "mfe EVAtest1",
  "settlementScheduleDTO": {
    "intervalUnit": "DAY",
    "interval": 1,
    "nextSettlementDate": "2019-05-18",
    "lastSettlementDate": "2019-05-17"
  },
  "amount": {
    "currency": "NZD",
    "value": 483.4,
    "type": "FIXED_AMOUNT"
  }
}

Changes