Skip to content

@mbanq/core-sdk-js v0.50.0


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

Function: GetPendingTransactions()

GetPendingTransactions(savingsId, data?): Command<{ data?: { limit?: number; offset?: number; orderBy?: string; sortOrder?: string; }; savingsId: number; }, { pageItems: object[]; totalFilteredRecords: number; }>

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

Retrieves pending transactions for a specific savings account.

Use this API to retrieve the pending transactions of an account, including pending card authorizations and ACH transactions.

Pending transactions are those that have not been completed yet. For example, a transaction under AML (Anti-Money Laundering) screening is considered a pending transaction.

Parameters

savingsId

number

The ID of the savings account

data?

limit?

number = ...

offset?

number = ...

orderBy?

string = ...

sortOrder?

string = ...

Returns

Command<{ data?: { limit?: number; offset?: number; orderBy?: string; sortOrder?: string; }; savingsId: number; }, { pageItems: object[]; totalFilteredRecords: number; }>

A Command that when executed returns the pending transactions response

Example

typescript
const getPendingCmd = GetPendingTransactions(
  123,
  { offset: 0, limit: 200, orderBy: "createdAt", sortOrder: "DESC" }
);
const result = await getPendingCmd.execute(config);
console.log(result.totalFilteredRecords);
console.log(result.pageItems[0].transfer.status); // "AML_SCREENING"

Released under the MIT License.