Radial Integration | 2016
The VaultPayment API call processes payments through all the vault tenders associated with an active vault.
| Action | URI Template | URI Example | Non-URI Request | Response |
|---|---|---|---|---|
| POST | /v1.0/stores/[StoreId]/payments/ vault/payment.[format] |
/v1.0/stores/TMSNA/payments/ vault/payment.xml |
XML | 200 + XML Response containing the response status of payment processed for a given vault from the existing tenders associated with the vault. |
The request is a VaultPaymentRequest message.
<?xml version="1.0" encoding="UTF-8"?>
<VaultPaymentRequest xmlns="http://api.gsicommerce.com/schema/checkout/1.0"
requestId="1234567">
<OrderId>test</OrderId>
<VaultId>12345</VaultId>
<Amount currencyCode="USD">11.45</Amount>
<Recurring>false</Recurring>
<InitialOrderId>123456</InitialOrderId>
</VaultPaymentRequest>| 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 |
| Amount | Yes | Currency amount to be processed from the tenders. | Positive decimal, up to 2 decimal places | Example: 4.75 |
| Recurring | Yes | Is this a recurring payment or not? | Boolean | true/false |
| InitialOrderId | No | This identifier typically ties payment transactions to an order. Note that this identifier must be the initial web or subscription order ID or the PaymentSessionId, which is used to look up initial PayPal recurring billing agreement details. | String | Max 20 characters |
| requestId | Yes | RequestId globally identifies a request message and is used to protect against duplicate request processing. | String | Up to 40 characters |
The response is a VaultPaymentReply message.
<?xml version="1.0" encoding="UTF-8"?>
<VaultPaymentReply xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
<VaultId>123456</VaultId>
<ResponseCode>Success</ResponseCode>
<AmountPaid currencyCode="USD">45.00</AmountPaid>
<PaymentResponses>
<StoredValueRedeemResponse>
<VaultTenderId>1</VaultTenderId>
<Token>811111XXXXX13316</Token>
<TenderType>GS</TenderType>
<ResponseCode>Success</ResponseCode>
<AmountRedeemed currencyCode="USD">45.00</AmountRedeemed>
<BalanceAmount currencyCode="USD">5.00</BalanceAmount>
</StoredValueRedeemResponse>
</PaymentResponses>
</VaultPaymentReply>
| Element | Required | Description | Type | Restriction |
|---|---|---|---|---|
| VaultId | Yes | Vault identifier echoed back from the request message. | String | 1 to 38 numeric characters |
| AmountPaid | Yes | Total amount processed from all the tenders. | Positive decimal, up to 2 decimal places | Example: 4.75 |
| ResponseCode | Yes | Response Code returned from Payment Service. | String | Success, Failure, Timeout |
| Fault | No | If payment request failed, the fault element provides more information. | ComplexType | Contain inner elements: Code and Description |
| Code | Yes | The failure code returned. | String | No length limit |
| Description | Yes | Description of the failure code. | String | No length limit |
| PaymentResponses | Yes | Contains the tender-specific responses associated with the tenders of the vault. | ComplexType | Contains CreditCardAuthResponse, StoredValueRedeemResponse, and PayPalReferenceTxResponse, each of which is optional |
| CreditCardAuthResponse | No | Contains the credit card vault tender response. | ComplexType | Contains elements VaultTenderId, Token, TenderType, BillingPersonName, BillingAddress, CustomerPhoneNo, and CustomerEmail |
| StoredValueRedeemResponse | No | Contains the stored value vault tender response. | ComplexType | Contains VaultTenderId, Token, TenderType, ResponseCode, AmountRedeemed, and BalanceAmount |
| PayPalReferenceTxResponse | No | Contains the PayPal vault tender response. | 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 |
| BillingPersonName | No | The name of the person associated with billing in the vault tender. | String | |
| BillingAddress | Yes (for AVS verification) | Billing address of the credit card. | ComplexType | Contains inner elements: Line1, Line2, Line3, Line4, City, MainDivision, CountryCode, and PostalCode |
| BillingAddress/ Line1 |
Yes | Line# components of the billing street address and, if necessary, suite and building for the physical address. Line1 is required. Other Line# components are optional. | String | Max 70 characters |
| BillingAddress/ Line2 |
No | String | Max 70 characters | |
| BillingAddress Line3 |
No | String | Max 70 characters | |
| BillingAddres Line4 |
No | String | Max 70 characters | |
| BillingAddress/ City |
Yes | City for the billing address. | String | Max 40 characters |
| BillingAddress/ MainDivision |
Yes | Two- or three-digit postal abbreviation for the state or province. The ISO 3166-2 code is recommended, but not required. See http://en.wikipedia.org/wiki/ISO_3166-2. | String | Max 30 characters |
| BillingAddress/ CountryCode |
Yes | Two digit country code. The ISO 3166 alpha 2 code is recommended, but not required. See: http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2. | String | 2-40 characters |
| BillingAddress/ PostalCode |
Depends on country. Required for US and Canada | String of letters and/or numbers that specifies the delivery area more closely than the city alone (for example, US ZIP code). | String | Max 30 characters |
| CustomerPhoneNo | Yes | Telephone contact number of the customer. | String | Max 70 characters |
| CustomerEmail | Yes | Email address of the customer who is making the purchase. Used for real-time fraud checking by API and payment processors. | String | Max 70 characters |
| ResponseCode | Yes | Response Code returned from Payment Service. | String | Success, Failure, Timeout |
| AmountRedeemed | Yes | The amount redeemed on the gift card in the specified currency, with currencyCode as an attribute. |
Positive decimal, up to 2 decimal places |
Example: 4.75 |
| BalanceAmount | Yes | After the purchase, the amount left on the gift card in the specified currency, with currencyCode as an attribute. |
Positive decimal, up to 2 decimal places |
Example: 4.75 |
| AmountAuthorized | Yes | The amount authorized on the PayPal account in the specified currency, with currencyCode as an attribute. |
Positive decimal, up to 2 decimal places |
Example: 4.75 |
Copyright © 2017 Radial. All rights reserved.