---
title: "Claim interest"
method: POST
path: "/savings/interest/claim"
tags: ["Savings"]
---

# Claim interest

`POST /savings/interest/claim`

## Request

- Base URL: `https://api.altcointrader.co.za`
- URL: `https://api.altcointrader.co.za/savings/interest/claim`
- 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)

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.

## Request body

- ClaimInterestRequest: Claim all accrued interest for the given currency's savings account. The savings account is resolved automatically from the wallet ID associated with the API key - no account ID is required. Interest is credited to the authenticated wallet.
  - `currency` string, required: Currency whose accrued interest should be claimed.
  - `idempotency_key` string: Optional idempotency key. Duplicate requests with the same key return the original result.
  - `memo` string: Optional memo attached to this claim.

## Response `200`

Interest claimed successfully.

- ClaimInterestResponse
  - `claim` SavingsInterestClaim
    - `id` string
    - `savings_account_id` string
    - `currency` string
    - `amount` string: Interest claimed as a decimal string scaled to 8 decimal places.
    - `accrual_start_at` integer, nullable
    - `accrual_end_at` integer, nullable
    - `claimed_at` integer, nullable
  - `balance` SavingsBalance
    - `savings_account_id` string
    - `currency` string
    - `capital_contributions` string: Total capital deposited, as a decimal string scaled to 8 decimal places.
    - `claimed_interest` string: Total interest already claimed.
    - `unclaimed_interest` string: Interest accrued but not yet claimed.
    - `calculated_at` integer, nullable

## Other responses

- `400`: Invalid request parameters.
- `401`: Missing or invalid authentication headers.
- `403`: API key does not have permission for this action.
- `429`: Rate limit exceeded.
- `503`: Service temporarily unavailable.

---

[API](https://skmtc.dev/altcointrader/apis/altcointrader-api.md) - [All operations](https://skmtc.dev/altcointrader/apis/altcointrader-api/llms.txt) - [OpenAPI document](https://skmtc.dev/altcointrader/apis/altcointrader-api/revisions/eaa78e9afdc2?raw)