Skip to main content
GET
/
v1
/
accounts
/
{account_id}
/
earn
/
auto
Get auto earn preferences
curl --request GET \
  --url https://api.services.payward.com/v1/accounts/{account_id}/earn/auto \
  --header 'api-key: <api-key>' \
  --header 'api-nonce: <api-key>' \
  --header 'api-otp: <api-key>' \
  --header 'api-sign: <api-key>'
{
  "staking": "enabled"
}

Authorizations

​
api-key
string
header
required
​
api-sign
string
header
required
​
api-nonce
string
header
required
​
api-otp
string
header
required

Path Parameters

​
account_id
string
required

ID of the account to retrieve preferences for. Refers to one of the accounts held by the user the request is acting on behalf of.

Required string length: 5 - 34
Pattern: ^[A-Z]{2}[0-9]{2}[A-Z0-9]+$

Response

Successful response

Response from GetAutoEarnPreferences.

A yield source key is only present if the account is eligible for it.

​
staking
enum<string>

Current staking auto-earn status. Absent if the account is not eligible for staking.

Available options:
enabled,
disabled,
pending_enabled,
pending_disabled