Vault Add Stored Value

Overview

The VaultAddStoredValue API call adds a gift card to an existing and active vault. Subsequently, the VaultPayment API call can use the gift card for payments. VaultAddStoredValue will fail for a deleted or inactive vault.

URI Summary

Action	URI Template	URI Example	Non-URI Request	Response
POST	/v1.0/stores/[StoreId]/payments/ vault/storedvalue/add/[tenderCode].[format]	/v1.0/stores/TMSNA/payments/ vault/storedvalue/add/GS.xml	XML	200 + XML Response containing the response status of adding the gift card to the vault.

Request Format

The request is a VaultAddStoredValueRequest message.

<?xml version="1.0" encoding="UTF-8"?>
<VaultAddStoredValueRequest xmlns="http://api.gsicommerce.com/schema/checkout/1.0"
      sessionId="12345">
  <VaultId>123456</VaultId>
  <PaymentAccountUniqueId isToken="false">8111111111111111</PaymentAccountUniqueId>
  <Pin>1234</Pin>
  <CurrencyCode>USD</CurrencyCode>
  <Notes>giftcard</Notes>
</VaultAddStoredValueRequest>

Request Elements

Element	Required	Description	Type	Restriction
VaultId	Yes	Unique identifier for the vault.	String	1 to 38 numeric characters
PaymentAccountUniqueId	Yes	Account ID for the gift card. This can be either a raw payment account numbe (PAN) or a token representing a PAN. The attribute isToken indicates if the PAN is tokenized.	String	Max 22 characters
EncryptedPaymentAccountUniqueId	Yes	Client-encrypted PAN. Used for clients who use client-side encryption to encrypt credit card numbers in the JavaScript that runs in their browser. For a webstore that is not PCI compliant, client-side encryption ensures that the webstore never sees raw PANs.	String	Max 1000 characters
Pin	No	PIN for the gift card.	String	1 to 8 Characters. Either Pin or EncryptedPin is present.
CurrencyCode	Yes	The currency used for the transaction.	Currency code	Currency codes are defined by ISO 4217:2008. Examples: USD, CAD, EURSee http://en.wikipedia.org/ wiki/ISO_4217
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 VaultAddStoredValueReply message.

<?xml version="1.0" encoding="UTF-8"?>
<VaultAddStoredValueReply xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
  <VaultId>123456</VaultId>
  <VaultTenderId>21645</VaultTenderId>
  <ResponseCode>Success</ResponseCode>
  <Reason>ok</Reason>
</VaultAddStoredValueReply>

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	New vault tender identifier for the gift card added to the vault	String	1 to 40 characters
ResponseCode	Yes	Response Code returned from Payment Service.	String	Success, Failure
Reason	No	Reason information for success or failure.	String	No restrictions