Upgraded version from the previous api.
Contains invoice information and related notification information (such as email or sms delivery reports)
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.
| Parameter | Description | Example |
|---|---|---|
| batchId | Batch number identifier | 50 |
Api response contains the total number of record and the details of each invoice in the following format
{
count: 2
data [ ... ]
}
Described below are the invoice object details:
| Name | Description | Example |
|---|---|---|
| invoiceId | Invoice identification number | 190 |
| batchId | Batch identifier number | 50 |
| accountName | Account name related to the invoice. | John Doe |
| accountNumber | Account number related to the invoice. | ABCD1234567 |
| invoiceAmount | Amount requested (in dollars) from the invoice | 123.88 |
| invoiceStatus | Current status of the invoice | paid, partially_paid, not_paid, registered, refunded, partially_refunded |
| url | Invoice unique url | https://pay.gliderpay.com/6VBJJV |
| expirationDate | Invoice Expiry time | 2023-12-06 22:15:05 |
| visits | Number of visit events | 4 |
| lastVisit | Date time of the last invoice visit event | 2017-11-14 01:35:33 |
| transactions | Number of transaction | 2 |
| approvedTransactions | Number of approved transactions | 1 |
| declinedTransactions | Number of declined transactions | 1 |
| lastTransaction | Date time of the last recorded transaction | 2017-11-14 01:40:33 |
| totalTransactionsAmount | Total amount of the last transaction | 94 |
| receiptEmail | Captured email address from a receipt request | [email protected] |
| receiptDate | Date of the captured email address from a receipt request | 2023-12-06 22:15:05 |
| handler | Agent ID to be stored for reporting as part of the campaign | Agent1 |
| planAmount | (if instalment) user amount plan selection | 800.00 |
| planFrequency | (if instalment) user frequency plan selection | weekly |
| planStartDate | (if instalment) user start date plan selection | 2023-10-10 |
| planRate | Plan interest rate | 1.5 |
| planMaxTerm | Plan maximum term | 1 |
| planMaxTermPeriod | Plan maximum term period (year, month, day) | year |
| customLabel1 | Invoice custom label 1 | `` |
| customValue1 | Invoice custom value 1 | `` |
| customLabel2 | Invoice custom label 2 | `` |
| customValue2 | Invoice custom value 2 | `` |
| customLabel3 | Invoice custom label 3 | `` |
| customValue3 | Invoice custom value 3 | `` |
| contact | Recipient contact details (email address, mobile number or empty for link channel) | +61432555666 |
| notificationSent | Timestamp on when the invoice notification has been sent | 2023-12-06 22:15:05 |
| notificationUpdate | Timestamp on when the invoice notification status has been updated | 2023-12-06 22:15:05 |
| notificationStatus | Invoice notification status (more info below) | delivered |
| providerStatus | SMS or EMAIL gateway provider status | Delivered |
Notification delivery report
Generally, a "delivery report" event for both email and sms should arrive shortly after the notification
is sent, typically within a few minutes.
To have a more comprehensive report, it's advisable to check at least 15-30 minutes after the campaign scheduled time (end time if throttling is enabled).
Notification that left the gateway provider server but do not have received a final disposition from the
recipient server are marked as "sent".
Normally, if after 72 hours there is no status update, it's unlikely that the status will change, and you might consider them as inconclusive.
Notification Statuses
| Name | Description |
|---|---|
| sent | the gateway has sent the notification but it has not received a delivery acknowledgment yet |
| delivered | the notification has been delivered to the recipient |
| queued | the notification hasn't been sent yet due to scheduling or high traffic demands |
| bounced | the notification cannot reach the recipient (e.g.: email or sms recipient incorrect, not active, ...) |