API reference

Returns the list of all the processed invoices for a single batch.

A batch number identifier must be specified in the API request, this can be obtained
while creating a new Glider Batch or from a separate Report API.

ParameterDescriptionExample
batchIdBatch number identifier50

The API response returns an array of invoices objects of which their values are described below:

NameDescriptionExample
invoiceIdInvoice identification number190
batchIdBatch identifier number50
accountNumberAccount number related to the invoice.ABCD1234567
invoiceAmountAmount requested (in dollars) from the invoice123.88
invoiceStatusCurrent status of the invoicepaid, partially_paid, not_paid, registered, refunded, partially_refunded
urlInvoice unique urlhttps://pay.gliderpay.com/6VBJJV
smsStatus[DEPRECATED] Status of the SMSnull
smsUpdateDate[DEPRECATED] Date time of the last sms status update eventnull
visitsNumber of visit events4
lastVisitDate time of the last invoice visit event2017-11-14 01:35:33
transactionsNumber of transaction2
approvedTransactionsNumber of approved transactions1
declinedTransactionsNumber of declined transactions1
lastTransactionDate time of the last recorded transaction2017-11-14 01:40:33
totalTransactionsAmountTotal amount of the last transaction94
emailCaptured email address from a receipt request[email protected]
mobileNumberRecipient contact details (email address, mobile number or empty for link channel)+61432555666
receiptDateDate time of a receipt request2017-11-14 01:45:33
handlerAgent ID to be stored for reporting as part of the campaignAgent1
Language
Click Try It! to start a request and see the response here!