Retrieve card by PAN

POST//

Retrieves the user_token and card_token for a primary account number (PAN). In the case of a reissued card, where multiple cards share the same PAN, the information for the most recently issued card is returned. This request is useful in IVR scenarios where a user has telephoned and identifies the card by the PAN. The retrieval of these tokens is implemented as a POST request because supplying the PAN in the request body is more secure than supplying it in the URL (as would be required with a GET).

Warning
Sending a request to this endpoint requires PCI DSS compliance. You must comply with PCI DSS data security requirements if you want to store, transmit, or process sensitive card data such as the cardholder’s primary account number (PAN), personal identification number (PIN), and card expiration date.

Request body

Fields	Description
cvv_number string Optional	Three-digit card verification value (CVV2) included on the back of the card. This value cannot be updated. Allowable Values: 3 char max
expiration string Optional	Card expiration date. Allowable Values: Format: MMyy
pan string Required	Primary account number (PAN) of the card whose information you want to retrieve. Send a `GET` request to `/cards/{token}/showpan` to retrieve the PAN for a specific card. Allowable Values: 16 char max

Sample request body

JSON

{
  "pan": "5454545454545454"
}

Response body

Fields	Description
card_token string Returned	Unique identifier of the card. Allowable Values: Existing card token
created_time datetime Returned	Date and time when the resource was created, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ
last_modified_time datetime Returned	Date and time when the resource was last modified, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ
user_token string Returned	Unique identifier of the cardholder. Allowable Values: Existing user token

Sample response body

JSON

{
  "user_token": "my_user",
  "card_token": "my_card1",
  "created_time": "2022-02-26T20:03:15Z",
  "last_modified_time": "2022-02-26T20:05:20Z"
}

Getting Started

Testing

Card Issuing

Card Processing

Accounts & Money Movement

Risk, Fraud, and Disputes

Cardholder User Experience

Request body

Sample request body

Response body

Sample response body

​Request body

​Sample request body

​Response body

​Sample response body

Request body

Sample request body

Response body

Sample response body