AwardWallet Credit Card Bonus API

Introduction

AwardWallet Credit Card Bonus API is designed to return all the category bonuses that each individual card provides. This is a restful API and is designed to work synchronously. The API supports credit cards that are issued by the following US banks:

Amex
Bank of America
Barclays
Capital One
Chase
Citibank
Discover
U.S. Bank
Wells Fargo

Authentication

To authorize, use this code:

                    
                        # TODO: With php. Build php example

                    
# With shell, you can just pass the correct header with each request
curl "api_endpoint_here"
-H "X-Authentication: userapikey"

Every API call needs to be authenticated with an API authentication token. This token is passed in the "X-Authentication" field in the HTTPS request header. The token is formed by concatenating the API username and API password with a ":" symbol. You need to contact us to get your API credentials.

X-Authentication: YourUserName:YourPassword

Cards And Bonuses Api

Get cards and bonuses

The /cards method returns all the cards and the bonuses that they have.

Request

GET https://us-cc-api.awardwallet.com/v1/cards

Request Parameters

Parameter	Type	Required	Description
showExpiredBonuses	string	false	This is a GET parameter to be passed in the URL string as `?showExpiredBonuses=true`, if set to true the response, will contain expired bonus categories

Response Example

                            
{
  "cards": [
    {
      "cardId": 1,
      "issuingBank": "JPMorgan Chase",
      "cardName": "Chase Freedom Unlimited\u00ae",
      "cardType": "personal",
      "isCashback": false,
      "isDiscontinued": false,
      "shortEarningDescription": "5X points on travel purchased through Chase, 3X points on dining and drugstores, and 1.5X points on all other purchases",
      "awardWalletPointValue": 2.44,
      "currencyName": "Ultimate Rewards\u00ae",
      "earningCategories": [
        {
          "categoryId": 0,
          "categoryName": "All Purchases",
          "multiplier": 1.5,
          "startDate": null,
          "endDate": null,
          "description": "<strong>1.5x Ultimate Rewards\u00ae</strong><br/><sub>on all purchases</sub>"
        },
        {
          "categoryId": 1,
          "categoryName": "Dining",
          "multiplier": 3,
          "startDate": "09/15/2020",
          "endDate": null,
          "description": "<strong>3x Ultimate Rewards\u00ae</strong>"
        },
        {
          "categoryId": 28,
          "categoryName": "Drugstores & Pharmacies",
          "multiplier": 3,
          "startDate": "09/15/2020",
          "endDate": null,
          "description": "<strong>3x Ultimate Rewards\u00ae</strong>"
        }
      ],
      "earningMerchants": [
        {
          "merchantGroupId": 21,
          "merchantGroupName": "Chase Travel",
          "multiplier": 5,
          "startDate": "09/15/2020",
          "endDate": null,
          "description": "<strong>5x Ultimate Rewards\u00ae</strong> <br>\r\n<sub>on purchases made through the Chase Travel Portal</sub>",
          "merchantNames": [
            {
              "merchantId": 1458949,
              "merchantName": "Chase Travel"
            }
          ]
        }
      ]
    }
  ]
}

Response

Cards and bonuses

Parameter	Type	Required	Description
cards	array	true	An array of credit cards

Credit card

Parameter	Type	Required	Description
cardId	integer	true	A numeric value that uniquely identifies any given card
issuingBank	string	true	User-friendly display name of the bank that issues this card
cardName	string	true	User-friendly display name of the credit card. Please note, that many cards have special characters such as a reserved symbol (®), and these symbols are passed as Unicode codepoints, i.e. `\u00ae`
cardType	string	true	`cardType` can be one of to values: business personal
isCashback	boolean	true	Set to true if the card earns cash back instead of points or miles. False otherwise
isDiscontinued	boolean	true	Set to true if this card has been discontinued, meaning that you can’t apply for this card anymore. False otherwise
shortEarningDescription	string	false	A short summary of card earning
awardWalletPointValue	number	false	An average redemption value of points based on AwardWallet calculation. More info on how we calculate this value can be found here
currencyName	string	false	Name of the points currency
earningCategories	array	false	An array of categories where this card earns extra points
earningMerchants	array	false	An array of merchants where this card earns extra points

Earning Merchant

The earningMerchants array lists a group of merchants where a given card earns a special bonus multiplier. For example, a Chase Sapphire Preferred card earns 3x points on select streaming services. So a group called “Streaming Services (Chase)” will list all the streaming services where this card earns this 3x multiplier

Parameter	Type	Required	Description
merchantGroupId	integer	true	A numeric value that uniquely identifies this group of merchants
merchantGroupName	string	true	A user-friendly name of this group of merchants where this card earns a bonus multiplier
multiplier	number	true	Point or mile multiplier this card earns while shopping at merchants that are part of this group of merchants
startDate	string	false	Some bonuses are seasonal, meaning that they have start and end dates. Often banks will have quarterly bonuses, in that case, `startDate` will indicate when the bonus earning begins
endDate	string	false	If the bonus earning has an end date for this group of merchants this `endDate` attribute will reflect that date
description	string	false	Description of the bonus. I.e. “<strong>5x Ultimate Rewards\u00ae<\/strong><br\/><sub>$1,500 quarterly limit<\/sub>”
merchantNames	array	false	An array of individual merchants where this bonus earning applies

Merchant Name

We put merchantNames into its own array because we wanted to add an ID to each individual Merchant. Our data is dynamic based on actual transactions and therefore a merchant name could change over time, however, merchantID should not change

Parameter	Type	Required	Description
merchantId	integer	true	A numeric value that uniquely identifies this merchant
merchantName	string	true	A user-friendly name of the merchant where this card earns a bonus multiplier

Earning Category

The earningCategories array returns all the shopping categories where a given card has special bonuses. For example, a Chase Sapphire Reserve card will return “Dining” as a category where this card earns 3x points per spent dollar instead of 1 point

Parameter	Type	Required	Description
categoryId	integer	true	A numeric value that uniquely identifies any given shopping category
categoryName	string	true	A user-friendly name of a category where the card is earning bonus points
multiplier	number	true	Point or mile multiplier this card earns while shopping at merchants that are part of this category
startDate	string	false	Some bonus categories are seasonal, meaning that they have start and end dates. Often banks will have quarterly bonuses, in that case, `startDate` will indicate when the bonus earning begins
endDate	string	false	If the bonus earning has an end date for this category this `endDate` attribute will reflect that date
description	string	false	Description of the bonus. I.e. “<strong><strong>3x Ultimate Rewards\u00ae<\/strong>”

Errors

Error Code	Meaning
400	Bad Request
401	Unauthorized – Your API key is wrong
403	Forbidden
404	Not Found
405	Method Not Allowed – You tried to access an API with an invalid method
500	Internal Server Error – We had a problem with our server. Try again later.
503	Service Unavailable

Looking for AwardWallet logos, banners or screenshots?

We got them all organized neatly for you on this page: