Transactions

Get transaction by reference

Read a transaction by its reference.

GET/transactions/reference/{reference}

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

referencestringrequiredpath

The unique reference number of the transaction to retrieve.

curl -X GET "http://localhost:5001/transactions/reference/{reference}" \
  -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",
    "currency": "BTC",
    "description": "test",
    "status": "APPLIED",
    "hash": "0b9c25fb5b00d6c71cb4ca87026bf6dc316e63353d3330deb588bd0b3d74dcc0",
    "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": {
        "customer_id": "12345",
        "payment_method": "card"
    }
}

{
  "error": "Transaction with reference 'ref_does_not_exist' not found",
  "error_detail": {
    "code": "TXN_NOT_FOUND",
    "message": "Transaction with reference 'ref_does_not_exist' not found"
  }
}