Direct Debit Batches

Sample batch files for direct debits can be found here.

Request CSV Parameters

Parameter	Description
`transactionProduct`	A product (or sale) ID or description. We recommend using an order or product ID. This field's primary purpose is to help identify the transaction for reporting and accounting purposes. Example: `ABC4321` Valid length: Up to 255 characters.
`customerName`	Can contain only alphanumeric characters and the following characters: full stop (`.`), comma (`,`), apostrophe (`'`), ampersand (`&`), space, and hyphen (`-`). Example: `Mr. Example Person` Valid length: Between 2 and 255 characters.
`customerPhone`	The customer's phone number. Any character other than `+`, `-`, spaces, and digits (`0-9`) will be stripped. Example: `0401234567` or `61731234567` Valid length: Up to 25 characters.
`customerEmail`	The customer's email address. Example: `person@example.com` Valid length: Up to 255 characters.
`customerCountry`	Two-letter ISO 3166-1 alpha-2 country code. Example: `AU` Valid length: 2 characters.
`customerState`	Free-form field. Keep values consistent for your records and reporting. Example: `Queensland` Valid length: Up to 75 characters.
`customerCity`	Free-form field. Keep values consistent for your records and reporting. Example: `Brisbane` Valid length: Up to 75 characters.
`customerAddress`	Free-form field. Example: `123 Test Street` Valid length: Up to 255 characters.
`customerPostCode`	Supports ZIP and postal codes for international transactions. Example: `4000` Valid length: Between 4 and 10 characters.
`transactionType`	The type of transaction being performed. Must be `ddebit` for direct debit batches.
`transactionAmount`	The transaction amount. It must contain exactly two decimal places. Amounts without two decimal places, or amounts less than one cent, will be rejected. Example: `10.00`
`transactionCurrency`	The transaction currency. Supported values are provider-dependent. Check with Merchant Warrior before processing transactions in any currency other than AUD. This field is case-insensitive. Possible values: `AUD`, `NZD` Example: `AUD`
`custom1`	Free-form field. Returned as `<custom1>` in the response. Valid length: Up to 500 characters.
`custom2`	Free-form field. Returned as `<custom2>` in the response. Valid length: Up to 500 characters.
`custom3`	Free-form field. Returned as `<custom3>` in the response. Valid length: Up to 500 characters.
`paymentAccountBSB`	Must contain exactly 6 digits. Example: `011123` Valid length: 6 digits.
`paymentAccountNumber`	Must be a valid account number. Example: `123456789` Valid length: Between 4 and 10 digits.
`paymentAccountName`	Must contain at least one space and no fewer than two characters. Only alphanumeric characters, hyphens, spaces, and full stops are allowed. Example: `Mr. Example Person`, `MR E PERSON`, or `Example Person` Valid length: Between 3 and 32 characters.
`transactionReferenceID`	The merchant's unique reference ID for a transaction sent to Merchant Warrior. Its primary purpose is to verify the transaction through the `queryCard` method when a valid response is not received. Example: `0e26df01-1460-4565-894b-e3a16dd53c7a` Valid length: Up to 40 characters. Required: No.

Modified at 2026-07-17 00:49:46