API Reference
Complete API reference for the Lux Financial platform — customers, transfers, wallets, sanctions screening, and more.
API Reference
The Lux Financial API enables you to move into, out of, and between any form of a dollar—including stablecoins, fiat currencies, and digital assets.
Base URL
https://api.lux.financial/v0Authentication
All API requests require an API key passed in the Api-Key header:
curl https://api.lux.financial/v0/customers \
-H "Api-Key: sk_live_your_api_key"Core Resources
| Resource | Description |
|---|---|
| Customers | Create and manage customer profiles with KYC |
| Transfers | Move funds between accounts, wallets, and banks |
| Wallets | Custodial and MPC wallet infrastructure |
| Sanctions | Real-time screening against 25+ global lists |
| External Accounts | Bank accounts and crypto addresses |
| Errors | Error codes and handling |
Response Format
All responses are JSON with consistent structure:
{
"id": "cus_abc123",
"object": "customer",
"created_at": "2026-01-15T10:00:00.000Z",
"updated_at": "2026-01-15T10:00:00.000Z"
}List endpoints return paginated results:
{
"object": "list",
"data": [],
"has_more": true,
"cursor": "cur_xyz789"
}Rate Limits
| Plan | Requests/Second | Requests/Day |
|---|---|---|
| Sandbox | 10 | 10,000 |
| Production | 100 | 1,000,000 |
| Enterprise | Custom | Custom |
SDKs
# TypeScript/JavaScript
npm install @luxbank/sdk
# Python
pip install luxbank
# Go
go get github.com/luxfi/sdk-goQuick Start
import { Lux } from '@luxbank/sdk';
const lux = new Lux({
apiKey: 'sk_live_your_api_key',
});
const customer = await lux.customers.create({
email: 'user@example.com',
first_name: 'John',
last_name: 'Doe',
type: 'individual',
});
const transfer = await lux.transfers.create({
amount: '1000.00',
currency: 'USD',
source: { account_id: 'acct_123' },
destination: { account_id: 'acct_456' },
});Environments
| Environment | Base URL | Purpose |
|---|---|---|
| Sandbox | https://api-sandbox.lux.financial/v0 | Testing and development |
| Production | https://api.lux.financial/v0 | Live transactions |
Idempotency
For POST requests, include an idempotency key:
curl -X POST https://api.lux.financial/v0/transfers \
-H "Api-Key: sk_live_your_api_key" \
-H "Idempotency-Key: unique-request-id-123" \
-d '{"amount": "10000.00", "currency": "USD"}'Error Format
{
"error": {
"code": "invalid_request",
"message": "The amount field is required",
"source": {
"location": "body",
"key": "amount"
}
}
}