getTransfers

Query your transactions on Akashic

This function takes a set of optional parameters to get a more specific subset of transactions

  • page & limit For pagination. Page is zero-indexed. Allowed limit-values are 10, 25, 50, and 100

  • layer Limit results to just Layer 1 or Layer 2 transactions

  • status Limit results to only "Pending", "Confirmed", or "Failed" transactions

  • transactionType Limit results to ingoing or outgoing transactions. "Deposit" or "Withdraw"

  • startDate and endDate Limit results by time

  • hideSmallTransactions Set to true to exclude transactions below 1 USD in value

  • identifier Filter results by identifier

  • referenceId Filter results by referenceId

Note: l2Txnhash (the "L2-hash") should always be used as the unique identifier of a transaction. This is a unique transaction-hash for any transaction on AkashicChain. It is present for Confirmed deposits and Pending/Confirmed payouts. This is particularly important for the case of Layer 2 transactions, which will not have a Layer 1 hash (txHash)

Note: internalFee refers to the L2 fees associated with transactions on AkashicChain.

Example

const transactions = await akashicPay.getTransfers({
    page: 0,
    limit: 10,
    layer: TransactionLayer.L1,
    status: TransactionStatus.CONFIRMED,
    startDate: new Date('2024-01-01'),
    endDate: new Date('2025-01-01'),
    hideSmallTransactions: true
});

Return Example

PreviouspayoutNextgetBalance

Last updated

Was this helpful?