GET
/
transactions
/
{transactionId}
curl --request GET \
  --url https://api-sandbox.lumx.io/transactions/{transactionId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "123e4567-e89b-12d3-a456-426614174002",
  "customerId": "123e4567-e89b-12d3-a456-426614174001",
  "type": "off_ramp",
  "request": {
    "sourceCurrency": "USDC",
    "targetCurrency": "BRL",
    "amount": "100.00",
    "payment": {
      "rail": "pix",
      "keyValue": "user@email.com",
      "keyType": "email"
    }
  },
  "state": {
    "status": "processing",
    "payment": {
      "rail": "pix"
    }
  },
  "createdAt": "2024-03-20T15:30:00Z",
  "updatedAt": "2024-03-20T15:30:05Z"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <API_KEY>.

Path Parameters

transactionId
string
required

The ID of the transaction.

Response

200 - application/json
The details of the transaction were retrieved 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
request
object

An object containing the parameters used for this on-ramp.

state
object

The transaction's results.

status
enum<string>
Available options:
awaiting_funds,
processing,
success,
failed
createdAt
string

The timestamp from when the transaction was submitted.

updatedAt
string

The timestamp from when the transaction was last updated.