Toggle Auto-Earn

Toggle Auto-Earn of a user.

Toggling Auto-Earn is an async operation, which is triggered by calling this endpoint. Therefore, the response is empty.

To fetch the users current Auto-Earn status, use GET /b2b/earn/{user}.

PUT /b2b/earn/{user}/auto

Toggle Auto-Earn

cURL

curl --request PUT \
  --url https://nexus.kraken.com/b2b/earn/{user}/auto \
  --header 'API-Key: <api-key>' \
  --header 'API-Sign: <api-key>'

200

{
  "result": {}
}

Authorizations

API-Key · string · header · required

The "API-Key" header should contain your API key.

API-Sign · string · header · required

Authenticated requests should be signed with the "API-Sign" header, using a signature generated with your private key, nonce, encoded payload, and URI path.

Headers

Payward-Version · enum<string> · default: 2025-04-15

The target version of the Embed API to use. The API version name is based on the date when the API version was released. For example, the API version 2025-04-15 was released on April 15, 2025.

Available options: 2025-04-15

Path Parameters

user · string · required

User to toggle the Auto-Earn status for Internet International Bank Account Number (IIBAN)

Required string length: 14 - 42

Query Parameters

want_enabled · boolean · required

Whether to enable or disable Auto-Earn

Response

200

application/json

Successful response indicating the Auto-Earn toggle operation was triggered. The response body is empty on success.

result · object