API reference

Given a date range (start and end date time) returns the list of all the transactions that have been processed within the date range

Start and end date must be in the following format YYYY-MM-DD and they will be compared with the transaction processing 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 contains the total number of record and the details of each transaction in the following format

{ 
    count: 2
    data [ ... ]
}

Described below are the transaction object details:

NameDescriptionExample
idTransaction number identifier55
invoiceIdInvoice number identifier142
batchIdInvoice number identifier63
amountTotal amount (in dollars) of approved payment transactions120.55
createdAtInvoice creation time2023-10-10 00:30:00
transactionStatusStatus of the transaction (succeed, refunded, declined)declined
accountNumberAccount number related to the invoiceBLLG123456
invoiceAmountAmount requested from the invoice120.55
invoiceDateDatetime when the invoice has been processed2017-11-13 01:49:51
mobileNumberContact number linked to the invoice+61432555XXX
handlerAgent ID to be stored for reporting as part of the campaigntest
receiptHashadditional transaction identifier6DJA08WqQG
referencereference number from the payment gateway234343
errorError message in case of declined transactionCard not valid
cardBrandCredit card brandvisa
cardExpMCredit card expiry month09
cardExpYCredit card expiry year23
cardTruncatedCredit card last 4 digits3224
cardHolderNameCredit card holder name (if enabled in the customer configuration)John Doe
payment_methodTransaction payment method can be either direct debit (bank) or credit card (cc)bank
bank_account_nameDirect debit account nameDanilo Massaro
bank_bsbDirect debit account name089902
bank_account_numberDirect debit account number123456
agreementIdPay To agreement IDabcdef1234567890
payIdPayTo Pay Id payer[email protected]
Language
Authorization
OAuth2
Click Try It! to start a request and see the response here!