Tracking Transactions - API
How to retrieve and track transactions across your organisation via the Lorum API, including status, confirmation letters, and supporting documents.
All transactions across your organisation can be retrieved and filtered via the Lorum API. This guide covers listing transactions, retrieving individual transaction details, and accessing confirmation letters and supporting documents.
Listing Transactions
All transactions across your organisation via List All Transactions
GET /v1/transactions
Transactions for a specific account via List Account Transactions
GET /v1/accounts/{account_id}/transactions
Both endpoints support filtering and pagination. Transactions are returned in reverse chronological order by default.
Getting a Single Transaction
Retrieve a specific transaction via Get Transaction
GET /v1/transactions/{transaction_id}
The response includes full transaction details including status, amount, remitter, beneficiary, timestamps at each lifecycle stage, and any failure reason.
Transaction Statuses
| Status | Description | Terminal? |
|---|---|---|
Created | Transaction has been created | ❌ |
Submitted | Transaction has been submitted for processing | ❌ |
Executed | Transaction has been processed | ✅ |
Failed | Transaction failed to process | ✅ |
Settled | Inbound only — funds have been credited to the account | ✅ |
Transaction Confirmation Letter
Download a confirmation letter for an outbound transaction via Get Transaction Confirmation Letter
GET /v1/transactions/{transaction_id}/confirmation-letter
Confirmation letters are only available for transactions in a
SubmittedorExecutedstate.
Supporting Documents
Link a document to a transaction via Link Document to Transaction
POST /v1/transactions/{transaction_id}/documents
List documents linked to a transaction via Get Linked Documents
GET /v1/transactions/{transaction_id}/documents
Documents must first be uploaded via Upload Document
POST /v1/documents
before they can be linked.
Updated 24 days ago