Vault Update Credit Card

Overview

The VaultUpdateCreditCard API call updates an existing credit card in an active vault.

URI Summary

Action	URI Template	URI Example	Non-URI Request	Response
POST	/v1.0/stores/[StoreId]/payments/ vault/creditcard/update/[tenderCode].[format]	/v1.0/stores/TMSNA/payments/ vault/creditcard/update/VC.xml	XML	200 + XML Response containing the response status of updating the existing credit card in the vault.

Request Format

The request is a VaultUpdateCreditCardRequest message.

<?xml version="1.0" encoding="UTF-8"?>
<VaultUpdateCreditCardRequest xmlns="http://api.gsicommerce.com/schema/checkout/1.0"
      sessionId="12345">
  <VaultId>123456</VaultId>
  <VaultTenderId">654321</VaultTenderId>
  <Selected>true</Selected>
  <ExpirationDate>2013-09</ExpirationDate>
  <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>
   <Notes>customer@email.com</Notes>
</VaultUpdateCreditCardRequest>

Request Elements

Element	Required	Description	Type	Restriction
VaultId	Yes	Unique identifier for the vault.	String	1 to 38 numeric characters
VaultTenderId	Yes	Unique identifier for the vault tender.	String	1 to 38 numeric characters
Selected	Yes	Indicates whether the vault tender is selected or not selected.	Boolean	true or false
ExpirationDate	No	Expiration date of the credit card.	String	Year and month in yyyy-MM format
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	Max 70 characters
BillingAddress/ City	Yes	The city for customer billing address.	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.	String	Max 30 characters
BillingAddress/ CountryCode	Yes	Two digit country code. The ISO 3166 alpha 2 code is recommended, but not required.	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
Notes	No	Memo or alias associated with the specific tender; can be changed by the customer.	String	Max 512 characters
sessionId	Yes	Identifies a request message; used to protect against duplicate request processing.	String	Up to 40 characters

Response Format

The response is a VaultUpdateCreditCardReply message.

<?xml version="1.0" encoding="UTF-8"?>
<VaultUpdateCreditCardReply xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
    <VaultId>123456</VaultId>
    <VaultTender>
        <VaultTenderId>654321</VaultTenderId>
        <Active>True</Active>
        <TenderClass>CreditCard</TenderClass>
        <TenderType>VC</TenderType>
        <TenderDescription>PrimaryTender</TenderDescription>
        <MaskedPan>411111xxxx111111</MaskedPan>
        <BillingPersonName>
            <Honorific>Mr.</Honorific>
            <LastName>Smith</LastName>
            <MiddleName>Andrew</MiddleName>
            <FirstName>John</FirstName>
        </BillingPersonName>
        <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>
        <Selected>True</Selected>
    </VaultTender>
</VaultUpdateCreditCardReply>

Response Elements

Element	Required	Description	Type	Restriction
VaultId	Yes	Vault identifier echoed back from the request message.	String	1 to 38 numeric characters
VaultTenderId	Yes	Vault tender identifier of the credit card updated.	String	1 to 40 characters
Active	Yes	The status of the vault tender: true if active; false if inactive.	Boolean	true or false
TenderClass	Yes	The tender class value of the credit card.	Enum	PrivateLabelCreditCard, CreditCard, StoredValue, PayPal
TenderType	Yes	The tender type value of the credit card.	String	Min 2 and max 4 characters
TenderTypeDescription	Yes	Identifies the actual tender to the user.	String	Max 70 characters
MaskedPan	Yes	Represents the PaymentAccountUniqueId in a masked format.	String	Max 22 characters
BillingPersonName/ Honorific	No	Salutation for the customer.	String	10 characters
BillingPersonName/ LastName	Yes	Last name of the customer.	String	64 characters
BillingPersonName/ MiddleName	No	Middle name of the customer.	String	40 characters
BillingPersonName/ FirstName	Yes	First name of the customer.	String	64 characters
VaultTender/ 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
VaultTender/ 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.	String	Max 30 characters
BillingAddress/ CountryCode	Yes	Two digit country code. The ISO 3166 alpha 2 code is recommended, but not required.	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
ExpirationDate	No	Expiration date of the credit card.	String	Year and 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	Yes	Indicates whether a given vault tender is selected. A selected tender would be used for payments.	Boolean	true or false