Create a batch

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
šŸ“˜

Batch File Format

The Batch File Format is detailed in the Overview section of the Batches Reference. There are three formats - Purchases, Refunds, Direct Debits.

🚧

Filename Convention

The Batch filename must fit a specific convention in order to be accepted. When uploading your batch please ensure that the filename uses the following pattern:

BATCH-[version]-[type]-[username]-[date]-[reference].csv

Where:

  • version is the file format version (currently v1)
  • type is the batch file type (PURCHASE, REFUND or DIRECTDEBIT)
  • username is your merchant username
  • date is the date in YYYYMMDD format when the batch should be processed
  • reference is your reference for the batch file
Path Params
string
required

Your CSV batch payments file name

Body Params
file

The batch CSV file format

Response

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json