1. Batch
Merchant Warrior API 2.0
  • API
    • Getting Started
    • Guides
      • Xero Connection
      • Xero Custom URL
      • wooCommerce PayID
      • Middleware
      • Hostaway
    • Direct API
      • getAccessToken
      • processCard
      • processAuth
      • processCapture
      • processBatch
      • retrieveBatch (CSV)
      • retrieveBatch (JSON Response)
      • retrieveBatch (JSON Notify)
      • refundCard
      • queryCard
      • processDDebit
      • processDDebitAuth
      • processVoid
      • verifyCard
      • queryDD
      • queryBIN
      • getSettlement
      • checkEnrollment
      • checkPARes
      • addBlacklistedCard
      • removeBlacklistedCard
      • queryBlacklistedCard
      • simulateNotify
      • getSurcharge
    • 3DS 2.0
      • Introduction
      • 3DS 2 Authentication Flows
      • Step 3 - 3DS Method Data
      • Step 5 - Challenge
      • Step 1 - getAccessToken
      • Step 2 - checkEnrollment
      • Step 4 - checkTDSAuth
      • Step 6 - checkPARes
      • Step 7 - processCard
      • Authorization Only processCard
    • PayLink
      • Introduction
      • Generate PayLink
    • PayID
      • Introduction
      • Create
      • Transaction
      • Get
      • Update
      • Status
      • List
      • Refund
    • PayTo
      • Introduction
      • Simulator
      • Certification
      • Actions and Statuses
      • Agreements
        • Agreements
        • Notifications
        • Create Agreement
        • Get Agreement
        • Amend Agreement
        • Amend Agreement Status
        • Recall Agreement Action
      • Payments
        • Payments
        • Notifications
        • Create Payment
        • Get Payment
        • Get Payment Status
        • Search Payments
    • Confirmation of Payee
      • Introduction
      • Sandbox Simulations
      • Validate
    • POS
      • Introduction
      • processPOS
      • refundPOS
      • voidPOS
      • deregisterPOS
    • Web SDK
      • Introduction
      • Usage
      • getAccessToken
      • Options
      • Initiate
      • Payframe Functionality
      • Middleware
      • addCard
    • Payframe
      • Introduction
      • Usage
      • Constructor
      • tdsCheck
      • Additional Functions
      • Styling
      • processCard
      • processAuth
    • Digital Wallets
      • Apple Pay Prerequisites
      • Google Pay Prerequisites
      • Web SDK
      • Manual Integration
      • processCard
      • addCard
      • getMerchantSession
      • decryptApplePayToken
    • Token Payments
      • Introduction
      • Key Management
      • addCard
      • removeCard
      • cardInfo
      • changeExpiry
      • processCard
      • processAuth
    • Batch
      • Introduction
      • Card Batches
      • Token Batches
      • Direct Debit Batches
    • Forter
      • Introduction
      • Testing
    • Payouts
      • Introduction
      • Sandbox Simulations
      • Notifications
      • Create Payouts
      • Get Payout Status
      • Resend Notifications
      • Get Payout Transaction Status
      • Get Payout Transaction Notify
    • Partner API
      • Introduction
      • addMerchant
      • updateMerchant
      • checkMerchant
    • Notifications
      • Notifications
  • Hosted Payment Page
    • processCard
  1. Batch

Token Batches

Sample batch files for tokens can be found here.

Request CSV Parameters#

ParameterDescription
transactionProductA 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. Some acquirers limit this field to 40 characters.
customerNameCan 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.
customerPhoneThe 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.
customerEmailThe customer's email address.

Example: person@example.com
Valid length: Up to 255 characters.
customerCountryTwo-letter ISO 3166-1 alpha-2 country code.

Example: AU
Valid length: 2 characters.
customerStateFree-form field. Keep values consistent for your records and reporting.

Example: Queensland
Valid length: Up to 75 characters.
customerCityFree-form field. Keep values consistent for your records and reporting.

Example: Brisbane
Valid length: Up to 75 characters.
customerAddressFree-form field.

Example: 123 Test Street
Valid length: Up to 255 characters.
customerPostCodeSupports ZIP and postal codes for international transactions.

Example: 4000
Valid length: Between 4 and 10 characters.
cardIDA unique alphanumeric string returned by addCard, used to identify a specific card.

Example: NUFM56937091
cardKeyA per-card encryption and decryption key used when the card is stored. The correct key, known only by you, must be provided with every process-card request.

Example: a84JI2cA12ziZ3Fx
Valid length: 16 characters.
Required: Conditional — not required for general use, but required when cardKeyReplace is used.
cardKeyReplaceReplaces cardKey for subsequent requests for the cardID when the transaction is successfully accepted by Merchant Warrior, regardless of whether the bank approves it. It cannot match any of the previous 10 card keys used for the cardID and must follow the same rules as cardKey, including being a 16-character alphanumeric string. See the explanation under Request Parameters for more information.

Example: mbnGHOq86sXTjQgd
Valid length: 16 characters.
Required: Conditional — not required for general use, but required when cardKey is used.
transactionTypeThe type of transaction to perform.

Possible values: purchase, refund, auth, capture
transactionAmountThe 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
transactionCurrencyThe transaction currency. See the supported currencies page for accepted currencies. This field is case-insensitive.

Example: AUD
refundAmountThe 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
captureAmountThe 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
transactionIDIdentifies the original transaction when transactionType is refund or capture.

Example: 74-75db9ba2-caf5-11ee-802f-005056a5521a
custom1Free-form field. Returned as <custom1> in the response.

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

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

Valid length: Up to 500 characters.
surchargeIndicates whether a surcharge should be added to the transaction.

Possible values: 0, 1

Response CSV Parameters#

ParameterDescription
Transaction IDThe Merchant Warrior transaction ID.

Example: 1600-d400df09-be66-11ee-b58c-005056a5521a
ResultThe result of the transaction.

Possible values: Fail, Success
AmountThe transaction amount.

Example: 12.50
CurrencyThe transaction currency.

Example: AUD
Created DateThe date the transaction was created.

Example: 29/01/2024
Created TimeThe time the transaction was created.

Example: 16:25:34
Processed DateThe date the transaction was processed.

Example: 29/01/2024
Processed TimeThe time the transaction was processed.

Example: 16:25:34
Card Name/Card IDThe cardID that was processed.

Example: HAVC76258115
Card Number/Card KeyThe card key that was used.

Example: qDKEIwqJuGyWqZSa
Custom 1The value of custom1 from the request CSV.
Custom 2The value of custom2 from the request CSV.
Custom 3The value of custom3 from the request CSV.
Store IDThe storeID used for the transaction.
TypeThe transaction type.

Possible values: purchase, refund, auth, capture
MW ResponseMerchant Warrior's transaction response.

Example: Transaction approved
Provider ResponseThe provider's transaction response.

Example: 00 - Approved
Fee AmountThe transaction fee.

Example: 0.39
Modified at 2026-07-17 00:49:05
Previous
Card Batches
Next
Direct Debit Batches
Built with