Rewards
Get rewards-related data like miles, cash, points, and more.
This product and its documentation are under active beta development; details and functionality may change at any time. Additionally, this page is only accessible with a direct link. You will need the link for this page every time you want to access it.
Use our Rewards API endpoints for Platform API to gather rewards-related data like miles, cash, points, etc. The data can then be delivered to an end user or integrated into your product however you need.
Gathering rewards information is an aggregation process. This means the overall workflow is similar to other aggregation processes like Account Aggregation and Instant Account Verification, and the state of each process can be checked using the read member connection status endpoint.
Quick Links
Rewards Sample Data
This sample response shows the data you can expect to get for a reward account.
_14{_14 "reward": {_14 "account_guid": "ACT-1234",_14 "balance_type": "EXPIRING_BALANCE",_14 "balance": 102,_14 "created_at": "2020-01-28T21:09:01+0000",_14 "description": "A description of the reward.",_14 "expires_on": "2020-02-28",_14 "guid": "RWD-1234",_14 "member_guid": "MBR-4567",_14 "unit_type": "POINTS",_14 "user_guid": "USR-1234"_14 }_14}
Credit Card Sample Data
This sample response shows the data you can expect to get for a credit card product.
_18{_18 "reward": {_18 "annual_fee": 45,_18 "duration_of_introductory_rate_on_balance_transfer": null,_18 "duration_of_introductory_rate_on_purchases": null,_18 "guid": "CCA-b5bcd822-6d01-4e23-b8d6-846a225e714a",_18 "has_cashback_rewards": false,_18 "has_other_rewards": true,_18 "has_travel_rewards": true,_18 "has_zero_introductory_annual_fee": true,_18 "has_zero_percent_introductory_rate": false,_18 "has_zero_percent_introductory_rate_on_balance_transfer": true,_18 "financial_institution": true,_18 "is_accepting_applications": true,_18 "is_small_business_card": true,_18 "name": "Chase Credit Card"_18 }_18}