Transactions

View transaction details

Read one transaction by its ID, or a page of transactions.

GET/transactions/{transaction_id}

Authorization

If set, the API uses an API key for authentication. Include the following header in your requests: X-blnk-key: <api-key>.

Replace <api-key> with your secret API key. Ensure the key is kept secure and not exposed in public repositories or client-side code.

Path

transaction_idstringrequiredpath

Id of the transaction to retrieve. Leave transaction_id out to list transactions, newest first. The list returns one page, not every transaction in the ledger.

Query

These parameters apply to the list. A request for one transaction ignores them.

limitintegerdefault 20query

How many transactions to return. A value that is missing or not a positive integer is treated as 20.

offsetintegerdefault 0query

How many transactions to skip before the page starts. A value that is missing, negative, or not an integer is treated as 0.

curl -X GET "http://localhost:5001/transactions/{transaction_id}" \
  -H "X-blnk-key: <api-key>"

curl -X GET "http://localhost:5001/transactions?limit=20&offset=0" \
  -H "X-blnk-key: <api-key>"

{
    "precise_amount": 300,
    "amount": 3,
    "precision": 100,
    "transaction_id": "txn_93c3f6dc-9c2c-46b0-89c5-1814cef4d0e4",
    "parent_transaction": "",
    "source": "bln_845bbf20-cc0c-41d2-810b-24f104f1cb8b",
    "destination": "bln_e92a1ba7-92c7-427c-8c8f-bfdca55c875d",
    "reference": "ref_04551509-d7d3-4eab-a1fd-2eb12809b5a4_q",
    "currency": "BTC",
    "description": "test",
    "status": "REJECTED",
    "hash": "",
    "allow_overdraft": false,
    "inflight": false,
    "created_at": "2025-02-08T13:36:42.748594Z",
    "effective_date": "2025-02-08T13:36:42.748594Z",
    "scheduled_for": "0001-01-01T00:00:00Z",
    "inflight_expiry_date": "0001-01-01T00:00:00Z",
    "inflight_commit_date": "0001-01-01T00:00:00Z",
    "meta_data": {
        "blnk_rejection_reason": "failed to apply transaction to balances: insufficient funds in source balance"
    }
}

[
  {
    "precise_amount": 300,
    "amount": 3,
    "precision": 100,
    "transaction_id": "txn_93c3f6dc-9c2c-46b0-89c5-1814cef4d0e4",
    "parent_transaction": "",
    "source": "bln_845bbf20-cc0c-41d2-810b-24f104f1cb8b",
    "destination": "bln_e92a1ba7-92c7-427c-8c8f-bfdca55c875d",
    "reference": "ref_04551509-d7d3-4eab-a1fd-2eb12809b5a4_q",
    "currency": "BTC",
    "description": "test",
    "status": "REJECTED",
    "hash": "",
    "allow_overdraft": false,
    "inflight": false,
    "created_at": "2025-02-08T13:36:42.748594Z",
    "effective_date": "2025-02-08T13:36:42.748594Z",
    "scheduled_for": "0001-01-01T00:00:00Z",
    "inflight_expiry_date": "0001-01-01T00:00:00Z",
    "inflight_commit_date": "0001-01-01T00:00:00Z",
    "meta_data": {
      "blnk_rejection_reason": "failed to apply transaction to balances: insufficient funds in source balance"
    }
  }
]

{
  "error": "Transaction with ID 'txn_f482a1b3-6c2d-4e89-a17b-3d5e8f2a1c94' not found",
  "error_detail": {
    "code": "TXN_NOT_FOUND",
    "message": "Transaction with ID 'txn_f482a1b3-6c2d-4e89-a17b-3d5e8f2a1c94' not found",
    "details": {}
  }
}