Vault Tenders

Overview

The VaultTenders API call retrieves a list of active tenders associated with an existing vault.

URI Summary

Action	URI Template	URI Example	Non-URI Request	Response
POST	/v1.0/stores/[StoreId]/payments/ vault/tenders.[format]	/v1.0/stores/TMSNA/payments/ vault/tenders.xml	XML	200 + XML Response containing the status of the vault.

Request Format

The request is a VaultTendersRequest message.

<?xml version="1.0" encoding="UTF-8"?>
<VaultTendersRequest xmlns="http://api.gsicommerce.com/schema/checkout/1.0"
      requestId="12345">
  <VaultId>123456</VaultId>
</VaultTendersRequest>

Request Elements

Element	Required	Description	Type	Restriction
VaultId	Yes	Unique identifier for the vault.	String	1 to 38 numeric characters
requestId	Yes	RequestId globally identifies a request message and is used to protect against duplicate request processing.	String	Up to 40 characters

Response Format

The response is a VaultTendersReply message.

<?xml version="1.0" encoding="UTF-8"?>
<VaultTendersReply xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
  <VaultId>123456</VaultId>
  <VaultTenders>
      <VaultTenderId>3</VaultTenderId>
      <Active>true</Active>
      <TenderClass>CreditCard</TenderClass>
      <TenderType>GE</TenderType>
      <TenderDescription>GE PLCC</TenderDescription>
      <MaskedPan>#######4570</MaskedPan>
      <ExpirationDate>2015-05</ExpirationDate>
      <Notes>PLCC1</Notes>
      <Selected>false</Selected>
   </VaultTenders>
   <VaultTenders>
      <VaultTenderId>4</VaultTenderId>
      <Active>true</Active>
      <TenderClass>StoredValue</TenderClass>
      <TenderType>VL</TenderType>
      <TenderDescription>Value Link Gift Card</TenderDescription>
      <MaskedPan>######4570</MaskedPan>
      <Notes>StoreValue1</Notes>
      <Selected>false</Selected>
   </VaultTenders>
</VaultTendersReply>

Response Elements

Element	Required	Description	Type	Restriction
VaultId	Yes	Vault identifier echoed back from the request message.	String	1 to 38 numeric characters
VaultTenders	No	A complex element which contains a vault tender.	ComplexType	There is no restriction on minimum or maximum occurrences.
VaultTenderId	Yes	Unique identifier for the vault tender. Part of complexType VaultTenders.	String	1 to 40 characters.
Active	Yes	The status of the vault tender: true if active; false if inactive.	Boolean	true, false
TenderClass	Yes	The tender class of the PAN to be tokenized.	String	PrivateLabelCreditCard, CreditCard, StoredValue
TenderType	Yes	The tender type value of the tender.	String	2 to 4 characters. Examples: VC, MC
TenderDescription	Yes	The tender description.	String
MaskedPan	Yes	The masked version of the account number (PAN) associated with the tender.	String
BillingPersonName	No	The name of the customer associated with billing for the vault tender.	String
BillingAddress	No	The customer's billing address.	AddressType
ExpirationDate	No	Expiration date of the card associated with the vault tender.	String	Year followed by month, in yyyy-MM format
Notes	No	Memo or alias associated with this specific tender; can be changed by customer.	String	Max 512 characters
Selected	No	Indicates whether a given vault tender is selected. A selected tender would be used for payments.	Boolean	true, false