AkashicPay
English
English
  • Introduction
    • Overview
    • Fee Structure
    • Transaction Times
    • Terminology
  • Dashboard
    • Dashboard
    • Account
    • Transfer
    • Settings
    • Developers
  • SDK
    • Getting Started
    • Payment Flow
    • SDKs & Toolkits
    • Functions
      • getDepositAddress
      • getDepositUrl
      • Identifier & ReferenceId
      • Requested amount & currency
      • payout
      • Payout callback
      • Deposit callback
      • getTransfers
      • getBalance
      • getTransactionDetails
      • Errors
    • Supported Currencies
  • Secure Callback Endpoint
  • Guides
    • Quick Guide
    • Recommended integration flow
Powered by GitBook
On this page

Was this helpful?

  1. SDK
  2. Functions

getTransfers

Query your transactions on Akashic

PreviousDeposit callbackNextgetBalance

Last updated 2 months ago

Was this helpful?

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 or transactions

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

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

  • startDate and endDate Limit results by time

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

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 . It is present for Confirmed deposits and Pending/Confirmed payouts. This is particularly important for the case of transactions, which will not have a Layer 1 hash (txHash)

Note: internalFee refers to the 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
});
$transactions = akashicPay.getTransfers([
    "page" => 0,
    "limit" => 10,
    "layer" => "L1Transaction",
    "status" => "Confirmed",
    "startDate" => date('2024-01-01),
    "endDate" => date('2025-01-01'),
    "hideSmallTransactions" => True
]);
APTransactionsParam param = APTransactionsParam.builder(0, 10, new Date(2024,1,1), new Date(2025,1,1), APTransactionLayer.L1Transaction, APTransactionStatus.Confirmed, true).build();

APTransfersResult result = akashicPay.getTransfers(l2Address, param);
var param = new ApTransactionsParam(0, 10, new DateTime(2024, 1, 1), new DateTime(2025, 1, 1), APTransactionLayer.L1Transaction, APTransactionStatus.Confirmed, true);

var result = await akashicPay.GetTransfersAsync(param);

Return Example

[
    {
      "fromAddress": "TTVkK6hGoAFhALG9NTkUDHjcFFXKmWcScU",
      "toAddress": "TQH8ygbS8BAnzSQ9uxR9vXHJYMQVRvbgPg",
      "layer": TransactionLayer.L1,
      "date": "2024-08-19T10:03:58.649Z",
      "amount": "1.000000",
      "coinSymbol": NetworkSymbol.Tron_Shasta,
      "status": TransactionStatus.CONFIRMED,
      "txHash": "28a9880ad2ef3b7be1c40763128ec9630ab74e4749a3c81037c3501e4209bfcc",
      "internalFee": {
        "deposit": "0.100000"
      },
      "l2TxnHash": "ASe7eb1cb8193787040fcffa02a224a6ced7415ff2205343c0ab661e898e8d6eef",
    },
    {
      "fromAddress": "TQH8ygbS8BAnzSQ9uxR9vXHJYMQVRvbgPg",
      "toAddress": "TTVkK6hGoAFhALG9NTkUDHjcFFXKmWcScU",
      "layer": TransactionLayer.L1,
      "date": "2024-08-19T10:03:58.649Z",
      "amount": "100.000000",
      "coinSymbol": NetworkSymbol.Tron_Shasta,
      "status": TransactionStatus.CONFIRMED,
      "txHash": "28a9880ad2ef3b7be1c40763128ec9630ab74e4749a3c81037c3501e4209bfcc",
      "internalFee": {
        "deposit": "0.100000"
      },
      "feesPaid": "14.123456",
      "l2TxnHash": "ASe7eb1cb8193787040fcffa02a224a6ced7415ff2205343c0ab661e898e8d6eef",
    },
]
[
    {
      "fromAddress": "TTVkK6hGoAFhALG9NTkUDHjcFFXKmWcScU",
      "toAddress": "TQH8ygbS8BAnzSQ9uxR9vXHJYMQVRvbgPg",
      "layer": "L1Transaction",
      "date": "2024-08-19T10:03:58.649Z",
      "amount": "1.000000",
      "coinSymbol": NetworkSymbol::TRON_SHASTA,
      "status": "Confirmed",
      "txHash": "28a9880ad2ef3b7be1c40763128ec9630ab74e4749a3c81037c3501e4209bfcc",
      "internalFee": {
        "deposit": "0.100000"
      },
      "l2TxnHash": "ASe7eb1cb8193787040fcffa02a224a6ced7415ff2205343c0ab661e898e8d6eef",
    },
    {
      "fromAddress": "TQH8ygbS8BAnzSQ9uxR9vXHJYMQVRvbgPg",
      "toAddress": "TTVkK6hGoAFhALG9NTkUDHjcFFXKmWcScU",
      "layer": "L1Transaction",
      "date": "2024-08-19T10:03:58.649Z",
      "amount": "100.000000",
      "coinSymbol": NetworkSymbol::TRON_SHASTA,
      "status": "Confirmed",
      "txHash": "28a9880ad2ef3b7be1c40763128ec9630ab74e4749a3c81037c3501e4209bfcc",
      "internalFee": {
        "deposit": "0.100000"
      },
      "feesPaid": "14.123456",
      "l2TxnHash": "ASe7eb1cb8193787040fcffa02a224a6ced7415ff2205343c0ab661e898e8d6eef",
    },
]
[
    {
      "fromAddress": "TTVkK6hGoAFhALG9NTkUDHjcFFXKmWcScU",
      "toAddress": "TQH8ygbS8BAnzSQ9uxR9vXHJYMQVRvbgPg",
      "layer": APTransactionLayer.L1Transaction,
      "date": "2024-08-19T10:03:58.649Z",
      "amount": "1.000000",
      "coinSymbol": APNetworkSymbol.TRX_SHASTA,
      "status": APTransactionStatus.Confirmed,
      "txHash": "28a9880ad2ef3b7be1c40763128ec9630ab74e4749a3c81037c3501e4209bfcc",
      "internalFee": {
        "deposit": "0.100000"
      },
      "l2TxnHash": "ASe7eb1cb8193787040fcffa02a224a6ced7415ff2205343c0ab661e898e8d6eef",
    },
    {
      "fromAddress": "TQH8ygbS8BAnzSQ9uxR9vXHJYMQVRvbgPg",
      "toAddress": "TTVkK6hGoAFhALG9NTkUDHjcFFXKmWcScU",
      "layer": APTransactionLayer.L1Transaction,
      "date": "2024-08-19T10:03:58.649Z",
      "amount": "100.000000",
      "coinSymbol": APNetworkSymbol.TRX_SHASTA,
      "status": APTransactionStatus.Confirmed,
      "txHash": "28a9880ad2ef3b7be1c40763128ec9630ab74e4749a3c81037c3501e4209bfcc",
      "internalFee": {
        "deposit": "0.100000"
      },
      "feesPaid": "14.123456",
      "l2TxnHash": "ASe7eb1cb8193787040fcffa02a224a6ced7415ff2205343c0ab661e898e8d6eef",
    },
]
{
  "TransactionCount": 2841,
  "Transactions": [
    {
      "FromAddress": "TXHGwWiCUgiKjSNC3HtWCmiABAcmQgkQ7P",
      "ToAddress": "TF97xibDz9ba4bGm6SNBYDSXA4mbeBK6JW",
      "Layer": ApTransactionLayer.L1Transaction,
      "Date": "2024-09-12T14:03:57.548Z",
      "Amount": "1.000000",
      "NetworkSymbol": TronShastaNetworkSymbol,
      "Status": ApTransactionStatus.Confirmed,
      "L2TxnHash": "AS7376bfa5e3152ea6a6027e6f0bdf35e013979394448b4516298a54355c3555aa",
      "TokenSymbol": ApTokenSymbol.Usdt,
      "InternalFee": {
        "Deposit": null,
        "Withdraw": "1.000000"
      },
      "Identifier": "testuser",
      "TxHash": "9970322d75146f8c439d943d367e894059b8118453285906b42ea67a61915ac5"
    },
    {
      "FromAddress": "TR6vZK9Nvq2ZBETWGzU5VEgGQ2ZEH2NYcp",
      "ToAddress": "TF97xibDz9ba4bGm6SNBYDSXA4mbeBK6JW",
      "Layer": ApTransactionLayer.L1Transaction,
      "Date": "2024-09-12T14:02:57.652Z",
      "Amount": "1.000000",
      "NetworkSymbol": TronShastaNetworkSymbol,
      "Status": ApTransactionStatus.Confirmed,
      "L2TxnHash": "AS2612edced26e031ab1be08daf062dd195ce306a8d4e4eed9477b1c97c3e12448",
      "TokenSymbol": ApTokenSymbol.Usdt,
      "InternalFee": {
        "Deposit": null,
        "Withdraw": "1.000000"
      },
      "Identifier": "testuser",
      "TxHash": "645a42038b52ccec75b9edcdf7c8bf6ffeadc578975ec886abf9cadf5f350ce1"
    }
  ]
}
L2 fees
Layer 1
Layer 2
ingoing
outgoing
AkashicChain
Layer 2