Get reward balance by user uid
Important:
Request headers are required. See API basics introduction for more information.
Get reward balance by user uid
Endpoint
GET /reward/balance?reward_uid={uid}&user_uid={uid}
Returns the balance of a user'sreward for a given reward_uid and user_uid associated with the given App (set by the X-API-KEY).
Parameters
Query parameters
| Query parameter | Description |
|---|---|
reward_uid | The unique identifier of the reward for this app (ex. 813231035224). |
user_uid | The unique identifier of the user for this app (ex. 813231035224). |
Response
You will receive the reward balance details including the following fields:
| Response fields | Type | Description | Condition |
|---|---|---|---|
reward_uid | String | The UID of the reward supplied in the request. | Mandatory |
user_uid | String | The UID of the user supplied in the request. | Mandatory |
amount | String | The amount of rewards that the user has in their wallet | Mandatory |
Response example
{
"success": true,
"data": {
"reward_uid": "112144981245",
"user_uid": "223144788242",
"amount": "1.23",
}
}
Example
The following example fetches the balance of rewards for reward 111111111111 for the user 222222222222.
# API_KEY is your api key
# TOKEN is the access token generated with your api key secret
curl -i \
-X GET \
-H "Content-Type: application/json" \
-H "X-Api-Key: API_KEY" \
-H "Authorization: Bearer TOKEN" \
"https://api.getoriginal.com/v1/reward/balance?reward_uid=111111111111&user_uid=222222222222"
Updated about 1 month ago