Off-Ramp API Endpoints
POST /api/v1/settlements
Initiate a fiat withdrawal (off-ramp).
bash
curl -X POST https://api.nester.finance/api/v1/settlements \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <token>" \
-d '{
"vault_id": "vault_balanced_01",
"amount": "1000.00",
"currency": "USDC",
"fiat_currency": "NGN",
"fiat_amount": "1565000.00",
"exchange_rate": "1565.00",
"destination": {
"type": "bank_transfer",
"provider": "bank",
"account_number": "0123456789",
"account_name": "John Doe",
"bank_code": "058"
}
}'json
{
"success": true,
"data": {
"id": "settlement_abc123_uuid",
"user_id": "user_id_uuid",
"vault_id": "vault_balanced_01",
"amount": "1000.000000",
"currency": "USDC",
"fiat_currency": "NGN",
"fiat_amount": "1565000.000000",
"exchange_rate": "1565.000000",
"destination": {
"type": "bank_transfer",
"provider": "bank",
"account_number": "0123456789",
"account_name": "John Doe",
"bank_code": "058"
},
"status": "initiated",
"created_at": "2026-06-02T12:00:00Z"
}
}GET /api/v1/settlements/{id}
Track settlement progress.
bash
curl https://api.nester.finance/api/v1/settlements/settlement_abc123_uuid \
-H "Authorization: Bearer <token>"json
{
"success": true,
"data": {
"id": "settlement_abc123_uuid",
"user_id": "user_id_uuid",
"vault_id": "vault_balanced_01",
"amount": "1000.000000",
"currency": "USDC",
"fiat_currency": "NGN",
"fiat_amount": "1565000.000000",
"exchange_rate": "1565.000000",
"destination": {
"type": "bank_transfer",
"provider": "bank",
"account_number": "0123456789",
"account_name": "John Doe",
"bank_code": "058"
},
"status": "confirmed",
"created_at": "2026-06-02T12:00:00Z",
"completed_at": "2026-06-02T12:00:04Z"
}
}GET /api/v1/rates
Get a conversion exchange rate before initiating off-ramp.
bash
curl "https://api.nester.finance/api/v1/rates?base=USDC"e=NGN"json
{
"success": true,
"data": {
"base": "USDC",
"quote": "NGN",
"rate": 1565.0,
"source": "paystack",
"fetched_at": "2026-06-02T12:00:00Z",
"expires_at": "2026-06-02T12:05:00Z"
}
}