Step One

Three-Step: Customer Vault

Add/Update Customer XML Request

XML ElementDescription
<add-customer|update-customer>Type of transaction to perform.
api-key*api-key is obtained in the security keys section of the control panel settings.
redirect-url*A URL on your web server that the gateway will redirect your customer to after sensitive data collection. Value is not required for ‘update-customer’ requests when sensitive data is not being presented.
Example: Updating an address or zip code only.
customer-vault-idLoad customer details from an existing customer vault record. If set, no payment information is required during step two.
merchant-defined-field-#Merchant specified custom fields.
Format: <merchant-defined-field-1>Value</merchant-defined-field-1>
<billing>The customer’s billing information
billing-idSpecify billing id. Required for ‘update-customer’ if multiple billing-ids exist, optional for ‘add-billing’.
first-nameCardholder’s first name.
last-nameCardholder’s last name.
address1Cardholder’s billing address.
cityCard billing city.
stateCard billing state/province.
Format: CC
postalCard billing postal code.
countryCard billing country code.
Format: CC/ISO 3166
phoneBilling phone number.
emailBilling email address.
companyCardholder’s company.
address2Card billing address, line 2.
faxBilling fax number.
account-typeThe customer’s ACH account type.
Values: ‘checking’ or ‘savings’
entity-typeThe customer’s ACH account entity.
Values: ‘personal’ or ‘business’
prioritySpecify priority (If omitted, will be auto-generated and returned in response).
Format: Numeric, 1-255
<shipping>The customer’s shipping information.
shipping-idSpecify shipping id (Required for update-customer if multiple shipping-ids exist. Optional for add-billing).
first-nameShipping first name.
last-nameShipping last name.
address1Shipping billing address.
cityShipping city.
stateShipping state/province.
Format: CC
postalShipping postal code.
countryShipping country code.
Format: CC/ISO 3166
phoneShipping phone number.
emailShipping email address.
companyShipping company.
address2Shipping address, line 2.
faxShipping fax number.
prioritySpecify priority, if omitted, will be auto-generated and returned in response.
Format: Numeric, 1-255

XML Response

XML ElementDescription
3=Error in transaction data or system error
result-textTextual response.
result-codeNumeric mapping of processor responses. (See Appendix 3)
form-urlURL used as the action of the HTML form in step two.