Batch Upload | Vault, Invoicing, Products, Recurring

Table of Contents

• Overview
• Batch Upload Customer Vault
• Batch Upload Invoice
• Batch Upload Products
• Batch Upload Recurring
• Frequently Asked Questions

Overview

The Batch Upload also supports mass uploading for several Payment Gateway Features, including the Customer Vault, Invoicing, Products, and Recurring payments. If you haven’t reviewed our Getting Started | Batch Upload article yet, we recommend doing so to learn how to upload a batch. Once you're familiar with the process, use the guides below to help the merchant create a file based on the required fields and any additional details they want to include for the customer. If you have required fields set for the merchant, you will need to let them know to include those in the file.

*A full list of headers and descriptions that the merchant can include in their file are available to download at the bottom of the page.

---

Batch Upload Customer Vault

The merchant must have the Customer Vault service enabled and the "Access the Customer Vault" permission to use this feature.

We recommend adding more customer details when storing a customer in the vault. We've included the minimum required fields for file uploads, along with additional optional fields that we suggest for a more complete record.

Adding a Credit Card Vault ID 

Required Fields	Optional but Suggested Fields
Customer Vault Action Credit Card Number Credit Card Expiration Date	Billing First Name Billing Last Name Billing Address 1 Billing City Billing State Zip Phone Email Customer Vault ID

Excel Example:

Adding an Echeck Vault ID 

Required Fields	Optional but Suggested Fields
Customer Vault Action Name on Bank Account Bank ABA/Routing Number Bank Account Number NACHA SEC Code Account Holder Entity, Bank Account Type	Billing First Name Billing Last Name Billing Address 1 Billing City Billing State Zip Phone Email Customer Vault ID

Excel Example:

Add to Vault and Process Sale/Auth with Credit Card 

Required Fields	Optional but Suggested Fields
Type Customer Vault Action Total Amount Credit Card Number Credit Card Expiration Date	CVV Code Billing First Name Billing Last Name Billing Address 1 Billing City Billing State Zip Phone Email Customer Vault ID

Excel Example:

Process a Sale with a Vault ID 

Required Fields

Type Total Amount Customer Vault ID (Enter the Vault ID associated with the customer you wish to charge)

Excel Example:

Process Sale with Vault ID and Billing ID 

Use this when a customer has multiple billing methods for one vault ID and they want to charge a specific card or bank account.

Required Fields

Type Total Amount Customer Vault ID (Enter the Vault ID associated with the customer and the Billing ID associated with the billing information you want to charge) Billing Address ID

Excel Example:

Deleting a Vault ID 

Required Fields

Customer Vault Action Customer Vault ID

Excel Example: 

Updating a Vault ID 

The Merchant cannot update the Vault ID or Billing ID. Only stored information.

Note: Do NOT include any columns/information you do NOT wish to update. If you send in a blank 'First Name' it will overwrite what is stored in that field.

Required Fields

Customer Vault Action Customer Vault ID

Include any headers you want to update; for example the file below will update the credit card information.

Excel Example:

Adding Customer Vault Records via Transaction ID's

Required Fields

Customer Vault Action Source Transaction ID

Excel Example:

Adding a New Payment Record to Existing Vault 

Batch upload does support adding a Billing ID to an existing Customer Vault ID.

Required Fields	Optional but Suggested Fields
Customer Vault Action Customer Vault ID Credit Card Number Credit Card Expiration	Billing First Name Billing Last Name Billing Address 1 Billing City Billing State Zip Phone Email Billing ID

Excel Example:

Delete Multiple Billing ID's from one Vault ID

Required Fields

Customer Vault Action Customer Vault ID Billing ID

Excel Example:

---

Batch Upload Invoicing

The merchant must have the Electronic Invoice service enabled and the "Access Invoice" permission to use this feature.

Adding an Invoice 

Required Fields	Optional but Suggested
Invoicing Action Total Amount Billing Email	Invoice Payment Terms Billing First Name Billing Last Name Billing Address 1 Billing City Billing State Billing Zip Billing Phone

Excel Example:

---

Batch Upload Products

The merchant must have the "Product Manager Admin" permission to use this feature.

Adding a Product

Required Fields

Products product_sku product_description product_cost product_currency

Excel Example:

Updating a Product

Required Fields

Products product_id

Excel Example:

Deleting a Product 

Required Fields

Products product_id

Excel Example:

---

Batch Upload Recurring

Adding a Plan ID

Required Fields	Required but Conditional
Plan Payments (Use '0' for until canceled) Plan Amount Plan Name Plan ID Every X Months Day of Month Day Frequency	Option A Every X Months Day of Month Option B Day Frequency

 

Option A Example: Every 1 month on the 15th. (This will charge the customer every month on the 15th)

Excel Example:

Option B Example : Every 30 days. (This will charge the customer every 30 days)

Excel Example:

Adding a Subscription via Plan ID 

Required Fields	Optional but Suggested
Credit Card Number Credit Card Expiration Recurring Plan ID Subscription Start Date (YYYYMMDD)	Order Description Billing First Name Billing Last Name Billing Company Billing Address 1 Billing Address 2 Billing City Billing State Billing Postal Code Billing Country Billing Email Billing Phone

Excel Example:

Add a Subscription via a Vault ID Using a Plan ID 

Required Fields

Recurring Plan ID Subscription Start Date (YYYYMMDD)

Excel Example:

Adding a Custom Subscription

Required Fields	Required but Conditional	Optional but Suggested
Recurring Plan Payments (Use '0' for until canceled.) Plan Amount Credit Card Number Credit Card Expiration	Option A Every X Months Day of Month Option B Day Frequency	Order Description Billing First Name Billing Last Name Billing Company Billing Address 1 Billing Address 2 Billing City Billing State Billing Postal Code Billing Country Billing Email Billing Phone

Option A Example: Every 1 month on the 15th. (This will charge the customer every month on the 15th)

Excel Example:

Option B Example : Every 30 days. (This will charge the customer every 30 days)

Excel Example:

Updating a Subscription 

We support the update of Billing Information only at this time.

Required Fields	Fields that can be Updated
Recurring Subscription ID	Credit Card Number Credit Card Expiration Order Description Billing First Name Billing Last Name Billing Company Billing Address 1 Billing Address 2 Billing City Billing State Billing Postal Code Billing Country Billing Email Billing Phone

Excel Example: 

Deleting a Subscription

Required Fields

Recurring Subscription ID

Excel Example:

---

Frequently Asked Questions

Can I update existing records using Batch Upload? Yes, but only certain fields can be updated depending on the feature. For example, you can update billing information in the Customer Vault, but you cannot change the Vault ID or Billing IDs.

Can I process a sale using a Vault ID? Yes, you can use a Vault ID to process a sale with batch upload.

Can I process a sale using a Vault ID and Billing ID? Yes, when a customer has multiple billing methods under one Vault ID, you can charge a specific card or bank account.

My Batch Upload failed. What should I check?

• Ensure all required fields are included.
• Verify file formatting (Excel, TXT, CSV).
• Check that all the mandatory fields are included.
• Avoid including columns you do not wish to update.