EZezypay

Create an invoice batch

Changed on

Create a batch of ad-hoc invoices to bill one or more customers on an on-demand basis. Invoices created from this end point are not associated to any subscriptions.

post/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

Headers

merchantstring required

Merchant ID

Request body

batchReferencestring required

The merchant reference for the invoice batch. This must be unique. It is recommended that this is alphanumeric only with the exception of hyphen (-) and underscore (_)

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": "SUBMITTED"
}

Changes