Vault Create

Overview

The VaultCreate API call creates a new vault. The vault is used for managing a shopper's tenders and can hold multiple tenders.

URI Summary

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

Request Format

The request is a VaultCreateRequest message.

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

Request Elements

Element	Required	Description	Type	Restriction
CustomerId	Yes	Unique identifier for the customer.	String	1 to 60 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 VaultCreateReply message.

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

Response Elements

Element	Required	Description	Type	Restriction
VaultId	Yes	Unique identifier for the vault.	String	1 to 38 numeric characters