EZezypay

Retrieve an invoice batch

Changed on

Get the full details of an invoice batch.

get/billing/invoices/batches/{invoiceBatchId}

Request

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

Path parameters

invoiceBatchIdstring required

Auto-generated identifier of the invoice batch.

Query parameters

statusstring

Filter by invoice batch item status. Supported values are PENDING, PROCESSING, SUCCESS, FAILED.

cursorinteger

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.

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.

Headers

merchantstring required

Merchant ID

Response

200

idstring
batchReferencestring
createdOnstring
statusstring

Example response

{
  "id": "5c8e8f06-8d59-4957-8761-61b5fb85274b",
  "batchReference": "96025dfa-80e8-40aa-a8a4-4a4b71ad42e4",
  "createdOn": "2019-03-10T20:14:03.928",
  "status": "SUCCESS",
  "invoiceBatchItemList": {
    "data": [
      {
        "id": "67d6a27d-7783-450b-8848-bf033f62ac14",
        "externalInvoiceId": "355b5139-78f4-436e-b7f3-4b04ac7bafec",
        "invoiceId": "8928cd56-6331-405d-aef7-ff4ad2becea6",
        "status": "SUCCESS",
        "processingResult": "Invoice successfully created",
        "createdOn": "2019-03-10T20:14:04.000"
      }
    ],
    "paging": {
      "totalCount": 5
    }
  }
}

Changes