Tender Type Lookup

Overview

A TenderType Lookup call returns the tender type configured for a specific combination of PaymentAccountUniqueID, Tender Class, and Currency Code. The returned tender type can then be used for subsequent calls for the current transaction involving the payment account.

URI Summary

Action	URI Template	URI Example	Non-URI Request	Response
POST	/vM.m/stores/[StoreId]/payments/tendertype/lookup.xml	/vM.m/stores/TMSUS/ payments/tendertype/lookup.xml	XML	Response Code + XML Response containing the tender type of the PAN from the request

Request Format

The request is a TenderTypeLookupRequestType message.

<xml version="1.0" encoding="UTF-8" xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
  <TenderTypeLookupRequestType sessionId=sessionId>
    <PaymentAccountUniqueId>PAUID</PaymentAccountUniqueId>
    <TenderClass>TenderClass</TenderClass>
    <CurrencyCode>CurrencyCode</CurrencyCode>
  </TenderTypeLookupRequestType>

Request Elements

Element	Required	Description	Type	Restriction
sessionId	No	The session ID of the request. A unique identifier used to avoid processing duplicate requests.	String	40 Characters
PaymentAccountUniqueId	Required	The Payment Account Unique ID of the tender that is to be looked up	String	22 Characters
-isToken	Required if PaymentAccountUniqueId is present	Is the PaymentAccountUniqueId a token?	Boolean	true/false
TenderClass	Required	The tender type of the PAN to be tokenized.	String	PrivateLabelCreditCard, CreditCard, StoredValue
CurrencyCode	Required	The code that represents the type of currency.	String	IS-4217 three-letter code

Request Example

<?xml version="1.0" encoding="UTF-8"?>
  <TenderTypeLookupRequest xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
    <PaymentAccountUniqueId isToken="false">4111111111111111</PaymentAccountUniqueId>
    <TenderClass>CreditCard</TenderClass>
    <CurrencyCode>USD</CurrencyCode>
  </TenderTypeLookupRequest>

Response Format

The response is a TenderTypeLookup Reply message.

<?xml version="1.0" encoding="UTF-8"?>
  <TenderTypeLookupReply xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
    <TenderType>TenderType</TenderType>
    <ResponseCode>ResponseCodeEnum</ResponseCode>
  </TenderTypeLookupReply>

Response Elements

Element	Required	Description	Type	Restriction
TenderType	Yes	The TenderType of the payment method sent in the request. For a list of common tender types, see Tender Types.	String	2-4 Characters
ResponseCode	Yes	The enumerated response code for the lookup	Enumerated String	See list of values below.

ResponseCode Values

Code	Description
TENDER_TYPE_FOUND	A matching tender type is found by account number, tender class, currency code and store ID.
PAN_FAILS_LUHN_CHECK	The account number fails to pass Luhn check. For more information, see http://en.wikipedia.org/wiki/Luhn_algorithm.
NO_TENDER_TYPE_FOUND	No tender type matches the account number, tender class, currency code, and store ID.
PAN_NOT_CONFIGURED_TO_STORE	Tender type matches the account number, tender class, and currency code, but not the store ID.
UNKNOWN_FAILURE	Failed to find a tender type for unknown causes.

Response Example

<?xml version="1.0" encoding="UTF-8"?>
  <TenderTypeLookupReply xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
    <TenderType>VC</TenderType>
    <ResponseCode>TENDER_TYPE_FOUND</ResponseCode>
  </TenderTypeLookupReply>