Rewards
The rewards summary object describes the pending, available, and earned cashback for a user. These cashback rewards depend on the offers linked to the transactions of the user.
The table below outlines the available API call and action for rewards.
Action | API call | Description |
|---|---|---|
GET /rewards/summary/{publisher_user_id} | Retrieves the summary of a specified user's rewards. |
Retrieves the summary of a specified user's rewards.
To test the API, see Get Rewards Summary for a Single User.
Name | Data type | Description |
|---|---|---|
{publisher_user_id} REQUIRED | string | Unique identifier for the user sent by the publisher, to identify a user in the publisher’s system. |
HTTP status 200
Returns an array of rewards summary object with a 200 response code, if successful. For more information, see Status and response codes.
Body
Name | Data type | Description |
|---|---|---|
available_cashback | number | The amount of cashback rewards that are ready to be redeemed. This value is based on submitted transactions for the user in the system. |
pending_cashback | number | The amount of cashback rewards that are not yet available to be redeemed. This value is based on the pending transactions for the user in the system. |
total_earned_cashback | number | The total lifetime cashback earned by the user. |
