Create A Terminal Invoice

post

https://api-sandbox.ezypay.com/v2/billing/terminal/invoices

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Create an ad-hoc terminal invoice to bill a customer on an on-demand basis. Invoices created from this end point are not associated to any subscriptions. When creating the invoice using API, the invoice status will be first
PENDING_TERMINAL_PAYMENT, only after the payment attempted it will become other status.

Body Params

terminalId

string

required

memo

string

Description of the invoice item. Max of 100 characters.

items

array of objects

required

Details of the individual items that are included in the invoice.

items*

autoPayment

boolean

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.

externalInvoiceId

string

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

customerId

string

Identifier of the customer the invoice is billed to.

Headers

merchantId

string

required

Merchant ID

Responses

Language

Loading…

Response

Choose an example:

application/json

200200

400400