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.

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

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

The customer's email.
Example: [email protected]
Valid length: Up to 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

Only certain card numbers are deemed valid in the test environment. See Test Data for more information. Do not send separators with the card number (e.g. 1234-5678… or 1234 5678).
Example: 5123456789012346 or 4557012345678902
Valid length: Between 13 and 16 digits

This must be MMYY format. The month must be zero padded if it is less than 10.
Example: 0513
Valid length: 4 digits

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 255 characters

Indicates the type of transaction to perform
Possible values -

• purchase
• refund
• auth
• capture

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, FJD, HKD, MYR, THB, IDR, ZAR. This is provider dependent. Please check with MW before attempting to process transactions in any currency other than AUD. This field is case insensitive.
Example: AUD

The amount to refund to the cardholder. 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. transactionID field must also be present for refund to work.
Example: 10.00

The amount to capture from an auth. 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. transactionID field must also be present for capture to work.
Example: 10.00

Used to specify the original transaction when transactionType is either refund or capture.
Example: 74-75db9ba2-caf5-11ee-802f-005056a5521a

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

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

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

Indicates if the transaction should have a surcharge added
Possible values: 0 or 1

The Merchant Warrior transaction ID
Example: 1600-d400df09-be66-11ee-b58c-005056a5521a

Result of the transaction

Possible values -

• Fail
• Success

Amount of the transaction.
Example: 12.50

Currency of the transaction.
Example: AUD

Date the transaction was created.
Example: 29/01/2024

Time the transaction was created.
Example: 16:25:34

Date the transaction was processed.
Example: 29/01/2024

Time the transaction was processed.
Example: 16:25:34

The name on the card processed. Example: John Smith

The masked card number processed. Example: 4564xxxxxxxx0004

The value of custom1 in the request CSV.

The value of custom2 in the request CSV.

The value of custom3 in the request CSV.

The storeID used for the transaction.

Type of the transaction

Possible values -

• purchase
• refund
• auth
• capture

Merchant Warrior's transaction response.
Example: Transaction approved

The provider's transaction response.
Example: 00 - Approved

The fee for the transaction.
Example: 0.39

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.

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

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

The customer's email.
Example: [email protected]
Valid length: Up to 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

A unique alphanumeric string returned by addCard, used to identify a specific card.
Example: NUFM56937091

A string used as an encryption/decryption key. This should be unique on a per-card basis. It's used to encrypt the card when we store it. Every time we receive a process card request, the correct cardkey must also be provided - which is known only by you.
Example: a84JI2cA12ziZ3Fx
Valid Length: 16 characters
Required: Conditional - Not required for general use, but required if cardKeyReplace is used

This will replace cardKey for subsequent requests for the cardID if the transaction is run successfully (meaning accepted by Merchant Warrior, not necessarily approved by the bank). This cannot be the same as the last 10 cardKey's used for the cardID, and it has to follow the same guidelines as cardkey (16 character alphanumeric string, etc). See the explanation under "Request Parameter" for more information.
Example: mbnGHOq86sXTjQgd
Valid Length: 16 characters
Required: Conditional - Not required for general use, but required if cardKey is used

Indicates the type of transaction to perform
Possible values -

• purchase
• refund
• auth
• capture

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, FJD, HKD, MYR, THB, IDR, ZAR. This is provider dependent. Please check with MW before attempting to process transactions in any currency other than AUD. This field is case insensitive.
Example: AUD

The amount to refund to the cardholder. 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. transactionID field must also be present for refund to work.
Example: 10.00

The amount to capture from an auth. 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. transactionID field must also be present for capture to work.
Example: 10.00

Used to specify the original transaction when transactionType is either refund or capture.
Example: 74-75db9ba2-caf5-11ee-802f-005056a5521a

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

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

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

Indicates if the transaction should have a surcharge added
Possible values: 0 or 1

The Merchant Warrior transaction ID
Example: 1600-d400df09-be66-11ee-b58c-005056a5521a

Result of the transaction

Possible values -

• Fail
• Success

Amount of the transaction.
Example: 12.50

Currency of the transaction.
Example: AUD

Date the transaction was created.
Example: 29/01/2024

Time the transaction was created.
Example: 16:25:34

Date the transaction was processed.
Example: 29/01/2024

Time the transaction was processed.
Example: 16:25:34

The cardID that was processed. Example: HAVC76258115

The card key that was used. Example: qDKEIwqJuGyWqZSa

The value of custom1 in the request CSV.

The value of custom2 in the request CSV.

The value of custom3 in the request CSV.

The storeID used for the transaction.

Type of the transaction

Possible values -

• purchase
• refund
• auth
• capture

Merchant Warrior's transaction response.
Example: Transaction approved

The provider's transaction response.
Example: 00 - Approved

The fee for the transaction.
Example: 0.39

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.

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

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

The customer's email.
Example: [email protected]
Valid length: Up to 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 accommodate ZIP/Post codes for international transactions.
Example: 4000
Valid length: Between 4 and 10 characters

The type of transaction being performed. Must be ddebit for direct debit batches.

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, NZD. 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

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

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

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

This field must contain 6 digits.
Example: 011123
Valid length: 6 digits

This must be a valid account number.
Example: 123456789
Valid length: 4-10 digits

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

This is a merchant’s unique reference ID for a transaction sent to Merchant Warrior. The main purpose of this ID is to verify the transaction via the queryCard method in the event a valid response is not received.
Example: 0e26df01-1460-4565-894b-e3a16dd53c7a
Valid length: Up to 40 characters
Required: No