Set auto earn preferences - Payward Developer Documentation

curl --request PATCH \
  --url https://api.services.payward.com/v1/accounts/{account_id}/earn/auto \
  --header 'API-Key: <api-key>' \
  --header 'API-Nonce: <api-key>' \
  --header 'API-Sign: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "staking": "enabled"
}
'

{
  "data": {}
}

{
  "error": {
    "type": "<string>",
    "status": 400,
    "instance": "<string>",
    "code": "bad_request",
    "doc_url": "<string>",
    "causes": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 401,
    "instance": "<string>",
    "code": "unauthenticated",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 403,
    "instance": "<string>",
    "code": "forbidden",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 404,
    "instance": "<string>",
    "code": "account_not_found",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 409,
    "instance": "<string>",
    "code": "allocation_in_progress",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 429,
    "instance": "<string>",
    "code": "resource_exhausted",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 500,
    "instance": "<string>",
    "code": "internal",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 501,
    "instance": "<string>",
    "code": "unimplemented",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 503,
    "instance": "<string>",
    "code": "unavailable",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 504,
    "instance": "<string>",
    "code": "deadline_exceeded",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

PATCH

accounts

{account_id}

earn

auto

curl --request PATCH \
  --url https://api.services.payward.com/v1/accounts/{account_id}/earn/auto \
  --header 'API-Key: <api-key>' \
  --header 'API-Nonce: <api-key>' \
  --header 'API-Sign: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "staking": "enabled"
}
'

{
  "data": {}
}

{
  "error": {
    "type": "<string>",
    "status": 400,
    "instance": "<string>",
    "code": "bad_request",
    "doc_url": "<string>",
    "causes": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 401,
    "instance": "<string>",
    "code": "unauthenticated",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 403,
    "instance": "<string>",
    "code": "forbidden",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 404,
    "instance": "<string>",
    "code": "account_not_found",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 409,
    "instance": "<string>",
    "code": "allocation_in_progress",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 429,
    "instance": "<string>",
    "code": "resource_exhausted",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 500,
    "instance": "<string>",
    "code": "internal",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 501,
    "instance": "<string>",
    "code": "unimplemented",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 503,
    "instance": "<string>",
    "code": "unavailable",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 504,
    "instance": "<string>",
    "code": "deadline_exceeded",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

Authorizations

API-Key

string

header

required

Your public API key. Identifies the partner making the request.

API-Nonce

string

header

required

Monotonically increasing nonce included in the request signature.

API-Sign

string

header

required

HMAC signature over the request, computed with your private key.

Path Parameters

account_id

string

required

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

Pattern: ^[A-Z0-9]{16}$

Body

application/json

Request to set auto-earn preferences for an account.

staking

enum<string>

Staking auto-earn preference. Omit to leave unchanged.

Available options:

enabled,

disabled

base_rewards

enum<string>

Base-rewards auto-earn preference. Omit to leave unchanged.

Available options:

enabled,

disabled

Response

Successful response

data

object

required

Empty data object.

Get auto earn preferences Get auto earn allocations

⌘I