@mbanq/core-sdk-js / commands / GetCompletedTransactions

Function: GetCompletedTransactions()

GetCompletedTransactions(savingsId, data?): Command<{ data?: { endDate?: string; fromAmount?: number; getCardData?: boolean; isCardTransaction?: boolean; limit?: number; offset?: number; orderBy?: string; paymentType?: string; reference?: string; showEnrichedTransactions: boolean; showInterestAccruals?: boolean; sortOrder?: string; startDate?: string; statusType?: string; subTransactionType?: NONE | CARD_TRANSACTION | SETTLEMENT_RETURN_CREDIT | LOAN_DISBURSEMENT | LOAN_REPAYMENT | CARD_AUTHORIZE_PAYMENT | DOMESTIC_ATM_WITHDRAWAL_FEE | INTERNATIONAL_ATM_WITHDRAWAL_FEE | INTERNATIONAL_TRANSACTION_FEE | EXTERNAL_CARD_PUSH_TRANSACTION_FEE | EXTERNAL_CARD_PULL_TRANSACTION_FEE | MERCHANT_CREDIT | MERCHANT_CREDIT_REVERSAL | MCC_CHARGE | TRANSFER_FEE | EXTERNAL_CARD_CHARGE_BACK | EXTERNAL_CARD | CREDIT_CARD_DUE_PAYMENT | TRANSFER_RETURN_FEE | ACH | SWIFT | WIRE | OPERATIONAL_ACCOUNT_LOAN_TRANSACTION | OPERATIONAL_ACCOUNT_SAVINGS_TRANSACTION | SAVINGS_ACCOUNT_WAIVE_CHARGE_TRANSACTION | DOMESTIC_ATM_WITHDRAWAL_FEE_REVERSAL | INTERNATIONAL_ATM_WITHDRAWAL_FEE_REVERSAL | INTERNATIONAL_TRANSACTION_FEE_REVERSAL | FEE_OTHER | FEE_OTHER_REVERSAL; toAmount?: number; 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; }; savingsId: number; }, { pageItems: object[]; totalFilteredRecords: number; }>

Defined in: src/commands/rest/transaction.ts:154

Retrieves completed transactions for a specific savings account.

Use this API to retrieve completed transactions of an account, excluding pending transactions. Completed transactions include those successfully processed, such as an incoming return credited to the account or an outgoing ACH transaction sent to the bank.

Additional filters can be applied to narrow down results. Refer to the Query Params section for more details.

Parameters

savingsId

number

toAmount?

number = ...

transactionType?

Returns

Command<{ data?: { endDate?: string; fromAmount?: number; getCardData?: boolean; isCardTransaction?: boolean; limit?: number; offset?: number; orderBy?: string; paymentType?: string; reference?: string; showEnrichedTransactions: boolean; showInterestAccruals?: boolean; sortOrder?: string; startDate?: string; statusType?: string; subTransactionType?: NONE | CARD_TRANSACTION | SETTLEMENT_RETURN_CREDIT | LOAN_DISBURSEMENT | LOAN_REPAYMENT | CARD_AUTHORIZE_PAYMENT | DOMESTIC_ATM_WITHDRAWAL_FEE | INTERNATIONAL_ATM_WITHDRAWAL_FEE | INTERNATIONAL_TRANSACTION_FEE | EXTERNAL_CARD_PUSH_TRANSACTION_FEE | EXTERNAL_CARD_PULL_TRANSACTION_FEE | MERCHANT_CREDIT | MERCHANT_CREDIT_REVERSAL | MCC_CHARGE | TRANSFER_FEE | EXTERNAL_CARD_CHARGE_BACK | EXTERNAL_CARD | CREDIT_CARD_DUE_PAYMENT | TRANSFER_RETURN_FEE | ACH | SWIFT | WIRE | OPERATIONAL_ACCOUNT_LOAN_TRANSACTION | OPERATIONAL_ACCOUNT_SAVINGS_TRANSACTION | SAVINGS_ACCOUNT_WAIVE_CHARGE_TRANSACTION | DOMESTIC_ATM_WITHDRAWAL_FEE_REVERSAL | INTERNATIONAL_ATM_WITHDRAWAL_FEE_REVERSAL | INTERNATIONAL_TRANSACTION_FEE_REVERSAL | FEE_OTHER | FEE_OTHER_REVERSAL; toAmount?: number; 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; }; savingsId: number; }, { pageItems: object[]; totalFilteredRecords: number; }>

A Command that when executed returns the completed transactions response

Example

typescript

const getCompletedCmd = GetCompletedTransactions(
  123,
  {
    offset: 0,
    limit: 200,
    orderBy: "createdAt",
    sortOrder: "DESC",
    subTransactionType: "DEPOSIT"
  }
);
const result = await getCompletedCmd.execute(config);
console.log(result.totalFilteredRecords);
console.log(result.pageItems[0].transfer.status); // "COMPLETED"

Function: GetCompletedTransactions() ​

Parameters ​

savingsId ​

data? ​

endDate? ​

fromAmount? ​

getCardData? ​

isCardTransaction? ​

limit? ​

offset? ​

orderBy? ​

paymentType? ​

reference? ​

showEnrichedTransactions ​

showInterestAccruals? ​

sortOrder? ​

startDate? ​

statusType? ​

subTransactionType? ​

toAmount? ​

transactionType? ​

Returns ​

Example ​

Function: GetCompletedTransactions()

Parameters

savingsId

data?

endDate?

fromAmount?

getCardData?

isCardTransaction?

limit?

offset?

orderBy?

paymentType?

reference?

showEnrichedTransactions

showInterestAccruals?

sortOrder?

startDate?

statusType?

subTransactionType?

toAmount?

transactionType?

Returns

Example