API reference

Given a date range (start and end date time) return the aggregate overall reports of all the batches that have been uploaded within the date range.

Start and end date must be in the following format YYYY-MM-DD and they will be compared with the batch creation time. All dates are in UTC timezone.

ParameterDescriptionExample
startDateInitial date where the query will start2017-10-10
endDateFinal date where the query will end2017-11-11

API response values are described in the table below:

NameDescriptionExample
batchesNumber of Batches processed50
noOfInvoicesTotal number of invoices3
approvedInvoicesTotal number of approved invoices2
rejectedInvoicesTotal number of rejected invoices1
totalAmountTotal amount (in dollars) of approved invoices615.08
smsSent[DEPRECATED] Total amount of sms sentnull
smsDelivered[DEPRECATED] Total amount of sms deliverednull
smsFailed[DEPRECATED] Total amount of sms failednull
smsPending[DEPRECATED] Total amount of sms pendingnull
approvedPaymentsTotal amount of approved transaction1
declinedPaymentsTotal amount of declined payments0
paymentAmountTotal amount (in dollar) of approved transactions200.00
receiptsTotal amount of requested receipts from the end-user1
Language
Authorization
OAuth2
Click Try It! to start a request and see the response here!