This endpoint reads a transaction made with your API key.

Read a transaction

The URL of the block explorer where the details of this transaction can be read.

The identifier of this transaction on the blockchain.

The definition of how and where the funds from the off ramp transaction will be sent.

The PIX key identifying the account where to send funds.

The payment rail that will be used for this transaction.

The amount to be converted from stablecoin to fiat.

The encoded data that needs to be signed in order to submit this transaction to the blockchain.

The amount to be converted from fiat to stablecoin.

The payment details to add funds for this on ramp transaction.

The PIX copy-and-paste code to be used for payment.

On ramp

The id of the customer who is sending the tokens.

The wallet address or customer ID who will receive the tokens.

apiKey

On-ramp

Off-ramp

Transfer

Lumx

Dashboard

System Status

Community

API Reference

Start now

Support

Welcome to the Developer Documentation for Lumx. These docs are intended for developers looking to integrate Lumx API into their platform.

Introduction

Learn how to authenticate yourself to get access to our APIs

Authentication

Multiple enviroments with multiple purposes

Environments

Choose the best blockchain to fit your project

Blockchains

Find out the common extended error messages you may encounter while using our system

Troubleshooting

APIs

Accounts

Orchestration

Read all customers

This endpoint creates a customer. At least one document is required.

Create a customer

This endpoint reads a customer's details.

Read a customer

This endpoint updates a customer's details including documents. Each field is optional, so you can update only some of the customer's details. If a document is provided, it will be updated or added to the customer's documents list.

Update a customer

Get a price quote for converting between currencies.

Get an exchange rate

Convert BRL (Brazilian Real) to USDC or USDT.

Convert USDC or USDT to BRL (Brazilian Real).

Transfer stablecoins between customers or to an external crypto wallet.

Execute a transaction that you previously signed using your signing provider. Important: This is an ASYNC route! Use the read transaction route to check the transaction's status.

Execute a transaction

This endpoint reads all transactions made with your API key.

Customers

Exchange Rates

Transactions

Read a transaction

Authorizations

Path Parameters

Response