v1

latestOpenAPI 3.1.02026-07-24120106.5 KB

Retrieve A Terminal Invoice

get/billing/terminal/invoices/{invoiceId}

Path parameters

invoiceIdstring required

Auto-generated identifier of the terminal invoice.

Headers

merchantstring required

Merchant ID

Response

200

idstring

{"stackTrail":"paths:/billing/terminal/invoices/{invoiceId}:get:responses:200:content:application/json:schema:properties:creditNoteId","oasType":"schema","type":"unknown"}

documentNumberstring

datestring

dueDatestring

{"stackTrail":"paths:/billing/terminal/invoices/{invoiceId}:get:responses:200:content:application/json:schema:properties:scheduledPaymentDate","oasType":"schema","type":"unknown"}

statusstring

memostring

customerIdstring

{"stackTrail":"paths:/billing/terminal/invoices/{invoiceId}:get:responses:200:content:application/json:schema:properties:subscriptionId","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/billing/terminal/invoices/{invoiceId}:get:responses:200:content:application/json:schema:properties:checkoutId","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/billing/terminal/invoices/{invoiceId}:get:responses:200:content:application/json:schema:properties:subscriptionName","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/billing/terminal/invoices/{invoiceId}:get:responses:200:content:application/json:schema:properties:paymentMethodToken","oasType":"schema","type":"unknown"}

autoPaymentboolean

processingModelstring

{"stackTrail":"paths:/billing/terminal/invoices/{invoiceId}:get:responses:200:content:application/json:schema:properties:transactionSource","oasType":"schema","type":"unknown"}

createdOnstring

{"stackTrail":"paths:/billing/terminal/invoices/{invoiceId}:get:responses:200:content:application/json:schema:properties:payNowUrl","oasType":"schema","type":"unknown"}

channelstring

{"stackTrail":"paths:/billing/terminal/invoices/{invoiceId}:get:responses:200:content:application/json:schema:properties:checkoutResult","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/billing/terminal/invoices/{invoiceId}:get:responses:200:content:application/json:schema:properties:customerFirstName","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/billing/terminal/invoices/{invoiceId}:get:responses:200:content:application/json:schema:properties:customerLastName","oasType":"schema","type":"unknown"}

terminalIdstring

invoiceCategorystring

invoiceSubCategorystring

terminalDeviceNamestring

appPublisherstring

manualRetryPossibleboolean

paymentMethodInvalidboolean

Example response

{
  "id": "9da71a8c-a3fa-41a1-bb5f-80e5690cda04",
  "documentNumber": "IN0000000000000787",
  "date": "2025-08-05",
  "dueDate": "2025-08-05",
  "status": "PAID",
  "memo": "terminal invoice customer payable fee",
  "items": [
    {
      "description": "New Invoice",
      "amount": {
        "currency": "AUD",
        "value": 100
      },
      "tax": {
        "rate": 10
      },
      "id": "58590866-7c9d-4bc5-bb6f-1116b63401e8",
      "type": "on_demand_payment",
      "discounted": {
        "currency": "AUD"
      }
    }
  ],
  "amount": {
    "currency": "AUD",
    "value": 102
  },
  "amountWithoutDiscount": {
    "currency": "AUD",
    "value": 102
  },
  "totalDiscounted": {
    "currency": "AUD"
  },
  "totalRefunded": {
    "currency": "AUD"
  },
  "totalTax": {
    "currency": "AUD",
    "value": 9.27
  },
  "customerId": "c01031c4-c64a-42ee-a42f-e38926ea9cca",
  "paymentMethodData": {
    "type": "TERMINAL",
    "card": {
      "first6": "541333",
      "last4": "9999",
      "accountHolderName": "JohnDoe",
      "type": "MASTERCARD",
      "expiryMonth": "02",
      "expiryYear": "2028"
    },
    "valid": true
  },
  "autoPayment": true,
  "processingModel": "IN_PERSON_PAYMENT",
  "createdOn": "2025-08-05T05:29:14.737",
  "channel": "MOBILE_POINT_OF_SALE",
  "terminalId": "6d07cdfa-6800-42b7-a8b9-554c2b69f7d7",
  "invoiceCategory": "ONE_OFF",
  "invoiceSubCategory": "TERMINAL",
  "terminalDeviceName": "Azizan-test-1",
  "appPublisher": "EZYPAY",
  "manualRetryPossible": true
}