Tender Type Lookup
Overview
The TenderType Lookup API provides the tender type code configured for a specific combination of PaymentAccountUniqueID, Tender Class, and Currency Code. The returned tender type code provided can be used for subsequent calls for the current transaction involving the payment account.
URI Summary
| Action | URI Template | URI Example | Request Content Type | Response Content Type |
|---|---|---|---|---|
| POST | /vM.m/stores/{StoreId}/payments/tendertype/lookup.xml | /v1.0/stores/TMSUS/payments/tendertype/lookup.xml | application/xml or text/xml | application/xml or text/xml |
Request Elements
| Element | Required | Description | Type | Restriction |
|---|---|---|---|---|
| PaymentAccountUniqueId | Yes | The Payment Account Unique ID of the tender that is to be looked up | String | 22 Characters |
| PaymentAccountUniqueId @isToken |
Yes | Attribute that indicates whether the payment account number is tokenized | String | true or false |
| TenderClass | Yes | Tender Class for for the PaymentAccountUniqueId | Enum | PrivateLabelCreditCard, CreditCard, StoredValue |
| CurrencyCode | Required | The code that represents the type of currency. | String | 3-character ISO 4217 code (for example, USD, CAD, EUR). See http://en.wikipedia.org/wiki/ISO_4217. |
Request Example
Copy
<?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 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 | Enum | 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
Copy
<?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>