@mbanq/core-sdk-js / commands / GetRecentTransactions
Function: GetRecentTransactions()
GetRecentTransactions(
savingsId,data?):Command<{data?: {cardId?:number[];endDate?:string;limit?:number;offset?:number;orderBy?:"transactionAmount"|"createdAt"|"submittedOnDate"|"bookingDate"|"transactionDate";reference?:string;sortOrder?:"ASC"|"DESC";startDate?:string;status?:string[];subTransactionType?:SubTransactionType[];transactionType?: (INVALID|DEPOSIT|WITHDRAWAL|INTEREST_POSTING|WITHDRAWAL_FEE|ANNUAL_FEE|WAIVE_CHARGES|PAY_CHARGE|DIVIDEND_PAYOUT|INITIATE_TRANSFER|APPROVE_TRANSFER|WITHDRAW_TRANSFER|REJECT_TRANSFER|WRITTEN_OFF|OVERDRAFT_INTEREST|WITHHOLD_TAX|ESCHEAT|AMOUNT_HOLD|AMOUNT_RELEASE|INTEREST_PAYABLE_ACCRUED|OVERDRAFT_INTEREST_RECEIVABLE_ACCRUED|PAY_CHARGE_REVERSAL|FUNDS_ALLOCATION|FUNDS_DEALLOCATION|CHARGE_BACK|OVERDRAFT_WITHDRAWAL_FEE|PREAUTH|AUTH|ATM|CASH_ADVANCE|BALANCE_INQUIRY|MERCHANT_CREDIT|ADJUSTMENT|PAYMENT|TOKENIZATION|AVS|QUASI_CASH|INVALID|HOLD_AMOUNT|RELEASE_AMOUNT|UPDATE_AMOUNT|MERCHANT_CREDIT_AMOUNT|PAYMENT_AMOUNT|PENDING_CREDIT|QUASI_CASH|HOLD_FOR_FUND_ALLOCATION|RELEASE_FOR_FUND_DEALLOCATION|PENDING_DEBIT)[];type?:string[]; };savingsId:number|number[]; }, {pageItems:object[];totalFilteredRecords:number; }>
Defined in: src/commands/rest/transaction.ts:300
Retrieves recent transactions for a specific savings account.
Use this API to retrieve the recent transactions with their status, including Completed, Pending, and Rejected. This unified endpoint returns transactions with card-related information when applicable.
Pass the account ID to get the transaction details.
Retrieves a list of recent transactions with their status, including Completed, Pending, and Rejected.
Parameters
savingsId
number
The ID associated with the account (Example: 101)
data?
cardId?
number[] = ...
endDate?
string = ...
limit?
number = ...
offset?
number = ...
orderBy?
"transactionAmount" | "createdAt" | "submittedOnDate" | "bookingDate" | "transactionDate" = ...
reference?
string = ...
sortOrder?
"ASC" | "DESC" = ...
startDate?
string = ...
status?
string[] = ...
subTransactionType?
SubTransactionType[] = ...
transactionType?
(INVALID | DEPOSIT | WITHDRAWAL | INTEREST_POSTING | WITHDRAWAL_FEE | ANNUAL_FEE | WAIVE_CHARGES | PAY_CHARGE | DIVIDEND_PAYOUT | INITIATE_TRANSFER | APPROVE_TRANSFER | WITHDRAW_TRANSFER | REJECT_TRANSFER | WRITTEN_OFF | OVERDRAFT_INTEREST | WITHHOLD_TAX | ESCHEAT | AMOUNT_HOLD | AMOUNT_RELEASE | INTEREST_PAYABLE_ACCRUED | OVERDRAFT_INTEREST_RECEIVABLE_ACCRUED | PAY_CHARGE_REVERSAL | FUNDS_ALLOCATION | FUNDS_DEALLOCATION | CHARGE_BACK | OVERDRAFT_WITHDRAWAL_FEE | PREAUTH | AUTH | ATM | CASH_ADVANCE | BALANCE_INQUIRY | MERCHANT_CREDIT | ADJUSTMENT | PAYMENT | TOKENIZATION | AVS | QUASI_CASH | INVALID | HOLD_AMOUNT | RELEASE_AMOUNT | UPDATE_AMOUNT | MERCHANT_CREDIT_AMOUNT | PAYMENT_AMOUNT | PENDING_CREDIT | QUASI_CASH | HOLD_FOR_FUND_ALLOCATION | RELEASE_FOR_FUND_DEALLOCATION | PENDING_DEBIT)[] = ...
type?
string[] = ...
Returns
Command<{ data?: { cardId?: number[]; endDate?: string; limit?: number; offset?: number; orderBy?: "transactionAmount" | "createdAt" | "submittedOnDate" | "bookingDate" | "transactionDate"; reference?: string; sortOrder?: "ASC" | "DESC"; startDate?: string; status?: string[]; subTransactionType?: SubTransactionType[]; transactionType?: (INVALID | DEPOSIT | WITHDRAWAL | INTEREST_POSTING | WITHDRAWAL_FEE | ANNUAL_FEE | WAIVE_CHARGES | PAY_CHARGE | DIVIDEND_PAYOUT | INITIATE_TRANSFER | APPROVE_TRANSFER | WITHDRAW_TRANSFER | REJECT_TRANSFER | WRITTEN_OFF | OVERDRAFT_INTEREST | WITHHOLD_TAX | ESCHEAT | AMOUNT_HOLD | AMOUNT_RELEASE | INTEREST_PAYABLE_ACCRUED | OVERDRAFT_INTEREST_RECEIVABLE_ACCRUED | PAY_CHARGE_REVERSAL | FUNDS_ALLOCATION | FUNDS_DEALLOCATION | CHARGE_BACK | OVERDRAFT_WITHDRAWAL_FEE | PREAUTH | AUTH | ATM | CASH_ADVANCE | BALANCE_INQUIRY | MERCHANT_CREDIT | ADJUSTMENT | PAYMENT | TOKENIZATION | AVS | QUASI_CASH | INVALID | HOLD_AMOUNT | RELEASE_AMOUNT | UPDATE_AMOUNT | MERCHANT_CREDIT_AMOUNT | PAYMENT_AMOUNT | PENDING_CREDIT | QUASI_CASH | HOLD_FOR_FUND_ALLOCATION | RELEASE_FOR_FUND_DEALLOCATION | PENDING_DEBIT)[]; type?: string[]; }; savingsId: number | number[]; }, { pageItems: object[]; totalFilteredRecords: number; }>
A Command that when executed returns the recent transactions response
Example
const getRecentCmd = GetRecentTransactions(
101,
{
offset: 0,
limit: 50,
orderBy: "createdAt",
sortOrder: "DESC",
type: ["SAVINGS_TX"],
status: ["PROCESSED"]
}
);
const result = await getRecentCmd.execute(config);
console.log(result.totalFilteredRecords);
console.log(result.pageItems[0].transactionAmount);
console.log(result.pageItems[0].cardNumber); // "****1234" if card transaction