| 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: ABC4321Valid length: Up to 255 characters. Some acquirers limit this field to 40 characters. |
customerName | Can contain only alphanumeric characters and the following characters: full stop (.), comma (,), apostrophe ('), ampersand (&), space, and hyphen (-).Example: Mr. Example PersonValid 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 61731234567Valid length: Up to 25 characters. |
customerEmail | The customer's email address. Example: person@example.comValid length: Up to 255 characters. |
customerCountry | Two-letter ISO 3166-1 alpha-2 country code. Example: AUValid length: 2 characters. |
customerState | Free-form field. Keep values consistent for your records and reporting. Example: QueenslandValid length: Up to 75 characters. |
customerCity | Free-form field. Keep values consistent for your records and reporting. Example: BrisbaneValid length: Up to 75 characters. |
customerAddress | Free-form field. Example: 123 Test StreetValid length: Up to 255 characters. |
customerPostCode | Supports ZIP and postal codes for international transactions. Example: 4000Valid length: Between 4 and 10 characters. |
paymentCardNumber | Only certain card numbers are valid in the test environment. See Test Data for more information. Do not include separators such as hyphens or spaces. Example: 5123456789012346 or 4557012345678902Valid length: Between 13 and 16 digits. |
paymentCardExpiry | Card expiry in MMYY format. The month must be zero-padded when less than 10.Example: 0513Valid length: 4 digits. |
paymentCardName | 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 PersonValid length: Between 3 and 255 characters. |
transactionType | The type of transaction to perform. Possible values: purchase, refund, auth, capture |
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. See the supported currencies page for accepted currencies. This field is case-insensitive. Example: AUD |
refundAmount | The amount to refund to the cardholder. It must contain exactly two decimal places. Amounts without two decimal places, or amounts less than one cent, will be rejected. The transactionID field is also required.Example: 10.00 |
captureAmount | The amount to capture from an authorization. It must contain exactly two decimal places. Amounts without two decimal places, or amounts less than one cent, will be rejected. The transactionID field is also required.Example: 10.00 |
transactionID | Identifies the original transaction when transactionType is refund or capture.Example: 74-75db9ba2-caf5-11ee-802f-005056a5521a |
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. |
surcharge | Indicates whether a surcharge should be added to the transaction. Possible values: 0, 1 |
| Parameter | Description |
|---|---|
Transaction ID | The Merchant Warrior transaction ID. Example: 1600-d400df09-be66-11ee-b58c-005056a5521a |
Result | The result of the transaction. Possible values: Fail, Success |
Amount | The transaction amount. Example: 12.50 |
Currency | The transaction currency. Example: AUD |
Created Date | The date the transaction was created. Example: 29/01/2024 |
Created Time | The time the transaction was created. Example: 16:25:34 |
Processed Date | The date the transaction was processed. Example: 29/01/2024 |
Processed Time | The time the transaction was processed. Example: 16:25:34 |
Card Name/Card ID | The name on the processed card. Example: John Smith |
Card Number/Card Key | The masked card number that was processed. Example: 4564xxxxxxxx0004 |
Custom 1 | The value of custom1 from the request CSV. |
Custom 2 | The value of custom2 from the request CSV. |
Custom 3 | The value of custom3 from the request CSV. |
Store ID | The storeID used for the transaction. |
Type | The transaction type. Possible values: purchase, refund, auth, capture |
MW Response | Merchant Warrior's transaction response. Example: Transaction approved |
Provider Response | The provider's transaction response. Example: 00 - Approved |
Fee Amount | The transaction fee. Example: 0.39 |