Savings
Withdraw capital
Withdraws (reclaims) contributed capital from the savings account for the given currency. Capital is credited directly to the authenticated wallet.
Any accrued interest is automatically claimed at the same time and returned in the response as interest_claim (omitted if no interest had accrued).
The savings account is resolved automatically - no account ID is required.
Requires the savings permission on the API key.
post/savings/capital/withdraw
Request
- Base URLhttps://api.altcointrader.co.za
- AuthAPI key in header X-API-KEY and API key in header X-TIMESTAMP and API key in header X-SIGNATURE
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Request body
Example request
{
"currency": "USDT",
"amount": "250.00",
"idempotency_key": "550e8400-e29b-41d4-a716-446655440002"
}Response
Capital withdrawn successfully.
Example response
{
"withdrawal": {
"id": "wd-001",
"savings_account_id": "sav-001",
"currency": "USDT",
"amount": "250.00000000",
"withdrawn_at": 1712000000
},
"interest_claim": {
"id": "claim-001",
"savings_account_id": "sav-001",
"currency": "USDT",
"amount": "3.20000000",
"accrual_start_at": 1710000000,
"accrual_end_at": 1712000000,
"claimed_at": 1712000100
},
"balance": {
"savings_account_id": "sav-001",
"currency": "USDT",
"capital_contributions": "1000.00000000",
"claimed_interest": "12.50000000",
"unclaimed_interest": "3.20000000",
"calculated_at": 1712000000
}
}Changes
No recorded changes to this operation across all 3 revisions of this API.