Protect PAN

Overview

A protect PAN call is made to take a PAN (payment account number) and receive a token value to represent the PAN. This token is stored and used in subsequent API calls. Using the token is a security practice that limits the exposure of the private information of the PAN.

URI Summary

Action	URI Template	URI Example	Non-URI Request	Response
POST	/vM.m/stores/[StoreId]/payments/pan/protect.xml	/vM.m/stores/TMSUS/ payments/pan/protect.xml	XML	200 + XML Response containing the tokenized PAN

Request Format

The request is a ProtectPanRequest message.

<?xml version="1.0" encoding="UTF-8"?>
  <ProtectPanRequest xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
    <PaymentAccountNumber>{PAN}</PaymentAccountNumber>
    <TenderClass>{TenderClass}</TenderClass>
  </ProtectPanRequest>

Request Elements

Element	Required	Description	Type	Restriction
PaymentAccountNumber	Yes	The plain text PAN to be tokeized.	String	22 Characters
TenderClass	Yes	The tender type of the PAN to be tokenized.	String	PrivateLabelCreditCard, CreditCard, StoredValue

Request Example

<?xml version="1.0" encoding="UTF-8"?>
  <ProtectPanRequest xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
    <PaymentAccountNumber>4111111111111111</PaymentAccountNumber>
    <TenderClass>CreditCard</TenderClass>
  </ProtectPanRequest>

Response Format

The response is a ProtectPanReply message.

<?xml version="1.0" encoding="UTF-8"?>
  <ProtectPanReply xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
    <Token>{Token}</Token>
  </ProtectPanReply>

Response Elements

Element	Required	Description	Type	Restriction
Token	Yes	The tokenized value of the PAN sent in the request	String	22 Characters

Response Example

<?xml version="1.0" encoding="UTF-8"?>
  <ProtectPanReply xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
    <Token>4111110PASeK1111</Token>
  </ProtectPanReply>

Code Sample

Code samples in Java and PHP can be found here.