How to use Batch / Bulk Uploading

How to create the files necessary for bulk processing blueprints, customers, business processes, reminders, etc.

Customers

Customers must exist before performing other bulk processes

  1. Log into your SFTP client (e.g., FileZilla) using your Merchant Application ID and Token (or Merchant AVID and Password). Instructions are here.
  2. Upload the CSV file to the /customers folder:
    1. Required Fields: ref, address (or addresses)
  3. The system will process the uploaded customer information and create new customer entries.
πŸ“˜

Example CSV Structure:

ref,address
Customer001,+15555001234
ref,addresses
Customer001,"+15555001234, [email protected]"

Business Process via Blueprint

Must have already created the blueprint and have the blueprint-id

  1. Log into your SFTP client.
  2. Upload the CSV file to the /blueprints/{blueprint-id} folder:
    1. Required Fields depend upon how the blueprint was created, but ref is always required.
  3. The business process will be created based on the blueprint and customer data.
πŸ“˜

Example CSV Structure:

ref,description
Customer001,For Taco Tuesday
ref,amount,description,idSeed
Customer001,500,For Taco Tuesday,alpha

Reminders

Blueprint must have already been created with an idSeed, in order to create an event

  1. Log into your SFTP client.
  2. Upload the CSV file to the /business-processes/events folder:
    1. Required Fields: id, type
    2. Valid event types: reminder, resolved, failed
  3. This will send a reminder or cause other event-related actions on the business process.
πŸ“˜

Example CSV Structure:

id, type
alpha,reminder
beta,failed
gamma,resolved