Convert fiat to stablecoin with floating or locked FX rates
Initiate On-Ramp
exchangeRateId
.Receive Deposit Instructions
Fiat Deposit
Deposit Confirmation
Stablecoin Transfer
Parameter | Type | Required | Description |
---|---|---|---|
customerId | string | Yes | UUID of the verified customer |
sourceCurrency | string | Yes | Fiat ISO code (e.g., BRL ) |
sourceAmount | string | Yes | Amount in sourceCurrency |
targetCurrency | string | Yes | Asset code (e.g., USDC , USDT , or other supported stablecoins) |
payment.rail | string | Yes | Payment rail (e.g., PIX ) |
partnerFeeId | string | No | Optional partner fee configuration |
Parameter | Type | Required | Description |
---|---|---|---|
customerId | string | Yes | UUID of the verified customer |
exchangeRateId | string | Yes | ID of the locked exchange rate (use before expiresAt ) |
payment.rail | string | Yes | Payment rail (e.g., PIX ) |
exchangeRateId
, you don’t need to input currencies/amounts;
they’re derived from the locked rate you got earlier. Attempts after expiry
will be rejected.Field | Description | Present when |
---|---|---|
id | Unique transaction identifier | all statuses |
customerId | Customer identifier | all statuses |
state.status | Current status: AWAITING_FUNDS → TRANSFERRING_FIAT → TRADING → TRANSFERRING_STABLECOIN → SUCCESS /FAILED | all statuses |
state.payment.rail | Payment rail used for funding (e.g., PIX ) | all statuses |
state.payment.brCode | Rail-specific payment data (e.g., Pix Copia e Cola / QR content) | all statuses |
state.receipt.* | Conversion breakdown after settlement: rate , sourceAmount , targetAmount , currencies, fees | SUCCESS |
state.receipt.fees.lumx.* | Lumx fee components (e.g., rate , flat , currency ) | SUCCESS |
state.receipt.fees.partner.* | Partner fee components (if configured) | SUCCESS |
state.transactionHash | Hash of the on-chain delivery transaction | SUCCESS |
state.blockExplorerUrl | Link to view the on-chain transaction | SUCCESS |
expiresAt
;
otherwise, the transaction will be rejected or end up as failed
.Field | Description |
---|---|
AWAITING_FUNDS | Waiting for the customer’s payment on the selected rail; see state.payment.* (e.g., brCode ). |
TRANSFERRING_FIAT | Payment confirmed; conversion and delivery in progress. |
TRADING | Trading for stablecoin is happening. |
TRANSFERRING_STABLECOIN | Transfering the funds to the customer’s wallet. |
SUCCESS | Transaction has been settled and the customer has received the funds. |
FAILED | Transaction failed/expired; check state.error if present. |