Validate Card

Overview

Validation of credit card details is supported by this API. It does appropriate verification or minimum amount authorization as supported through payment processor. It will also initiate authorization cancel wherever possible. This API works for both PLCC and CC tenders. URIs mentioned below have to be used accordingly.

URI Summary

Action	URI Template	URI Example	Non-URI Request	Response
POST	/v1.0/stores/[StoreId]/payments/ creditcard/validate/[tenderCode].[format]	/v1.0/stores/QUIK/payments/ creditcard/validate/VC.xml	XML	200 + XML Response containing response status of the validity of the card details provided.

Action	URI Template	URI Example	Non-URI Request	Response
POST	/v1.0/stores/[StoreId]/payments/ plcc/validate/[tenderCode].[format]	/v1.0/stores/QUIK/payments/ plcc/validate/GE.xml	XML	200 + XML Response containing response status of the validity of the card details provided.

Request Example

<?xml version="1.0" encoding="UTF-8"?>
<ValidateCardRequest xmlns="http://api.gsicommerce.com/schema/checkout/1.0" requestId="1234567890ABCD">
   <PaymentContext>
      <OrderId>OrderId0</OrderId>
      <PaymentAccountUniqueId isToken="false">PaymentAccountUniqueId</PaymentAccountUniqueId>
   </PaymentContext>
   <ExpirationDate>2013-09</ExpirationDate>
   <CardSecurityCode>123</CardSecurityCode>
   <CurrencyCode>USD</CurrencyCode>
   <BillingFirstName>John</BillingFirstName>
   <BillingLastName>Smith</BillingLastName>
   <BillingPhoneNo>6101234567</BillingPhoneNo>
   <BillingAddress>
      <Line1>123 Main St</Line1>
      <Line2>Building 123</Line2>
      <Line3>4th Floor</Line3>
      <Line4>Apt 12</Line4>
      <City>Philadelphia</City>
      <MainDivision>PA</MainDivision>
      <CountryCode>US</CountryCode>
      <PostalCode>19019</PostalCode>
   </BillingAddress>
   <CustomerEmail>customer@sample.com</CustomerEmail>
   <CustomerIPAddress>208.247.73.130</CustomerIPAddress>
</ValidateCardRequest>

Request Elements

Element	Required	Description	Type	Restriction
PaymentContext	Yes	Unique identifier of the payment transaction for the order	ComplexType
PaymentContext/ OrderId	Yes	Unique identifier of the order. The client must ensure uniqueness of OrderIds across all transactions that the client initiates with this service.	String	Max 20 characters
PaymentContext/ PaymentAccountUniqueId	Yes - Either PaymentAccountUniqueId or EncryptedPayment AccountUniqueId must be present.	Either a raw PAN (payment account number such as a credit card number) or a token representing a PAN	String	Max 22 characters
PaymentContext/ PaymentAccountUniqueId @isToken	Yes (when PaymentAccountUniqueId is present)	Attribute that indicates whether the payment account number is tokenized	String	true or false
PaymentContext/ EncryptedPaymentAccount UniqueId	Yes - Either PaymentAccountUniqueId or EncryptedPayment AccountUniqueId must be present.	Client-encrypted PAN. Used for clients who use client-side encryption to encrypt credit card numbers in the JavaScript that runs in their browser. For a webstore that is not PCI compliant, this ensures that the webstore never sees raw PANs.	String	Max 1000 characters
ExpirationDate	Yes	Expiration date of the credit card	String	yyyy-MM (year followed by month)
CardSecurityCode	Yes - Either CardSecurityCode or EncryptedCardSecurityCode must be present.	CVV2 code on the back of the credit card	String	3 or 4 digits
EncryptedCardSecurityCode	No. This optional field can either have CardSecurityCode or EncryptedCardSecurityCode.	Encrypted CVV2 code on the back of the credit card	String	1000 digits
CurrencyCode	Yes	CurrencyCode that the store is configured to process credit card requests	String	3-character ISO 4217 code (for example, USD, CAD, EUR). See http://en.wikipedia.org/ wiki/ISO_4217.
BillingFirstName	Yes	First name of the person on the billing address of the credit card	String	Max 64 characters
BillingLastName	Yes	Last name of the person on the billing address of the credit card	String	Max 64 characters
BillingPhoneNo	Yes	Phone number of the person on the billing address of the credit card	String	Max 15 characters
BillingAddress	Yes (for AVS verification)	Billing address of the credit card	ComplexType
BillingAddress/ Line1	Yes	Line# components of the billing street address and, if necessary, suite and building identifiers for the physical address. Line1 is required. Other Line# components are optional.	String	Max 70 characters
BillingAddress/ Line2	No		String	Max 70 characters
BillingAddress Line3	No		String	Max 70 characters
BillingAddres Line4	No		String	Max70 characters
BillingAddress/ City	Yes	Name of the city	String	Max 40 characters
BillingAddress/ MainDivision	Yes	Two- or three-digit postal abbreviation for the state or province. The ISO 3166-2 code is recommended, but not required. See http://en.wikipedia.org/wiki/ISO_3166-2.	String	Max 30 characters
BillingAddress/ CountryCode	Yes	Two digit country code. The ISO 3166 alpha 2 code is recommended, but not required. See: http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2.	String	2-40 characters
BillingAddress/ PostalCode	Depends on country. Yes for US and Canada	String of letters and/or numbers that specifies the delivery area more closely than the city alone (for example, US ZIP code)	String	Max 30 characters
CustomerEmail	Yes	Email address of the customer who is making the purchase. Used for realtime fraud checking by our API and payment processors.	String	Max 70 characters
CustomerIPAddress	Yes	IP address of the customer who is making the purchase. Used for realtime fraud checking by our API and payment processors.	String	Max 70 characters
requestId	Yes	RequestId globally identifies a request message and is used to protect against duplicate request processing	String	Up to 40 Characters.

Response Example

The response is a ValidateCardReply message.

<?xml version="1.0" encoding="UTF-8"?>
<ValidateCardReply xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
   <PaymentContext>
      <OrderId>12345</OrderId>
      <!-- You will receive a token in the response, which is a scrambled version of the
      Credit Card number.-->
      <PaymentAccountUniqueId isToken="true">411111adgh2y1111</PaymentAccountUniqueId>
   </PaymentContext>
   <ResponseCode>VALID</ResponseCode>
</ValidateCardAuthReply>

Response Elements

Element	Required	Description	Type	Restriction
PaymentContext	Yes	Unique identifier of the payment transaction for the order	ComplexType
PaymentContext/ OrderId	Yes	Unique identifier of the order. The client must ensure uniqueness of OrderIds across all transactions that the client initiates with this service.	String	Max 20 characters
PaymentContext/ PaymentAccountUniqueId	Yes	Token (scrambled version) of the PAN (payment account number such as a credit card number). When passing the PAN for the PaymentAuthCancelRequest and the PaymentSettlementRequest messages, always use the returned token, not the original PAN.	String	Max 22 characters
PaymentContext/ PaymentAccountUniqueId/ @isToken	Yes	Attribute that indicates whether the PAN is tokenized. In the CreditCardAuthReply message, this attribute is always set to true.	String	true
ResponseCode	Yes	Response code of the Validate card request. Includes valid, invalid, timeout, and several correction codes. See Validate Card Response Codes for a list of codes.	String	Max 7 characters.