Outbound payments can be initiated via the API for any account with sufficient funds. This guide covers creating payments, retrieving payment data, and attaching supporting documents.

📘

For fee configuration options, see Transaction Fees.

---

Creating an Outbound Payment

Create an outbound payment via Create Outbound Payment

POST /v1/accounts/{account_id}/payments

🚧

All POST requests to create payments must include an Idempotency-Key header. See Understanding Idempotency for details.

As a payment progresses through its lifecycle, Lorum sends webhook events to notify your integration of each status change. For the full list of payment-related webhook events, see Webhook Catalogue.

---

Estimating a Payment Fee

Get a fee estimate before initiating a payment via Estimate Payment Fee

GET /v1/accounts/{account_id}/payments/fee-estimate

---

Retrieving Transactions

List all transactions across your organisation via List All Transactions

GET /v1/transactions

List transactions for a specific account via List Account Transactions

GET /v1/accounts/{account_id}/transactions

Get a single transaction via Get Transaction

GET /v1/transactions/{transaction_id}

---

Transaction Confirmation Letter

Download a transaction confirmation letter via Get Transaction Confirmation Letter

GET /v1/transactions/{transaction_id}/confirmation-letter

📘

Confirmation letters are only available for outbound payments in a Submitted or Executed state.

---

Supporting Documents

Before a document can be attached to a transaction, it must first be uploaded using Upload Document.

POST /v1/documents\

Once uploaded, attach the document to the transaction using Link Document to Transaction

POST /v1/transactions/{transaction_id}/documents

To retrieve all documents linked to a transaction, use Get Linked Documents

GET /v1/transactions/{transaction_id}/documents

---

AED Payment Data Validation

AED payments are subject to specific field length, format, and character set requirements. Refer to the AED Account & Payment Data Validation guide for the complete validation rules.

---

Sandbox Testing

In sandbox, use the Simulate Scheme Actions - API to progress payments through their lifecycle. This allows you to test different payment states and webhook events as part of your integration testing.