Vault PaymentVoid

Overview

The VaultPaymentVoid API call voids any payments that was successfully processed through vault tenders for a given order.

URI Summary

Action	URI Template	URI Example	Non-URI Request	Response
POST	/v1.0/stores/[StoreId]/payments/ vault/payment/void.[format]	/v1.0/stores/TMSNA/payments/ vault/payment/void.xml	XML	200 + XML Response containing the response status of voided payments processed for a given order associated with a given vault.

Request Format

The request is a VaultPaymentVoidRequest message.

<?xml version="1.0" encoding="UTF-8"?>
<VaultPaymentVoidRequest xmlns="http://api.gsicommerce.com/schema/checkout/1.0" requestId="1234567">
    <OrderId>test</OrderId>
    <VaultId>12345</VaultId>
</VaultPaymentVoidRequest>

Request Elements

Element	Required	Description	Type	Restriction
OrderId	Yes	Unique identifier for an order.	String	1 to 20 characters
VaultId	Yes	Unique identifier for the vault.	String	1 to 38 numeric characters
requestId	Yes	RequestId globally identifies a request message and is used to protect against duplicate request processing.	String	Up to 40 characters

Response Format

The response is a VaultPaymentVoidReply message.

<?xml version="1.0" encoding="UTF-8"?>
<VaultPaymentVoidReply xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
     <OrderId>test</OrderId>
     <VaultId>123456</VaultId>
     <ResponseCode>Success</ResponseCode>
     <PaymentVoidResponses>
      <CreditCardAuthCancelResponse>
         <VaultTenderId>5</VaultTenderId>
         <Token>411111XXXXX11111</Token>
         <TenderType>VC</TenderType>
         <ResponseCode>Success</ResponseCode>
         <ExtendedResponseCode>Street Not Found</ExtendedResponseCode>
         <Amount currencyCode="USD">45.00</Amount>
      </CreditCardAuthCancelResponse>
      <StoredValueRedeemVoidResponse>
         <VaultTenderId>1</VaultTenderId>
         <Token>811111XXXXX13316</Token>
         <TenderType>GS</TenderType>
         <ResponseCode>Success</ResponseCode>
      </StoredValueRedeemVoidResponse>
     </PaymentVoidResponses>
</VaultPaymentVoidReply>

Response Elements

Element	Required	Description	Type	Restriction
VaultId	Yes	Vault identifier echoed back from the request message.	String	1 to 38 numeric characters
ResponseCode	Yes	Response Code returned from Payment Service.	String	Success, Failure, Timeout
PaymentVoidResponses	Yes	Contains the tender-specific voided responses associated with the tenders of the vault.	ComplexType	Contains CreditCardAuthCancelResponse and StoredValueRedeemVoidResponse each of which is optional
CreditCardAuthCancelResponse	No	Contains the credit card auth cancel response associated with the credit card vault tender.	ComplexType	Contains elements VaultTenderId, Token, TenderType, ResponseCode, ExtendedResponseCode, and Amount
StoredValueRedeemVoidResponse	No	Contains the stored value redeem-void response associated with the stored value vault tender.	ComplexType	Contains VaultTenderId, Token, TenderType, ResponseCode
PayPalReferenceTxResponse	No	Contains the PayPal vault tender response associated with the vault.	ComplexType	Contains VaultTenderId, TenderType, ResponseCode and AmountAuthorized.
VaultTenderId	Yes	Unique identifier for the vault tender.	String	1 to 40 characters
Token	Yes	Tokenized account number (PAN).	String	1 to 22 characters
TenderType	Yes	The tender type value of the tender associated.	String	2 to 4 characters. Examples: VC, MC.
ResponseCode	Yes	Response code returned from Payment Service.	String	Success, Failure, Timeout
ExtendedResponseCode	Yes	Details of response code returned from Payment Service.	String	No restriction on length
Amount	Yes	The amount canceled on the credit card in the specified currency, with currencyCode as an attribute.	Positive decimal, up to 2 decimal places	Example: 4.75