Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.lumx.io/llms.txt

Use this file to discover all available pages before exploring further.

A transaction moves value on the platform — converting between fiat and stablecoin, or transferring stablecoin between wallets. Each one has:
  • A type defining the direction of the conversion.
  • Source and target currencies with amounts.
  • A lifecycle status tracking progress.
  • Payment details and receipts on completion.
Transactions require an approved customer and support every payment rail available for the currency pair. See Coverage for the full matrix.

Transaction types

TypeDescriptionExample
On-rampFiat to stablecoin. The customer sends fiat and receives stablecoins in their wallet.Deposit BRL via PIX, receive USDC.
Off-rampStablecoin to fiat. The customer’s stablecoins are sent to a destination.Convert USDC to USD via wire transfer.
TransferMoves stablecoins between wallets without conversion. To another customer or external address.Send USDC to another customer’s wallet.

Transaction lifecycle

Each transaction type has its own status progression:
AWAITING_FUNDSTRANSFERRING_FIATTRADINGTRANSFERRING_STABLECOINSUCCESS
Subscribe to webhooks to receive real-time notifications when transaction statuses change.

Transaction purpose

Every on-ramp and off-ramp carries a purpose field — the end-use category of the funds. Banking partners and correspondent banks on the rail use it for AML screening, cross-border reporting, and how the receiving institution classifies the deposit. Pick the value that matches what the funds are actually being used for; mismatches can hold up the transaction or trigger an RFI.
PurposeUse case
PERSONAL_ACCOUNTPersonal transfers to own accounts (requires SELF destination relationship)
INVESTMENTInvestment-related transactions
REAL_ESTATEReal estate purchases or payments
TRADE_TRANSACTIONSCommercial trade and goods
TAXTax payments
LOANLoan disbursements or repayments
BILLSBill payments
EXPENSES_REIMBURSEMENTExpense reimbursements
PROFESSIONAL_SERVICESProfessional service payments

Payment expiration

On-ramp transactions have a payment window. If the customer doesn’t complete the fiat payment in time, the transaction expires.
Exchange rate typeExpiration
LockedMatches the exchange rate quote expiration.
Floating (PIX, SPEI)1 day.
Floating (other rails)7 days.

Late deposits

If a fiat deposit lands after the transaction has expired, Lumx doesn’t process the on-ramp. The funds are refunded to the original sender on the same rail used for the deposit. Start a new on-ramp if the customer still wants to convert.

Customers

Approved customers are required to run transactions.

Exchange Rates

Floating and locked rates that drive conversion pricing.

Destinations

Where off-ramp funds land.

Payment rail cut-off times

Settlement windows and rail-by-rail deadlines.