POST
/
transactions
/
transfers
curl --request POST \
  --url https://api-sandbox.lumx.io/transactions/transfers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "currency": "USDC",
  "from": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "to": "123e4567-e89b-12d3-a456-426614174000",
  "amount": 100.123456
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "on_ramp",
  "request": {},
  "state": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <API_KEY>.

Body

application/json
currency
enum<string>
required

The stablecoin to be transferred.

Available options:
USDC,
USDT
from
string
required

The id of the customer who is sending the tokens.

to
string
required

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

Example:

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

amount
string
required

The amount to be transferred.

Example:

100.123456

Response

201 - application/json
Transfer transaction created successfully.
id
string

The id of the transaction.

customerId
string

The customer performing the operation.

type
enum<string>

The type of this transaction

Available options:
on_ramp,
off_ramp,
transfer,
swap
request
object

The parameters used when creating this transaction.

state
object

The transaction's results.

createdAt
string

The timestamp from when the transaction was submitted.

updatedAt
string

The timestamp from when the transaction was last updated.