List Transactions

This endpoint allows to list transactions.

Authorization:

bearer

HTTP: bearer

HTTP Authorization Scheme: bearer

Headers:
  Authorization: APIKey {YOUR_API_KEY}

Endpoint

GET

/api/v2/transactions

Query parameters

Parameter	Type	Description
page	int	Page number (default: 1).
limit	int	Number of items per page (default: 100).
search	string	Search term (min 3, max 255 characters).
accountId	string (uuid)	Filter by account ID.
transactionType	string	Filter by type: crypto, bank, or trade.
status	string	Filter by transaction status (e.g., pending, completed, failed).
startDate	string (date-time)	Inclusive lower bound on createdAt. Accepts RFC3339, 2006-01-02T15:04:05, or 2006-01-02. Values without an offset are treated as UTC; pass an RFC3339 offset (e.g., 2026-05-12T00:00:00-05:00) to filter in another timezone.
endDate	string (date-time)	Inclusive upper bound on createdAt. Accepts the same formats as startDate; date-only values cover the entire UTC day. When both dates are provided, endDate must be strictly later than startDate.
coin	string	Filter by coin (e.g., USD, USDC, BTC).

Response Sample (Trade Transaction)

{
  "data": [
    {
      "id": "11111111-2222-3333-4444-555555555555",
      "reference": "client-ref-12345",
      "accountId": "00000000-0000-0000-0000-000000000000",
      "createdAt": "2025-01-15T10:30:00Z",
      "transactionType": "trade",
      "coins": ["USDC", "USD"],
      "status": "completed",
      "statusReason": "Trade executed successfully",
      "statusHistory": [
        { "status": "completed", "statusReason": "Trade executed", "date": "2025-01-15T10:35:00Z" },
        { "status": "pending", "statusReason": "Trade submitted", "date": "2025-01-15T10:30:00Z" }
      ],
      "account": {
        "accountId": "00000000-0000-0000-0000-000000000000",
        "email": "jwick@localhost"
      },
      "audit": {
        "adminId": "00000000-0000-0000-0000-000000000000",
        "admin": "agent@workspace",
        "apiKey": false
      },
      "tradeTransactionDetails": {
        "type": "market",
        "product": "USDC-USD",
        "side": "buy",
        "quantity": 100.00,
        "quantityCurrency": "USD",
        "fee": 1.00,
        "feeCurrency": "USD",
        "quoteQuantity": 99.00,
        "quoteCurrency": "USDC",
        "rate": 1.00
      }
    }
  ],
  "page": 1,
  "limit": 10,
  "total": 100
}

Response Sample (Bank Transaction)

{
  "data": [
    {
      "id": "22222222-3333-4444-5555-666666666666",
      "reference": "bank-deposit-789",
      "accountId": "00000000-0000-0000-0000-000000000000",
      "createdAt": "2025-01-14T14:20:00Z",
      "transactionType": "bank",
      "coins": ["USD"],
      "status": "pending",
      "statusReason": "Awaiting processing",
      "statusHistory": [
        { "status": "pending", "statusReason": "Deposit initiated", "date": "2025-01-14T14:20:00Z" }
      ],
      "account": {
        "accountId": "00000000-0000-0000-0000-000000000000",
        "email": "jwick@localhost"
      },
      "audit": {
        "adminId": "00000000-0000-0000-0000-000000000000",
        "admin": "agent@workspace",
        "apiKey": false
      },
      "bankTransactionDetails": {
        "type": "deposit",
        "coin": "USD",
        "amount": 500.00,
        "fee": 2.50,
        "total": 502.50,
        "instrumentType": "ach",
        "transactionReference": "BW0000 123456",
        "originatorName": "John Wick",
        "senderAccountNumber": "1023456789",
        "senderRoutingNumber": "100000000",
        "senderBankName": "BlockWyre Bank"
      }
    }
  ],
  "page": 1,
  "limit": 10,
  "total": 50
}

Response Schema

Field	Type	Description
page	int	Current page number.
limit	int	Number of items per page.
total	int	Total number of transactions.
data	array	List of transactions.
data[].id	string (uuid)	Unique transaction ID.
data[].reference	string	Client reference.
data[].accountId	string (uuid)	Account ID.
data[].createdAt	string (datetime)	Timestamp of creation (ISO 8601).
data[].transactionType	string	Transaction type: bank, crypto, or trade.
data[].coins	array of strings	Coins involved in the transaction.
data[].status	string	Transaction status (e.g., pending, completed, failed).
data[].statusReason	string	Reason for the current status.
data[].statusHistory	array	History of status changes.
data[].account	object	Account summary.
data[].account.accountId	string (uuid)	Account ID.
data[].account.email	string	Account email.
data[].audit	object	Audit information about who created the transaction.
data[].audit.adminId	string (uuid)	ID of the workspace admin who created the transaction (optional).
data[].audit.admin	string	Email of the workspace admin (optional).
data[].audit.apiKey	boolean	Whether the transaction was created via API key.
data[].bankTransactionDetails	object	Bank transaction details (present when transactionType is bank).
data[].cryptoTransactionDetails	object	Crypto transaction details (present when transactionType is crypto).
data[].tradeTransactionDetails	object	Trade transaction details (present when transactionType is trade).

Bank Transaction Details

Field	Type	Description
type	string	deposit or withdrawal.
coin	string	Currency (e.g., USD).
amount	decimal	Transaction amount.
fee	decimal	Transaction fee.
total	decimal	Total amount (amount + fee).
instrumentType	string	Instrument type (e.g., ach, wire, swift).
transactionReference	string	Transaction reference number.
imad	string	International money transfer ID (optional).
originatorName	string	Name of the originator (optional).
senderAccountNumber	string	Sender account number (optional).
senderRoutingNumber	string	Sender routing number (optional).
senderSwiftCode	string	Sender SWIFT code (optional).
senderIban	string	Sender IBAN (optional).
senderBankName	string	Sender bank name (optional).
beneficiaryAccountNumber	string	Beneficiary account number (optional).
beneficiaryRoutingNumber	string	Beneficiary routing number (optional).
beneficiarySwiftCode	string	Beneficiary SWIFT code (optional).
beneficiaryIban	string	Beneficiary IBAN (optional).
beneficiaryBankName	string	Beneficiary bank name (optional).
beneficiaryName	string	Beneficiary name (optional).
traceNumber	string	ACH trace number — NACHA equivalent of an IMAD for wires (optional).
addenda	array of strings	ACH addenda records. For inbound credits via intermediaries (e.g. Wise) the actual sender's name is here; the originatorName only carries the intermediary (optional).

Crypto Transaction Details

Field	Type	Description
type	string	deposit or withdraw.
coin	string	Coin identifier (e.g., USDT).
network	string	Blockchain network (e.g., ethereum).
amount	decimal	Transaction amount.
fee	decimal	Transaction fee.
total	decimal	Total amount.
networkFee	decimal	Network fee (optional).
targetAddress	string	Target wallet address (optional).
txHash	string	Blockchain transaction hash (optional).

Trade Transaction Details

Field	Type	Description
type	string	Trade type (e.g., market).
product	string	Trading pair (e.g., BTC-USD, USDC-MXN).
side	string	buy or sell.
quantity	decimal	Quantity of the base currency.
quantityCurrency	string	Base currency.
fee	decimal	Trade fee.
feeCurrency	string	Fee currency.
quoteQuantity	decimal	Quantity of the quote currency.
quoteCurrency	string	Quote currency.
rate	decimal	Exchange rate.

Support and Resources

If you need assistance or have any questions, our support team is here to help. You can contact our support team at support@blockwyre.com.

Stay Updated

Stay up-to-date with the latest news, updates, and features from BlockWyre by following us on social media:

• Instagram: BlockWyre Instagram
• Twitter: BlockWyre Twitter
• Facebook: BlockWyre Facebook
• LinkedIn: BlockWyre LinkedIn

We are excited to have you on board and look forward to seeing how you leverage BlockWyre's powerful tools to enhance your financial operations. Happy integrating!