API Reference

Batches

Fields

Field Type Description
id string Unique identifier for this batch.
filename string The name of the uploaded batch file
type string The batch type - PURCHASE, REFUND or DIRECTDEBIT
reference string The batch file reference
status string The batch file status - possible values are Completed, Pending, Deleted, Error
process_date date (yyyy-mm-dd) The date the batch is scheduled for or was processed
start_date date (yyyy-mm-dd) The date the batch was started
completed_date date (yyyy-mm-dd) The date the batch was completed
created_at date (yyyy-mm-dd) The date the batch file record was created