Get Wallet Transactions

GET /wallet/transactions

Retrieve a paginated list of wallet transactions for the authenticated user. Supports optional filters such as status, transaction hash, and date range.

API Reference

Authentication

All requests require authentication via the x-api-key header:

x-api-key: YOUR_API_KEY

Replace YOUR_API_KEY with your actual key from the KiraPay dashboard.

Query Parameters

Field
Type
Required
Description

status

string

No

Filter by transaction status. One of: PENDING, COMPLETED, FAILED, CANCELLED.

transaction_hash

string

No

Filter by specific blockchain transaction hash.

from_date

string

No

ISO 8601 timestamp. Filters transactions from this date onwards (inclusive).

to_date

string

No

ISO 8601 timestamp. Filters transactions up to this date (inclusive).

page

number

No

Page number for pagination (default: 1).

limit

number

No

Number of items per page (default: 10, max: 100).

Example Request (cURL)

curl -X GET "https://kirapay-api.holatech.app/api/wallet/transactions?page=1&limit=10&status=PENDING" \
  -H "x-api-key: <YOUR_API_KEY>"

Example Request (Node.js)

import axios from "axios";

async function getWalletTransactions() {
  try {
    const response = await axios.get(
      "https://kirapay-api.holatech.app/api/wallet/transactions",
      {
        params: {
          page: 1,
          limit: 10,
          status: "PENDING" // optional filter
        },
        headers: {
          "x-api-key": process.env.KIRAPAY_API_KEY!,
        },
      }
    );

    console.log(response.data);
  } catch (error) {
    console.error("Error fetching wallet transactions:", error.response?.data || error.message);
  }
}

getWalletTransactions();

Successful Response (200)

{
  "message": "success",
  "data": {
    "transactions": [
      {
        "_id": "689324309eb9e6e8e0f842cd",
        "price": 0.015,
        "hash": "0xb6accc136297ad17ab831028f967cbf2bdd9ff67b8fab5d4e8e4f34f8681eb59",
        "status": "Success",
        "type": "Contract",
        "user": {
          "_id": "688c82d81c6a157748c5ca7b",
          "username": "john_doe"
        },
        "link": "6891c0896aad1cd3bf2f3490",
        "source": "7",
        "createdAt": "2025-08-06T09:45:20.374Z",
        "updatedAt": "2025-08-06T09:45:50.365Z",
        "__v": 0,
        "payload": {
          "eventNonce": "0x9bd7d21d481bd64a3f046b6c9e930b5843a0c36f8832a1c8e8e2319c16da6f28",
          "attestation": "0x8730053fe55a898df9f81f4c45364ef1ad7541125e20656278ec9749d92ec7bb3bd5b5c81703be23d9013e03db36f2b57e8074032f68e1b9dea26570c254c0b41c2bb48dbabb202780d06305148f768bc8af82b92632fddffa88e54950deadf5774fea1bd99f721c08e88d72e15f674200438b25256c88919a6ddf29fee5df91c91c",
          "cctpVersion": 2,
          "sender": "0x28b5a0e9c621a5badaa536219b3a228c8168cf5d",
          "recipient": "0x28b5a0e9c621a5badaa536219b3a228c8168cf5d",
          "mintRecipient": "0x4b6aee828992738f64b1e908f082aa9f2cc6936a",
          "messageSender": "0x4b6aee828992738f64b1e908f082aa9f2cc6936a",
          "amount": "15000",
          "maxFee": 2,
          "feeExecuted": 0,
          "sourceDomain": 7,
          "destinationDomain": 6,
          "status": "complete"
        }
      }
    ],
    "total": 1,
    "page": 1,
    "totalPages": 1
  },
  "code": 200
}

Response Fields

Field
Type
Description

message

string

Response status message. "success" for successful requests.

data.transactions

array

List of transactions.

data.transactions[]._id

string

Unique identifier for the transaction (MongoDB ObjectId).

data.transactions[].price

number

Transaction amount in the specified currency.

data.transactions[].hash

string

Blockchain transaction hash (66 chars, starts with 0x).

data.transactions[].status

string

Transaction status (Success, Pending, Failed, Cancelled).

data.transactions[].type

string

Type of transaction (Contract, Transfer, Refund).

data.transactions[].user

object

User information.

data.transactions[].user._id

string

Unique identifier of the user.

data.transactions[].user.username

string

Username of the user.

data.transactions[].link

string

ID of the payment link associated with this transaction.

data.transactions[].source

string

Source domain identifier for cross-chain transactions.

data.transactions[].createdAt

string

ISO 8601 timestamp when the transaction was created.

data.transactions[].updatedAt

string

ISO 8601 timestamp when the transaction was last updated.

data.transactions[].__v

number

MongoDB internal version key.

data.transactions[].payload

object

CCTP (Cross-Chain Transfer Protocol) transaction payload.

data.transactions[].payload.eventNonce

string

Unique event nonce for cross-chain transaction.

data.transactions[].payload.attestation

string

Attestation signature for verification.

data.transactions[].payload.cctpVersion

number

Version of the CCTP protocol.

data.transactions[].payload.sender

string

Original sender wallet address.

data.transactions[].payload.recipient

string

Recipient wallet address.

data.transactions[].payload.mintRecipient

string

Address where tokens are minted on the destination chain.

data.transactions[].payload.messageSender

string

Address that initiated the cross-chain message.

data.transactions[].payload.amount

string

Transaction amount (in smallest token unit).

data.transactions[].payload.maxFee

number

Maximum fee allowed.

data.transactions[].payload.feeExecuted

number

Actual fee executed.

data.transactions[].payload.sourceDomain

number

Source blockchain domain identifier.

data.transactions[].payload.destinationDomain

number

Destination blockchain domain identifier.

data.transactions[].payload.status

string

CCTP transaction status (complete, pending, etc.).

data.total

number

Total number of transactions matching the query.

data.page

number

Current page number.

data.totalPages

number

Total number of pages available.

code

number

HTTP status code (200 for success).

Usage Example:

  • A merchant dashboard uses this endpoint to list all past transactions with filters for status and date range.

  • Useful for reconciliation, transaction history, and customer support.

Last updated

Was this helpful?