Savings

Claim interest

Claims all accrued interest for the given currency's savings account.

The savings account is resolved automatically from the wallet associated with the API key - no account ID is required. Interest is credited directly to the authenticated wallet.

Requires the savings permission on the API key.

post/savings/interest/claim

Request

Base URL
https://api.altcointrader.co.za
Auth
API key in header X-API-KEY and API key in header X-TIMESTAMP and API key in header X-SIGNATURE
TypeScript
https://skmtc.dev/altcointrader/apis/altcointrader-api/docs/savings/interest/claim/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

currencystring required

Currency whose accrued interest should be claimed.

idempotency_keystring

Optional idempotency key. Duplicate requests with the same key return the original result.

memostring

Optional memo attached to this claim.

Example request

{
  "currency": "USDT",
  "idempotency_key": "550e8400-e29b-41d4-a716-446655440001"
}

Response

Interest claimed successfully.

Example response

{
  "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.