Card Credentials
The API endpoints collected in this section are for version v1 of the Card Credentials API.
Card Credentials
High-Level Description
Card Credentials APIs can be used to allow a cardholder to view their Card Credentials (Primary Account Number, Expiration Date, and CVV). This currently only works for CPS customers that are using Fiserv as their network provider. Institutions can configure particular Bank Identification Number (BIN) ranges to be eligible for this feature. This will need to be configured before attempting to view card credentials.
Use
Card Credentials APIs are useful for allowing consumers to view their card details without requiring the physical plastic. This eases ecommerce transactions and allows cardholders to use cards prior to receiving a physical card.
View Card Credentials
A consumer can retrieve their card details by either the PAN or card token of that card. The card token can also be retrieved via Card Tokenization API. If using the search-by-pan endpoint, then the PAN will need to be encrypted in the request. The flow for how this encryption functions can be seen in the reference for Encryption Utilities API. In either endpoint, the consumer will need to decrypt the response. A guide for this can be found in the above link as well.
Card Credentials Settings
Card Credential Settings are configured at an institution level and allow institutions to manage which cards are able to have their credentials viewed.
Card Credentials Eligibility
This endpoint allows a consumer to check whether or not a card or cards are eligible for this service. This endpoint takes either card tokens or encrypted PANs. The flow for how this encryption functions can be seen in the reference for Encryption Utilities API.