API Tokenization
Introduction
This guide provides implementation details to tokenize a credit card using an API call. The returned credit card token can be used for any further calls for processing transactions.
Credit card tokenization calls
HostedPCI API provides a two-step(setup and mapping) or single-step (direct) process to convert the credit card to a form compatible token.
The two steps process requires a call to set up a conversion call and then a mapping call to covert the credit card number. The request ID and response from the setup call need to be returned for the tokenization call.
The one-step direct call does not require the setup call and is recommended for most operations.
One Step – Direct Credit Card Tokenization Process
The one-step direct process only requires a single API call to convert the Credit Card number and CVV to HPCI Token.
API Endpoint:
https://< site specific api URL>/iSynSApp/mapCCNumAPI.action?apiVersion=1.0.1&userName=&userPassKey=&apiType=pxyhpci&callMode=direct&ccNum=4111111111111111&ccCVV=123
Parameter List
| Parameter Name | Parameter Value |
|---|---|
| userName | [API Username] |
| userPassKey | [API Userpasskey] |
| apiVersion | 1.0.1 |
| apiType | pxyhpci |
| callMode | direct |
| ccNum | [Credit card number with any spaces and hyphens] |
| ccCVV | Optional [Card verification code (CVV) for the credit card] |
If the call is successful the following return parameters will be provided in a URL encoded result set:
Direct Call Successful Response
status=success&callMode=direct&mappedCC=4111000018801111&mappedCVV=200&ccBIN=411111
Response Parameter list
| Response Parameter Name | Response Parameter Values |
|---|---|
| status | Success | error |
| callMode | map | direct |
| mappedCC | Mapped Credit Card Token for the future use. |
| mappedCVV | Mapped CVV valid for use until the first call with the credit card token or 20 minutes. This value is available only if a valid value for CVV is provided in the map call. |
| ccBIN | First 6 digits of the credit card (BIN Number). |