EZezypay

List invoice batches

Changed on

Get a list of invoice batches for a specific merchant. The invoice batches are returned sorted by creation date, with the most recently created invoice appearing first.

get/billing/invoices/batches

Request

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

Query parameters

statusstring

Filter by invoice batch status. Supported values are SUBMITTED

batchReferencestring

Filter by invoice batch reference.

fromstring

Start date for range of invoices to view. Filter by date defined in the invoice date.

untilstring

Apply a limit to the number of objects to be returned. Supported limit range is 1 to 100. Defaults to 10.

limitinteger

To paginate a large result set, use the 'limit' argument to limit the number of results returned per page up to a maximum of 100 records. For example, limit = 10 shows results 1-10. The default returned result would be 100.

cursorstring

An cursor for use in pagination. Specify the number of objects to skip to fetch the next page of objects. For example, limit=10 and cursor=10 will show results for record 11 - 20.

Headers

merchantstring required

Merchant ID

Response

200

Example response

{
  "data": [
    {
      "id": "5c8e8f06-8d59-4957-8761-61b5fb85274b",
      "batchReference": "96025dfa-80e8-40aa-a8a4-4a4b71ad42e4",
      "createdOn": "2019-03-10T20:14:03.928",
      "status": "SUCCESS"
    }
  ],
  "paging": {
    "totalCount": 1
  }
}

Changes