Vault Expired Tender Event

Overview

The Vault Payment Expired Event message notifies vault account holders when active credit card tenders or PayPal Recurring Pay tenders in the vault are expiring or have expired.

Expiring tenders are tenders whose expiration date is within the threshold alert. By default, the threshold is 60 days before its expiration. Expired tenders are automatically set to inactive.

Event Message Example

PaymentVaultExpiredTenderEvent for PayPal

<?xml version="1.0" encoding="UTF-8"?>
<PaymentVaultExpiredTenderEvent xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
   <VaultId>1007</VaultId>
   <TenderClass>PayPal</TenderClass>
   <TenderType>PY</TenderType>
   <TenderDescription>PAYPAL</TenderDescription>
   <OrderId>00025</OrderId>
   <ExpirationDate>2015-07</ExpirationDate>
   <IsExpired>true</IsExpired>
   <Customer>
      <Honorific>Mr.</Honorific>
      <LastName>Doe</LastName>
      <MiddleName>Michael</MiddleName>
      <FirstName>John</FirstName>
   </Customer>
   <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>
</PaymentVaultExpiredTenderEvent>

PaymentVaultExpiredTenderEvent for Credit Card

<?xml version="1.0" encoding="UTF-8"?>
<PaymentVaultExpiredTenderEvent xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
   <VaultId>1008</VaultId>
   <TenderClass>CreditCard</TenderClass>
   <TenderType>VC</TenderType>
   <TenderDescription>VISA</TenderDescription>
   <MaskedPan>411111xxxx111111</MaskedPan>
   <ExpirationDate>2015-07</ExpirationDate>
   <IsExpired>true</IsExpired>
   <Customer>
      <Honorific>Mr.</Honorific>
      <LastName>Doe</LastName>
      <MiddleName>Michael</MiddleName>
      <FirstName>John</FirstName>
   </Customer>
   <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>
</PaymentVaultExpiredTenderEvent>

Event Elements

Element	Required	Description	Type	Restriction
VaultId	Yes	Unique identifier for the vault.	String	1 to 38 numeric characters
TenderClass	No	Tender class for the tender.	Enum	PrivateLabelCreditCard, CreditCard, StoredValue, PayPal
TenderType	Yes	Tender type for the tender.	String	Min 2 and max 4 characters
TenderDescription	Yes	Description of the tender type.	String	Max 70 characters
MaskedPan	No	The PaymentAccountUniqueId in a masked format.	String	Max 22 characters
OrderId	No	Order ID associated to the expiring or expired PayPal recurring payment plan.	String	No restrictions
ExpirationDate	Yes	Expiration date of the credit card or PayPal Recurring Pay.	String	Year and month in yyyy-MM format
IsExpired	Yes	Indicates whether the tender is expired.	Boolean	true or false
Customer	Yes	Account holder name.	ComplexType
Customer/ Honorific	No	Customer's title (for example, Dr., Mr., Ms.)	String	Max 10 characters
Customer/ LastName	Yes	Customer's last name	String	Max 64 characters
Customer/ MiddleName	No	Person's middle name	String	Max 40 characters
Customer/ FirstName	No	Person's first name	String	Max 64 characters
BillingAddress	Yes	Customer's billing address. Sequence of Line1, Line2, Line3, Line4, City, MainDivision, CountryCode, PostalCode.	ComplexType
BillingAddress/ Line1	Yes	Line 1 of the address.	String	Max 70 characters
BillingAddress/ Line2	No	Line 2 of the address.	String	Max 70 characters
BillingAddress/ Line3	No	Line 3 of the address.	String	Max 70 characters
BillingAddress/ Line4	No	Line 4 of the address.	String	Max 70 characters
BillingAddress/ City	Yes	City of the address.	String	Max 40 characters
BillingAddress/ MainDivision	No	State, province, or county.	String	Max 35 characters
BillingAddress/ CountryCode	Yes	ISO 3166 alpha 2 country code.	String	Max 40 characters
BillingAddress/ PostalCode	No	Postal code.	String	Max 15 characters