Additional Operations

Three-Step: Customer Vault

Add/Update Billing Request (Step 1)

XML ElementDescription
<add-billing|update-billing>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-billing’ requests when sensitive data is not presented.
Example: Updating an address or zip code only.
customer-vault-id*Load customer details from an existing customer vault record. If set, no payment information is required during step two.
<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
</billing>
</add-billing|update-billing>
*Required

Customer Vault initiated Sale/Auth/Credit/Offline XML Request

ElementDescription
<sale|auth|credit|offline>Any and all optional fields described here can be appended to this request.
api-key*api-key is obtained in the security keys section of the control panel settings.
amount*Total amount to be charged.
Format: x.xx
processor-idIf using multiple MIDs, route to this processor. The values for ‘processor-id’ are obtained under ‘Settings’->’Load Balancing’ in the Control Panel.
customer-vault-id*Load Customer details from an existing Customer Vault record.
<billing>The customer’s billing information.
billing-idLoad Billing ID details from an existing Billing record. If not set, the billing-id with the highest priority will be used by default.
</billing>
<shipping>The customer’s shipping information.
shipping-idLoad shipping id details from an existing shipping record. If unset, the billing-id with the highest priority will be used by default.
</shipping>
</sale|auth|credit|offline>
*Required

Delete Customer XML Request

ElementDescription
<delete-customer>
api-key*api-key is obtained in the security keys section of the control panel settings.
customer-vault-id*Specify customer to be deleted.
</delete-customer>
*Required

Delete Billing XML Request

ElementDescription
<delete-billing>
api-key*api-key is obtained in the security keys section of the control panel settings.
customer-vault-id*Load customer details from an existing customer vault record. If set, no payment information is required during step two.
<billing>
billing-id*Specify billing id to delete.
</billing>
</delete-billing>
*Required

Add/Update/Delete Shipping XML Request

These requests can be made the by replacing the billing section with shipping