Skip to main content

Getting Started

A step by step guide in in how to implement the API in various scenarios:



note

You must have an active subscription



Which credit cards allow the conversion of points into Hilton Honors?​


  1. Call the GET Transfer Program List endopoint to retrieve the entire list of transfer programs
HTTP REQUEST
GET /creditcard-pointtransfer-transferprogramlist/

  1. Look through the list for Hilton and the transferPartnerId
RESPONSE
  {
    "transferPartnerName": "Hilton Honors",
    "transferPartnerId": 1722165547
  }

  1. With that transferPartnerId (1722165547) call the GET Transfer Program Card endopoint and pass in the transferPartnerId as a parameter
HTTP REQUEST
GET /creditcard-pointtransfer-transferprogramcard/1722165547

  1. The response will contain a list of credit cards and detailed information about the transfer rates
RESPONSE
  {
    "transferPartnerName": "Hilton Honors",
    "transferPartnerId": 1722165547,
    "cardKey": "amex-platinum",
    "cardName": "The Platinum Card®",
    "cardIssuer": "American Express",
    "rewardProgramName": "American Express Membership Rewards",
    "baseSpendAmount": 1.0,
    "spendTotal": 2.0,
    "transferRatio": 2.0,
    "bonusRatio": 0.0,
    "totalRatio": 2.0,
    "bonusDateEnd": ""
  }

  1. For more detailed information about a specific card in the list, pass in the cardKey (amex-platinum) to the GET Card Detail endopoint
HTTP REQUEST
GET /creditcard-detail-bycard/amex-platinum

I'd like to search for all cards that have "IHG" in the name​

  1. Call the GET Search Card By Name endopoint and pass in IHG as a parameter
HTTP REQUEST
GET /creditcard-detail-namesearch/IHG
  1. The response will return a list of all cards with IHG in the name
RESPONSE
[
  {
    "cardKey": "chase-biz-ihgpremier",
    "cardIssuer": "Chase",
    "cardName": "IHG® Rewards Premier Business"
  },
  {
    "cardKey": "chase-biz-ihgrewards",
    "cardIssuer": "Chase",
    "cardName": "IHG® Rewards Business"
  },
  {
    "cardKey": "chase-ihgpremier",
    "cardIssuer": "Chase",
    "cardName": "IHG® Rewards Premier"
  },
  {
    "cardKey": "chase-ihgrewardsclassic",
    "cardIssuer": "Chase",
    "cardName": "IHG® Rewards Classic"
  },
  {
    "cardKey": "chase-ihgrewardsselect",
    "cardIssuer": "Chase",
    "cardName": "IHG® Rewards Select"
  },
  {
    "cardKey": "chase-ihgtraveler",
    "cardIssuer": "Chase",
    "cardName": "IHG® Rewards Traveler"
  }
]
  1. For more detailed information about a specific card in the list, pass in a cardKey (chase-ihgrewardsselect) to the GET Card Detail endopoint
HTTP REQUEST
GET /creditcard-detail-bycard/chase-ihgrewardsselect

What cards offer a spend bonus at grocery stores?​


  1. Call the GET Spend Bonus Category List endopoint to retrieve the entire list of spend bonus categories
HTTP REQUEST
GET /creditcard-spendbonuscategory-categorylist/

  1. Look through the list for "Grocery Stores" and the spendBonusCategoryId
RESPONSE
{
     "spendBonusCategoryName": "Grocery Stores",
     "spendBonusCategoryId": 1132334901
}

  1. With that spendBonusCategoryId (1132334901) call the GET Spend Bonus Category Card endopoint and pass in the spendBonusCategoryId as a parameter
HTTP REQUEST
GET /creditcard-spendbonuscategory-categorycard/1132334901

  1. The response will contain a list of credit cards and detailed information about the spend rates at Grocery Stores
RESPONSE
  {
    "cardKey": "chase-freedomflex",
    "cardName": "Chase Freedom Flex®",
    "cardIssuer": "Chase",
    "cardNetwork": "Mastercard",
    "categoryType": "Multi Category",
    "spendBonusCategoryName": "Grocery Stores",
    "spendBonusCategoryId": 1132334901,
    "spendBonusDesc": "Earn 5% at Grocery Stores (excluding Walmart® and Target®)",
    "earnMultiplier": 5.0,
    "spendType": "Cash",
    "isDateLimit": 1,
    "limitBeginDate": "2024-01-01",
    "limitEndDate": "2024-03-31",
    "isSpendLimit": 1,
    "spendLimit": 1500,
    "spendLimitResetPeriod": "Quarter"
  }
  1. For more detailed information about a specific card in the list, pass in the cardKey (chase-freedomflex) to the GET Card Detail endopoint
HTTP REQUEST
GET /creditcard-detail-bycard/chase-freedomflex