Customer Vault Variables

Direct Post API

Add/Update Customer Record

VariablesDescription
customer_vault*Add/Update a secure customer vault record.
Values: ‘add_customer’ or ‘update_customer’
customer_vault_idSpecifies a customer vault id. If not set, the payment gateway will randomly generate a customer vault id.
billing_idBilling id to be assigned or updated. If none is provided, one will be created or the billing id with priority ‘1’ will be updated.
username*Username assigned to merchant account.
password*Password assigned to merchant account.
ccnumber**Credit card number.
ccexp**Credit card expiration.
Format: MMYY
checkname***The name on the customer’s ACH account.
checkaba***The customer’s bank routing number.
checkaccount***The customer’s bank account number.
account_holder_type***The customer’s ACH account entity.
Values: ‘personal’ or ‘business’
account_type***The customer’s ACH account type.
Values: ‘checking’ or ‘savings’
sec_codeACH standard entry class codes.
Values: ‘PPD’, ‘WEB’, ‘TEL’, or ‘CCD’
currencySet transaction currency.
paymentSet payment type to ACH or credit card.
Values: ‘creditcard’ or ‘check’
orderidOrder id
order_descriptionOrder Description
Legacy variable includes: orderdescription
merchant_defined_field_#Can be set up in merchant control panel under ‘Settings’->’Merchant Defined Fields’.
Format: merchant_defined_field_1=Value
ponumber****Cardholder’s purchase order number.
tax****Total tax amount.
Format: x.xx
tax_exempt****Set whether cardholder is tax exempt.
Values: ‘true’ or ‘false’
shipping****Total shipping amount
first_nameCardholder’s first name.
Legacy variable includes: firstname
last_nameCardholder’s last name.
Legacy variable includes: lastname
address1Card billing address.
cityCard billing city
stateCard billing state.
zipCard billing postal code.
countryCard billing country code.
phoneBilling phone number.
emailBilling email address.
companyCardholder’s company.
address2Card billing address, line 2.
faxBilling fax number.
shipping_idShipping entry id. If none is provided, one will be created or the billing id with priority ‘1’ will be updated.
shipping_firstnameShipping first name.
shipping_lastnameShipping last name.
shipping_companyShipping company.
shipping_address1Shipping address.
shipping_address2Shipping address, line 2.
shipping_cityShipping city
shipping_stateShipping state.
shipping_zipShipping postal code.
shipping_countryShipping country code.
shipping_phoneShipping phone number.
shipping_faxShipping fax number.
shipping_emailShipping email address.
*Always required
**Required for credit card transactions
***Required for ACH transactions
****Required for Level 2 transactions

Customer Vault initiated Sale/Auth/Credit/Offline

VariableDescription
username*Username assigned to merchant account.
password*Password assigned to merchant account.
customer_vault_id*Specifies a customer vault id.
amountTotal amount to be charged. For validate, the amount must be omitted or set to 0.00.
Format: x.xx
currencyThe transaction currency.
Format: ISO 4217
processor_idIf using Multiple MIDs, route to this processor (processor_id is obtained under Settings->Load Balancing in the Control Panel).
descriptorSet payment descriptor on supported processors.
descriptor_phoneSet payment descriptor phone on supported processors.
order_descriptionOrder description.
Legacy variable includes: orderdescription
orderidOrder ID
*Always Required

Delete Customer Record

VariableDescription
customer_vault*Deletes a secure customer vault record.
Values: ‘delete_customer’
customer_vault_id*Specifies a customer vault id.
username*Username assigned to merchant account.
password*Password assigned to merchant account.
*Always Required

Notes:

  • If you do not pass a customer_vault_id, our system will randomly generate one. If you include a customer_id and customer_vault_id, they must match.
  • You can only pass Credit Card or Electronic Check transaction variables.