POST
/
transactions
/
off-ramp
Off-ramp
curl --request POST \
  --url https://api.lumx.io/transactions/off-ramp \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "customerId": "123e4567-e89b-12d3-a456-426614174000",
  "sourceCurrency": "USDC",
  "sourceAmount": "10000.00",
  "targetCurrency": "BRL",
  "payment": {
    "rail": "PIX",
    "keyType": "CPF",
    "keyValue": "123.456.789-00"
  },
  "partnerFeeId": "123e4567-e89b-12d3-a456-426614174004"
}'
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "OFF_RAMP",
  "request": {
    "sourceCurrency": "USDC",
    "targetCurrency": "BRL",
    "amount": "10000.00",
    "payment": {
      "rail": "PIX",
      "keyType": "CPF",
      "keyValue": "123.456.789-00"
    }
  },
  "state": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header on the format Bearer <API_KEY>.

Body

application/json

Off-ramp using floating exchange rate.

​
customerId
string<uuid>
required

Customer's unique identifier.

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
sourceCurrency
enum<string>
required

Transaction's source currency.

Available options:
USDC,
USDT
Example:

"USDC"

​
sourceAmount
string
required

Transaction's source amount.

Example:

"10000.00"

​
targetCurrency
enum<string>
required

Transaction's target currency.

Available options:
BRL
Example:

"BRL"

​
payment
object
required

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

​
partnerFeeId
string<uuid>

Partner fee id to be used for this transaction. If not provided, the default partner fee will be used.

Example:

"123e4567-e89b-12d3-a456-426614174004"

Response

202 - application/json

Off-ramp transaction started successfully.

​
id
string<uuid>

Off-ramp operation's unique identifier.

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
customerId
string<uuid>

Customer's unique identifier.

Example:

"3c90c3cc-0d44-4b50-8888-8dd25736052a"

​
type
enum<string>

Off-ramp operation's type.

Available options:
OFF_RAMP
Example:

"OFF_RAMP"

​
request
object
​
state
object

Off-ramp operation's current state. See examples for more details.

​
createdAt
string<date-time>

Creation date and time.

​
updatedAt
string<date-time>

Last update date and time.