Claim rewards on behalf of the user

POST 
/api/users/by-id/:userId/rewards/claim

Claim rewards on behalf of the user. The whole unclaimed confirmed amount is paid out as the selected product, so it must be at least $1 and within the product's minAmount and maxAmount (see GET /api/rewards/products?userId=...).

Request

Path Parameters

userId stringrequired

Query Parameters

product stringrequired
language string

Default value: en

Responses

200

The link to claim the reward.

application/json

Schema

Schema

rewardDeliveryLink string

Link for user to claim the reward

Example (from schema)

{
  "rewardDeliveryLink": "string"
}

400

Invalid parameters. Possible error codes

1. ERROR_INVALID_PARAMETERS

2. ERROR_INVALID_REWARD_PRODUCT

3. ERROR_REWARD_ABOVE_PRODUCT_MAXIMUM

application/json

Schema

Schema

error_code string

Error code

error_message string

A verbose error message

Example (from schema)

{
  "error_code": "string",
  "error_message": "string"
}

401

Authorization error e.g. due to an invalid or missing API keys.

403

Forbidden. Possible error codes

1. ERROR_NO_PERMISSIONS_TO_RESOURCE

application/json

Schema

Schema

error_code string

Error code

error_message string

A verbose error message

Example (from schema)

{
  "error_code": "string",
  "error_message": "string"
}

404

User not found. Possible error codes

1. ERROR_USER_NOT_FOUND

application/json

Schema

Schema

error_code string

Error code

error_message string

A verbose error message

Example (from schema)

{
  "error_code": "string",
  "error_message": "string"
}

429

Too many claims right now; try again later. Possible error codes

1. ERROR_CLAIM_LIMIT_REACHED

application/json

Schema

Schema

error_code string

Error code

error_message string

A verbose error message

Example (from schema)

{
  "error_code": "string",
  "error_message": "string"
}

500

Internal error. Possible error codes

1. INTERNAL_SERVER_ERROR

2. ERROR_MINIMUM_REWARD_THRESHOLD_NOT_MET,

3. ERROR_NO_CONFIRMED_REWARDS,

4. ERROR_CLAIMING_REWARDS

application/json

Schema

Schema

error_code string

Error code

error_message string

A verbose error message

Example (from schema)

{
  "error_code": "string",
  "error_message": "string"
}

Loading...