Transactions History

For get transactions history list, the getTransactionList method of the library should be called. This function is used to get all transaction through the library.

This function supports pagenation. The page value must be 0 for the first request and it must be incremented for each page until reacing the total pages.

• startDate and endDate must be in 'dd-MM-YYYY' format

• direction can be "DESC" or "ASC". The default value is "DESC".

PayContactlessEmbed.getInstance().getTransactionList(
    page: Int,
    size: Int?,
    direction: String?,
    transactionCode: String?,
    startDate: String?,
    endDate: String?,
    startAmount: Int?,
    endAmount: Int?,
    listener: TransactionListListener
)

Method Parameters

Field Name	Data Type	Required	Description
page	Int	true	Page number to retrieve (starting from 0 or 1 based on backend configuration).
size	Int	false	Number of transactions per page. If null, the backend default page size is used.
direction	String	false	Transaction direction filter (e.g., SALE, REFUND).
transactionCode	String	false	Filters transactions by a specific transaction reference code.
startDate	String	false	Start date for filtering transactions (format: yyyy-MM-dd or as defined by backend).
endDate	String	false	End date for filtering transactions (format: yyyy-MM-dd or as defined by backend).
startAmount	Int	false	Minimum transaction amount filter (inclusive).
endAmount	Int	false	Maximum transaction amount filter (inclusive).
listener	TransactionListListener	true	Callback interface used to receive the transaction list or error response.

Transaction List Listener

public interface TransactionListListener {
    void onSuccess(TransactionList transactionList);
    void onFailure(Error error);
}

Transaction List Data

data class TransactionList (
    var transactions: List<TransactionInfo>? = null
    var empty: Boolean? = null
    var first: Boolean? = null
    var last: Boolean? = null
    var number: Integer? = null
    var numberOfElements: Integer? = null
    var size: Integer? = null
    var totalElements: Integer? = null
    var totalPages: Integer? = null
)

Field Names	Descriptions	Sample Values
transactions	list of transactions	Check Transaction Info Data section belo.
empty	is transaction list empty	false
first	is the first page of the transaction list	true
last	is the first page of the transaction list	false
number	current page number of the transcation list	0
numberOfElements	number of the element on the current page	10
totalElements	total number of the elements in the history	476
totalPages	total pages of the history	48

Transaction Info Data

data class TransactionList (
    var id: Long? = null
    var transactionCode: String? = null
    var cardNumber: String? = null
    var amount: Double? = null
    var currency: String? = null
    var dateTime: String? = null
    var status: String? = null
    var modeOfTransaction: String? = null
)

Field Names	Descriptions	Sample Values
id	a unique id of the transcation	'29481'
transactionCode	a unique code of the transaction. It is used for finding the transaction.	'3FFBA7849A383BEB'
cardNumber	masked pan of the card using in the transaction	'471688******6375'
amount	using amount value in the transaction	'8.00'
currency	using currency value in the transaction	'₦'
dateTime	transaction date time	'14-09-2023 11:18:28'
status	status info of the transaction	'SUCCESS' or 'FAILED'
modeOfTransaction	paymet method using in the transaction	'CARD', 'PAY_WITH_LINK', 'PAY_WITH_ACCOUNT'