EZezypay

Create A Terminal Invoice

Changed on
post/billing/terminal/invoices

Request

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

Headers

merchantstring required

Merchant ID

Request body

terminalIdstring required
memostring

Description of the invoice item. Max of 100 characters.

autoPaymentboolean

Determines if auto payment processing occurs for invoices generated from the subscription. Supported value are: true - Default value. Invoices generated will automatically proceed to payment processing. false - Invoices are generated but will not automatically proceed to payment processing.

externalInvoiceIdstring

An invoice id from integrator's system that works as a correlation id with the invoice from Ezypay's system, which helps to identify the invoice. It should be unique per merchant

customerIdstring

Identifier of the customer the invoice is billed to.

Response

200

idstring
creditNoteIdunknown
documentNumberstring
datestring
dueDatestring
scheduledPaymentDateunknown
statusstring
memostring
customerIdunknown
subscriptionIdunknown
checkoutIdunknown
subscriptionNameunknown
paymentMethodTokenunknown
paymentMethodDataunknown
autoPaymentboolean
processingModelstring
transactionSourceunknown
createdOnstring
payNowUrlunknown
channelstring
checkoutResultunknown
customerFirstNameunknown
customerLastNameunknown
terminalIdstring
invoiceCategorystring
invoiceSubCategorystring

Example response

{
  "id": "c911a6ca-8318-45b7-a165-a955c053448a",
  "documentNumber": "IN0000000000000998",
  "date": "2025-10-07",
  "dueDate": "2025-10-07",
  "status": "PENDING_TERMINAL_PAYMENT",
  "memo": "this is a test invoice for tap to pay",
  "items": [
    {
      "description": "this is a test invoice for tap to pay",
      "amount": {
        "currency": "AUD",
        "value": 10
      },
      "id": "d71a77a1-bdda-488a-90b6-b1d9e3670b3f",
      "type": "on_demand_payment",
      "discounted": {
        "currency": "AUD"
      }
    }
  ],
  "amount": {
    "currency": "AUD",
    "value": 15
  },
  "amountWithoutDiscount": {
    "currency": "AUD",
    "value": 15
  },
  "totalDiscounted": {
    "currency": "AUD"
  },
  "totalRefunded": {
    "currency": "AUD"
  },
  "totalTax": {
    "currency": "AUD",
    "value": 0.45
  },
  "processingModel": "IN_PERSON_PAYMENT",
  "createdOn": "2025-10-07T06:38:39.674",
  "channel": "MOBILE_POINT_OF_SALE",
  "terminalId": "0dea8104-02cd-4931-bca0-ea34bb7eac8b",
  "invoiceCategory": "ONE_OFF",
  "invoiceSubCategory": "TERMINAL"
}

Changes

  • 924be4030f56Revision changes
    • breaking

      added the new required header request parameter merchant

    • warning

      deleted the header request parameter authorization

    • warning

      deleted the header request parameter merchantId