Transactions API
View and filter transaction history including purchases, withdrawals, refunds, and transfers.
Base:
/v1/QuickPayTransferDtoEndpoints
GET
/v1/QuickPayTransferDtoList Transactions
Retrieve transactions with OData filtering. Transactions represent completed financial movements including purchases, withdrawals, refunds, and transfers.
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| $filter | string | Optional | e.g. transactionType eq 'Purchase' and status eq 'Completed' |
| $orderby | string | Optional | Sort order |
| $top | number | Optional | Page size |
| $skip | number | Optional | Offset |
| $select | string | Optional | Fields to include |
Enums
TransactionType (Card)
Purchase
Withdrawal
Refund
Reversal
BalanceInquiry
Transfer
TransactionType (QuickPay)
PurchaseVoucher
RedeemVoucher
Recharge
CashIn
Purchase
Reversal
Topup
Refund
Withdraw
Deposit
Transfer
BankTransfer
BatchPayment
MerchantSettlement
Fee
BillPayment
TransactionStatus (Card)
Pending
Approved
Declined
Reversed
Settled
Failed
TransactionStatus (QuickPay)
Completed
Authorized
Processing
Reversed
OnHold
Refunded
PendingReversal
Failed
UnableToReverse
ReversalFailed
Usage Examples
List recent transactions
TypeScript
const { data } = await client.get('/v1/QuickPayTransferDto', {
params: {
$filter: "transactionType eq 'Purchase'",
$orderby: 'createdDateTime desc',
$top: 20,
$select: 'id,amount,currency,transactionType,status,createdDateTime',
},
});
data.value.forEach((tx) => {
console.log(`${tx.transactionType}: ${tx.amount} ${tx.currency} — ${tx.status}`);
});