Earn
Deactivate Earn
Deactivates earn for a user. Their balance stops generating yield.
Request
| Field | Type | Required | Description |
|---|---|---|---|
| Authorization | Header | Yes | Bearer <access_token> obtained from POST /api/v1/client/token. |
| user_id | Path | Yes | Identifier of the user. |
Response
| Field | Description |
|---|---|
| id | Identifier of the user’s earn account. |
| status | Status of the account. |
| earnEnabled | Whether earn is active for the user. |
| accumulatedEarnings | Earnings accumulated so far, or null. |
| annualRateLabel | Annual rate shown to the user or null. |
| registerDate | Creation date of the account. |
PATCH
Deactivate Earn