Additional Operations

Add/Update Billing Request (Step 1)

XML Element	Description
<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-id	Specify billing id. Required for update-customer if multiple billing ids exist, optional for add-billing.
first-name	Cardholder’s first name.
last-name	Cardholder’s last name.
address1	Cardholder’s billing address.
city	Card billing city.
state	Card billing state/province. Format: CC
postal	Card billing postal code.
country	Card billing country code. Format: CC/ISO 3166
phone	Billing phone number.
email	Billing email address.
company	Cardholder’s company.
address2	Card billing address, line 2.
fax	Billing fax number.
account-type	The customer’s ACH account type. Values: ‘checking’ or ‘savings’
entity-type	The customer’s ACH account entity. Values: ‘personal’ or ‘business’
priority	Specify priority (If omitted, will be auto-generated and returned in response.) Format: Numeric, 1-255
</billing>
</add-billing|update-billing>

Field markers

• * Required

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

Element	Description
<sale|auth|credit|validate|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 (For “validate” actions, amount must be 0.00 or omitted). Format: x.xx
surcharge-amount	Surcharge amount. Format: x.xx
authorization-code	Specify authorization code. For use with “offline” action only.
processor-id	If using multiple MIDs, route to this processor. The values for ‘processor-id’ are obtained under ‘Settings’->‘Transaction Routing’ in the Control Panel.
customer-vault-id*	Load customer details from an existing Customer Vault record .
signature-image	Cardholder signature image. For use with “sale” and “auth” actions only. Format: base64 encoded raw PNG image. (16kiB maximum)
<billing>	The customer’s billing information.
billing-id	Load 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-id	Load shipping id details from an existing shipping record. If unset, the shipping-id with the highest priority will be used by default.
</shipping>
</sale|auth|credit|validate|offline>

Field markers

• * Required

Delete Customer XML Request

Element	Description
<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>

Field markers

• * Required

Delete Billing XML Request

Element	Description
<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>

Field markers

• * Required

Add/Update/Delete Shipping XML Request

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