This field is case sensitive. Currently, the only valid value for this parameter is ‘processCard’.
Example: processCard

The value of this parameter is provided to you by Merchant Warrior.
Example: 123456789abcd

The value of this parameter is provided to you by Merchant Warrior.
Example: 1a3b5c

The amount must be formatted to have two decimal places. Any amounts without two decimal places or amounts less than one cent will be rejected.
Example: 10.00

One of the following: AUD, CAD, EUR, GBP, JPY, NZD, SGD, USD. This is provider dependant. Please check with MW before attempting to process transactions in any currency other than AUD. This field is case insensitive.
Example: AUD

A product (or sale) id or description. We recommend using an order/product id. This field’s primary purpose is to help the transaction be identifiable for reporting and accounting purposes.
Example: ABC4321
Valid length: Up to 255 characters. Some Acquirers limit this field to 40 characters.

The customer will be redirected to this URL upon completion of the transaction.
Example: https://www.example.com/return.php

Asynchronous POST notifications will be sent to this URL.
Example: https://www.example.com/notify.php

The urlHash field is a combination of your API Passphrase, and specific parameters sent in the transaction. See Web URL Hash for information on how to construct the hash correctly.
Example: 511999e54b9ad51ce4c28d7f0550ac81
Valid Length: 32 characters

Used to salt the return hash used in the 302 Redirect to redirectURL upon the completion of a transaction. A completely random string should be generated and inserted here, please do NOT use the example shown in our requests.
Example: 3x4mpl3s4lt!

The verification hash is a combination of the MD5 of your API Passphrase, and specific parameters sent in the transaction. See Transaction Type Hash for information on how to construct the hash correctly.
Example: e9ddc296b76b3398934bfc06239073df
Valid length: 32 characters

This field can only contain alphanumeric characters, as well as the full stop and hyphen character.
Example: Mr. Example Person
Valid length: Between 2 and 255 characters

Two letter ISO 3166-1 alpha-2 country code.
Example: AU
Valid length: 2 characters

Freeform field, keep consistent for your records and reporting.
Example: Queensland
Valid length: Up to 75 characters

Freeform field, keep consistent for your records and reporting.
Example: Brisbane
Valid length: Up to 75 characters

Freeform field.
Example: 123 Test Street
Valid length: Up to 255 characters

This can also accomodate ZIP/Post codes for international transactions.
Example: 4000
Valid length: Between 4 and 10 characters

Anything other than +,-, space and 0-9 will be stripped.
Example: 0401234567 or 61731234567
Valid length: Up to 25 characters

Must be valid if present. Sending this optional parameter is highly recommended.
Example: [email protected]
Valid length: Up to 255 characters

The URL to an image that will appear in the header of the hosted payment page. Image must be of PNG format and max dimensions of 90x90 pixels and a file size limit of 1500 kilobytes. If no logoURL is supplied a default basket image is used.
Example: https://www.example.com/logo.png

Calculate the surcharge for the transactions (after the cardholder types their card number in) and add it to the total amount charged to the card. This feature allows the merchant to receive the full amount in their settlement.

• 0: Disable all surcharging (including the surcharging values listed in the Barracks portal)
• 1: Enable surcharge
• Null or omitted: Revert to default behaviour of using the surcharge percentages listed in the Barracks portal.

The ID of the customized hosted payment page. This can be implemented if multiple hosted payment pages with different logos and banners is a requirement.
Example: 1

Comma separated list of the card types allowed for the transaction.

Possible options are -

• visa
• mc
• amex
• diners
• discover
• jcb

Example: visa,mc

Indicates to redirect to the Return URL only if the transaction is approved. If active, declined transactions will keep the user on the Hosted Payment Page and display an error message, allowing the user to try again.

Example: 1

Can be used to display a different reference on the Hosted Payment Page other than what is specified in transactionProduct. The value of transactionProduct will still be saved against the transaction and the value of displayReference is for display purposes only and is not saved.

Example: Shoes R Us Purchase

Can be used to hide the reference displayed on the Hosted Payment Page entirely. The value of transactionProduct will still be saved against the transaction.

Example: 1

This field is case sensitive.
Example: processDDebitAuth

The value of this parameter is provided to you by Merchant Warrior.
Example: 123456789abcd

The value of this parameter is provided to you by Merchant Warrior.
Example: 1a3b5c

This field can only contain alphanumeric characters, as well as the full stop, comma, apostrophe, ampersand, space and hyphen characters.
Example: Mr. Example Person
Valid length: Between 2 and 255 characters

Two letter ISO 3166-1 alpha-2 country code.
Example: AU
Valid length: 2 characters

Freeform field, keep consistent for your records and reporting.
Example: Queensland
Valid length: Up to 75 characters

Freeform field, keep consistent for your records and reporting.
Example: Brisbane
Valid length: Up to 75 characters

Freeform field.
Example: 123 Test Street
Valid length: Up to 255 characters

This can also accomodate ZIP/Post codes for international transactions.
Example: 4000
Valid length: Between 4 and 10 characters

Anything other than +,-, space and 0-9 will be stripped.
Example: 0401234567 or 61731234567
Valid length: Up to 25 characters

Sending this optional parameter is highly recommended.
Example: [email protected]
Valid length: Up to 255 characters

BSB of the account to be debited. This field must contain 6 digits.
Example: 123123
Valid length: 6 digits

The name on the account to be debited. This must contain at the very least a space and no less than two characters. Only alphanumeric characters, hyphens, spaces and full stops are allowed.
Example: Mr. Example Person or MR E PERSON or Example Person
Valid length: Between 3 and 32 characters

Account number of the account to be debited. This must be a valid account number.
Example: 234523451
Valid length: 4-10 digits

One of the following: AUD or NZD.
Example: AUD

The verification hash is a combination of the MD5 of your API Passphrase, and specific parameters sent in the transaction. See Transaction Type Hash for information on how to construct the hash correctly. (Field is only required if transactionAmount and transactionCurrency have been set for a DDA)
Example: e9ddc296b76b3398934bfc06239073df
Valid length: 32 characters

The customer will be redirected to this URL upon completion of the transaction.
Example: https://www.example.com/return.php

Asynchronous POST notifications will be sent to this URL.
Example: https://www.example.com/notify.php

The urlHash field is a combination of your API Passphrase, and specific parameters sent in the transaction. See Web URL Hash for information on how to construct the hash correctly.
Example: Queensland
Valid Length: Up to 32 characters

Used to salt the return hash used in the 302 Redirect to redirectURL upon the completion of a transaction.
Example: 3x4mpl3s4lt!

The amount must be formatted to have two decimal places. Any amounts without two decimal places or amounts less than one cent will be rejected. This field is not required if you are submitting a direct debit authorization that has a variable amount.
Example: 10.00

The URL to an image that will appear in the header of the hosted payment page. Image must be of PNG format and max dimensions of 90x90 pixels and a file size limit of 1500 kilobytes. If no logoURL is supplied a default Direct Debit icon is displayed.
Example: https://www.example.com/logo.png

Digits only. The ID of the customized hosted payment page. This can be implemented if multiple hosted DDA pages with different logos and banners are a requirement.
Example: 1

Freeform field. Returned as <custom1> in the XML response.
Valid length: Up to 500 characters

Freeform field. Returned as <custom2> in the XML response.
Valid length: Up to 500 characters

Freeform field. Returned as <custom3> in the XML response.
Valid length: Up to 500 characters