Reporting

Reporting endpoints return read-optimized views of your account's activity, served from the reporting store rather than live transaction state. Use them for dashboards, reconciliation, and exports; use Get Transaction to track an in-flight payment.

Get Account Summary

GET /accounts/{accountUUID}/reporting/summary

GET
/accounts/{accountUUID}/reporting/summary
curl --location '{API_BASE_URL}/accounts/{AccountUUID}/reporting/summary?fromDate={FROM_DATE}&toDate={TO_DATE}' \
--header 'X-Api-Key: {API_KEY}' \
--header 'Content-Type: application/json'

All query parameters are optional: merchantID, fromDate, toDate.

Get Account Summary Response

  • Name
    totalVolumeUSD
    Type
    number
    Description

    Total transaction volume in USD for the period.

  • Name
    totalFeesUSD
    Type
    number
    Description

    Total fees charged in USD for the period.

  • Name
    pendingPayoutsUSD
    Type
    number
    Description

    Amount awaiting payout in USD.

example response

{
    "totalVolumeUSD": 15230.5,
    "totalFeesUSD": 152.31,
    "pendingPayoutsUSD": 4200
}

List Account Transactions

Retrieve transactions across your account, optionally filtered by merchant.

GET /accounts/{accountUUID}/transactions

GET
/accounts/{accountUUID}/transactions
curl --location '{API_BASE_URL}/accounts/{AccountUUID}/transactions?merchantID={MERCHANT_UUID}&limit={LIMIT}&offset={OFFSET}' \
--header 'X-Api-Key: {API_KEY}' \
--header 'Content-Type: application/json'

All query parameters are optional: merchantID, referenceNumber, statuses, paymentStatuses, currency, fromDate, toDate, limit, offset. statuses and paymentStatuses accept repeated values (e.g. statuses=0&statuses=1).

List Account Transactions Response

  • Name
    total
    Type
    number
    Description

    Total number of transactions matching the filters.

  • Name
    transactions
    Type
    array
    Description

    Transaction report rows.

    Transaction Report Row
    • Name
      transactionID
      Type
      string
      Description
      Unique identifier for the transaction.
    • Name
      accountID
      Type
      string
      Description
      Account the transaction belongs to.
    • Name
      merchantID
      Type
      string
      Description
      Merchant the transaction belongs to.
    • Name
      externalMID
      Type
      string
      Description
      External merchant ID, when set.
    • Name
      descriptor
      Type
      string
      Description
      Human-readable descriptor.
    • Name
      referenceNumber
      Type
      string
      Description
      Merchant reference or order number.
    • Name
      status
      Type
      number
      Description
      Transaction status.
    • Name
      paymentStatus
      Type
      number
      Description
      Aggregate status of the transaction's payments.
    • Name
      currency
      Type
      string
      Description
      Local currency code (ISO 4217).
    • Name
      totalLocal
      Type
      number
      Description
      Total amount in local currency.
    • Name
      totalUSD
      Type
      number
      Description
      Total amount in USD.
    • Name
      receivedUSD
      Type
      number
      Description
      Amount received in USD.
    • Name
      customerFeeUSD
      Type
      number
      Description
      Additional customer fee in USD.
    • Name
      fxRateToUSD
      Type
      number
      Description
      FX rate from local currency to USD.
    • Name
      payments
      Type
      array
      Description

      Payment summaries, each with paymentRequestID, cryptoAsset, cryptoNetwork, address, fromAddress, expectedUSD, receivedCrypto, gasFee, gasFeeUnits, txnHash, status, fraudPass, and createdAt.

    • Name
      cancellationReason
      Type
      string
      Description
      Reason the transaction was cancelled, when applicable.
    • Name
      expiration
      Type
      string
      Description
      Expiration of the transaction.
    • Name
      sourceCreatedAt
      Type
      string
      Description
      When the transaction was created.
    • Name
      sourceUpdatedAt
      Type
      string
      Description
      When the transaction was last updated.

example response

{
    "total": 1,
    "transactions": [
        {
            "transactionID": "236118b0-b43e-421e-998d-0d0f84b99e5a",
            "accountID": "50e6dc19-8d39-4f33-a98c-8fbf4e12ed9d",
            "merchantID": "7da1d36d-c995-4e99-bfb4-758fd2c94c99",
            "externalMID": "",
            "descriptor": "Order #1234",
            "referenceNumber": "d83fba40-87ea-4a62-bafa-a2601a673f51",
            "status": 1,
            "paymentStatus": 1,
            "currency": "USD",
            "totalLocal": 9.34,
            "totalUSD": 9.34,
            "receivedUSD": 9.34,
            "customerFeeUSD": 1.25,
            "fxRateToUSD": 1,
            "payments": [],
            "cancellationReason": "",
            "expiration": "2025-08-12T03:35:02.769Z",
            "sourceCreatedAt": "2025-08-12T03:20:02.769Z",
            "sourceUpdatedAt": "2025-08-12T03:21:14.101Z"
        }
    ]
}

Get Account Transaction

GET /accounts/{accountUUID}/transactions/{transactionID}

GET
/accounts/{accountUUID}/transactions/{transactionID}
curl --location '{API_BASE_URL}/accounts/{AccountUUID}/transactions/{TRANSACTION_ID}' \
--header 'X-Api-Key: {API_KEY}' \
--header 'Content-Type: application/json'

Get Account Transaction Response

Returns a transaction object with the same fields as the Transaction Report Row, plus a compliance object (kycTriggered, travelRuleTriggered) and full payment detail on each entry in payments (adds expectedCrypto, receivedUSD, confirmationCount, cryptoRatePerUSD, walletName, completedAt, expiration, sourceCreatedAt, sourceUpdatedAt).