Vault Update

Overview

The VaultUpdate API call can deactivate an existing vault or re-activate a deactivated vault.

URI Summary

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

Request Format

The request is a VaultUpdateRequest message.

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

Request Elements

Element	Required	Description	Type	Restriction
VaultId	Yes	Unique identifier for the vault.	String	1 to 38 numeric characters
Active	Yes	The action for this request: true to activate the vault; false to deactivate the vault.	Boolean	true or false
sessionId	No	Identifies a request message; used to protect against duplicate request processing.	String	Up to 40 characters

Response Format

The response is a VaultUpdateReply message.

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

Response Elements

Element	Required	Description	Type	Restriction
VaultId	Yes	Unique identifier for the vault.	String	1 to 38 numeric characters
Active	Yes	The status of the vault after update: true if the vault is active; false if inactive.	Boolean	true or false