Introduction

The following sections outline the different callback notifications that are used throughout the APIs.

Prior to being able to receive callbacks to your notifyURL you will need to have the relative product configured with your URL(s).

Direct Debit Notification

This notification is triggered every hour and sends a ZIP compressed CSV file that contains a list of all cleared direct debit from bank account transactions at the present time.

Transactions that are created via the processDDebit function will initially be marked as having a status of pending. As the status of the transaction(s) update (approved or declined) over the following (2) days, they will be listed in the compressed CSV that you receive from this callback.

A sample compressed Direct Debit Notify CSV can be found here

Headers

Header Description
MWFILEHASH

An md5 hash of your API Passphrase (see DDNotify File Hash and the compressed csv file that your notifyURL receives. This can be used as a method to verify that the file you receive from us has not been tampered with or become corrupt during transit.

CSV Columns

Column Description
Transaction ID

The direct debit transaction ID.
Example: 52-1031d519-a67e-11ec-abd4-005056b209e0

MW Response

The Merchant Warrior transaction status response.
Example: approved

Amount

The original transaction amount formatted to two decimal places.
Example: 10.00

Currency

The original transaction currency.
Example: AUD

Created

The date/time that the transaction was initially created.
Example: 18/03/2022 16:41:30

Processed

The date/time the transaction was processed.
Example: 18/03/2022 16:50:13

Account Name

The customer's bank account name.
Example: Bob Smith

Account BSB

The customer's bank account BSB.
Example: 111-111

Account Number

The customer's bank account number.
Example: 12341234

Custom 1

Freeform field for you use. If it is set it will be returned.
Example: 3516843

Custom 2

Freeform field for you use. If it is set it will be returned.
Example: 3516843

Custom 3

Freeform field for you use. If it is set it will be returned.
Example: 3516843

Store ID

The store identifier. If your account is enabled for this feature and it has been set, it will be returned.
Example: 90

Type

Defines the type of transaction.
Example: ddebit

Provider Response

The response code and message returned by the Bank.
Example: 0 - Approved

EFT Notification

This notification is triggered every hour and sends a ZIP compressed CSV file that contains a list of all cleared EFT bank account transactions at the present time.

A sample compressed EFT Notify CSV can be found here

Headers

Header Description
Mw-Filehash

A sha256 hash of the compressed csv file that your notifyURL receives. This can be used as a method to verify that the file you receive from us has not been tampered with or become corrupt during transit.

Mw-Signature

A unique 25 character string prefixed with MW that is used to verify the Mw-Signaturehash.
Example: MW6253bdf46e05e9.33850753

Mw-Signaturehash

A sha256 hash of your API Passphrase, merchantUUID and Signature (from above) (see Signature Hash. This can be used to verify the authenticity of the request you receive to ensure that it is from our platform and has not been tampered with during transit.

CSV Columns

Column Description
Merchant ID

The Merchant ID associated with the transaction.
Example: 4f90ea634abd6

Processed Date

The date (dd/mm/yyyy) the transaction was processed.
Example: 11/04/2096

Processed Time

The time (hh:mm:ss) the transaction was processed.
Example: 15:03:32

Settled Date

The date (dd/mm/yyyy) the transaction will be settled to your settlement account. Example: 12/04/2096

Transaction ID

The EFT/PayID transaction ID.
Example: 52-1031d519-a67e-11ec-abd4-005056b209e0

Payment Source

The source or channel of the transaction.
Example: EFT

Amount

The transaction amount formatted to two decimal places.
Example: 10.00

Currency

The transaction currency.
Example: AUD

Status

The status of the transaction.
Example: approved

Fee

The fee associated with the transaction formatted to two decimal places.
Example 0.65

Incoming BSB

Your BSB that the customer paid to.
Example: 801457

Incoming Account Number

Your account number that the customer paid to.
Example: 1234567

Customer Account Name

The account name of the payment initiator.
Example: Will Smith

Customer BSB

The BSB of the payment initiator.
Example: 325647

Customer Account Number

The account number of the payment initiator.
Example: 5467898

Customer Account Reference

The reference the payment initiator used when submitting the transaction.
Example: ABCD1234

Customer Bank

The bank name of the payment initiator.
Example: CBA

PayID

The PayID associated with the Incoming BSB and Incoming Account Number from above. This will only be present if your account has been enabled for PayID.
Example: [email protected]

Customer Description

The description the payment initiator used when submitting the transaction. Data for this field will only be present if the transaction was sent to a PayID.
Example: This can potentially be a very long string 280 characters to be exact

BPAY Notification

This notification is triggered every hour and sends a ZIP compressed CSV file that contains a list of all cleared BPAY transactions at the present time.

A sample compressed BPAY Notify CSV can be found here

Headers

Header Description
Mw-Filehash

A sha256 hash of the compressed csv file that your notifyURL receives. This can be used as a method to verify that the file you receive from us has not been tampered with or become corrupt during transit.

Mw-Signature

A unique 25 character string prefixed with MW that is used to verify the Mw-Signaturehash.
Example: MW6253bdf46e05e9.33850753

Mw-Signaturehash

A sha256 hash of your API Passphrase, merchantUUID and Signature (from above) (see Signature Hash. This can be used to verify the authenticity of the request you receive to ensure that it is from our platform and has not been tampered with during transit.

CSV Columns

Column Description
Merchant ID

The Merchant ID associated with the transaction.
Example: 4f90ea634abd6

Processed Date

The date (dd/mm/yyyy) the transaction was processed.
Example: 11/04/2096

Processed Time

The time (hh:mm:ss) the transaction was processed.
Example: 15:03:32

Settled Date

The date (dd/mm/yyyy) the transaction will be settled to your settlement account. Example: 12/04/2096

Transaction ID

The BPAY transaction ID.
Example: 52-1031d519-a67e-11ec-abd4-005056b209e0

Payment Source

The source or channel of the transaction.
Example: BPAY

Amount

The transaction amount formatted to two decimal places.
Example: 10.00

Currency

The transaction currency.
Example: AUD

Status

The status of the transaction.
Example: approved

Fee

The fee associated with the transaction formatted to two decimal places.
Example 0.65

Biller Code

The 6 digit Biller Code associated with your account.
Example: 548789

CRN

The unique customer reference number input by the payment initiator when submitting the transaction. This should match the unique CRN that you generated for the customer when issuing them their bill.
Example: 55142467

Customer Bank

The bank name of the payment initiator.
Example: CBA

Chargeback Notification

This notification is triggered every day and sends a ZIP compressed CSV file that contains a list of all Chargeback transactions at the present time.

A sample compressed Chargeback Notify CSV can be found here

Headers

Header Description
Mw-Filehash

A sha256 hash of the compressed csv file that your notifyURL receives. This can be used as a method to verify that the file you receive from us has not been tampered with or become corrupt during transit.

Mw-Signature

A unique 25 character string prefixed with MW that is used to verify the Mw-Signaturehash.
Example: MW6253bdf46e05e9.33850753

Mw-Signaturehash

A sha256 hash of your API Passphrase, merchantUUID and Signature (from above) (see Signature Hash. This can be used to verify the authenticity of the request you receive to ensure that it is from our platform and has not been tampered with during transit.

CSV Columns

Column Description
Transaction ID

The transaction ID associated with the Chargeback.
Example: 52-1031d519-a67e-11ec-abd4-005056b209e0

Purchase Date

The date (mm/dd/yy) of the original purchase or captured transaction.
Example: 041996

Card Number

The masked card number represented by first 6 (BIN) xxx last 4 digits of the card number.
Example: 512345xxx1245

Microfilm Reference

Reference data for use by the Acquirer.
Example: microfilm625e27cab61d1

Customer Name

The name of the customer associated with the chargeback transaction.
Example: Will Rock

Customer Addresss

The address of the customer associated with the chargeback transaction.
Example: 45 Venture Street

Amount

The chargeback amount formatted to two decimal places.
Example: 10.00

Reason

The chargeback reason code and description. You can find a list of chargeback reason codes and their descriptions here.
Example: 11.3 - No Authorisation

Merchant ID

The Merchant ID associated with the transaction.
Example: 4f90ea634abd6

processCard Notification

This notification is triggered every time a notifyURL is specified in a processCard request.

Parameters

Parameter Description
responseCode

Response code for the transaction, as described here.

responseMessage

Response message for the transaction.

transactionID

Unique transactionID for the transaction.

authSettledDate

Settlement date returned by an issuer and/or acquiring switch when processing the transaction.

authCode

Authorization code that is returned by an issuer and/or acquiring switch when processing the transaction.

receiptNo

Receipt number that is returned by an issuer and/or acquiring switch when processing the transaction.

authMessage

Authorization Response Message that is returned by an issuer and/or acquiring switch when processing the transaction, as described here.

authResponseCode

Authorization Response Code that is returned by an issuer and/or acquiring switch when processing the transaction, as described here.

transactionReferenceID

This is a merchant’s unique reference ID for a transaction sent to Merchant Warrior.

custom1

Freeform field, specified in request.

custom2

Freeform field, specified in request.

custom3

Freeform field, specified in request.

customHash

Verification hash of custom fields, as described here.

storeID

The value of this field is the merchant's store name.

paymentCardNumber

Masked card number used in request.

transactionAmount

transactionAmount used in request.

feeAmount

The fee charged for the transaction.

cardType

The card type used in the transaction.

cardExpiryMonth

Expiry month of the card used in the transaction.

cardExpiryYear

Expiry year of the card used in the transaction.

binBankName

Bank name that issued the card used in the transaction.

binCountry

Country of origin of the card used in the transaction.

binLevel

Card level of the card used in the transaction.

Copy
<?xml version="1.0"?>
<mwResponse>
  <custom1/>
  <cardExpiryYear>29</cardExpiryYear>
  <custom2/>
  <custom3/>
  <responseMessage>Transaction approved</responseMessage>
  <transactionReferenceID/>
  <cardType>visa</cardType>
  <binBankName>WESTPAC BANKING CORPORATION</binBankName>
  <responseCode>0</responseCode>
  <binCountry>AU</binCountry>
  <authCode>585033</authCode>
  <transactionAmount>1.00</transactionAmount>
  <authResponseCode>0</authResponseCode>
  <transactionID>1500-b99fc09d-5b10-11ed-abcd-005056a5521a</transactionID>
  <receiptNo>67868049603</receiptNo>
  <storeID>store name</storeID>
  <binLevel>Classic</binLevel>
  <cardExpiryMonth>02</cardExpiryMonth>
  <feeAmount>0.28</feeAmount>
  <customHash>f798d0369b63bc687dbd8c716535eacc</customHash>
  <authSettledDate>2022-11-07</authSettledDate>
  <paymentCardNumber>456471XXXXXX0004</paymentCardNumber>
  <authMessage>Approved</authMessage>
</mwResponse>
29 Transaction approved visa WESTPAC BANKING CORPORATION 0 AU 585033 1.00 0 1500-b99fc09d-5b10-11ed-abcd-005056a5521a 67868049603 store name Classic 02 0.28 f798d0369b63bc687dbd8c716535eacc 2022-11-07 456471XXXXXX0004 Approved
{
    "custom1": "",
    "cardExpiryYear": "29",
    "custom2": "",
    "custom3": "",
    "responseMessage": "Transaction approved",
    "transactionReferenceID": "",
    "cardType": "visa",
    "binBankName": "WESTPAC BANKING CORPORATION",
    "responseCode": "0",
    "binCountry": "AU",
    "authCode": "585033",
    "transactionAmount": "1.00",
    "authResponseCode": "0",
    "transactionID": "1500-b99fc09d-5b10-11ed-abcd-005056a5521a",
    "receiptNo": "67868049603",
    "storeID": "store name",
    "binLevel": "Classic",
    "cardExpiryMonth": "02",
    "feeAmount": "0.28",
    "customHash": "f798d0369b63bc687dbd8c716535eacc",
    "authSettledDate": "2022-11-07",
    "paymentCardNumber": "456471XXXXXX0004",
    "authMessage": "Approved"
}
{ "custom1": "", "cardExpiryYear": "29", "custom2": "", "custom3": "", "responseMessage": "Transaction approved", "transactionReferenceID": "", "cardType": "visa", "binBankName": "WESTPAC BANKING CORPORATION", "responseCode": "0", "binCountry": "AU", "authCode": "585033", "transactionAmount": "1.00", "authResponseCode": "0", "transactionID": "1500-b99fc09d-5b10-11ed-abcd-005056a5521a", "receiptNo": "67868049603", "storeID": "store name", "binLevel": "Classic", "cardExpiryMonth": "02", "feeAmount": "0.28", "customHash": "f798d0369b63bc687dbd8c716535eacc", "authSettledDate": "2022-11-07", "paymentCardNumber": "456471XXXXXX0004", "authMessage": "Approved" }
POS Notification

This notification is triggered every time a POS transaction is completed.

Parameters

Parameter Description
responseCode

Merchant Warrior response code

responseMessage

Merchant Warrior response message

transactionID

Unique transactionID for the transaction.

authCode

Authorization code that is returned by an issuer and/or acquiring switch when processing the transaction.

receiptNo

Receipt number that is returned by an issuer and/or acquiring switch when processing the transaction.

authMessage

Authorization Response Message that is returned by an issuer and/or acquiring switch when processing the transaction, as described here.

authResponseCode

Authorization Response Code that is returned by an issuer and/or acquiring switch when processing the transaction, as described here.

authSettledDate

Settlement date returned by an issuer and/or acquiring switch when processing the transaction.

transactionAmount

transactionAmount used in request.

transactionCurrency

transactionCurrency used in request.

custom1

Freeform field, specified in request.

custom2

Freeform field, specified in request.

custom3

Freeform field, specified in request.

transactionType

One of the following:

  • purchase
  • refund
  • void
originalTransactionID

If a refund, the original purchase transaction ID will be here.

customHash

A hash of the custom fields, which can be used for verification purposes, as described here.

transactionProduct

A product (or sale) id or description. This field’s primary purpose is to help the transaction be identifiable for reporting and accounting purposes.

transactionReferenceID

This is a merchant’s unique reference ID for a transaction sent to Merchant Warrior.

customerName

The field of the same name used in the request.

customerCountry

The field of the same name used in the request.

customerState

The field of the same name used in the request.

customerCity

The field of the same name used in the request.

customerAddress

The field of the same name used in the request.

customerPostcode

The field of the same name used in the request.

customerPhone

The field of the same name used in the request.

customerEmail

The field of the same name used in the request.

cardName

The field of the same name used in the request.

cardNumberFirst

The first 4 digits of the card used in the transaction.

cardNumberLast

The last 4 digits of the card used in the transaction

cardType

The card type used in the transaction.

transactionProcessed

The date and time the transaction was processed

surchargeAmount

The amount specified as a surcharge. This value will already be reflected in the transactionAmount field. For example, if the purchase amount was $10.00 and the surcharge was $0.12 then the transaction amount will be $10.12.

refundAmount

The amount refunded, for refund transactions

voidTransactionID

If a void, the original purchase transaction ID will be here.

posID

The ID of the terminal.

Copy
<?xml version="1.0"?>
<mwResponse>
  <custom1/>
  <custom2/>
  <custom3/>
  <voidTransactionID/>
  <responseMessage>Transaction approved</responseMessage>
  <originalTransactionID/>
  <transactionReferenceID/>
  <customerCity>N/A</customerCity>
  <customerName>N/A</customerName>
  <cardType>visa</cardType>
  <customerPostcode>N/A</customerPostcode>
  <responseCode>0</responseCode>
  <cardNumberLast>1034</cardNumberLast>
  <transactionCurrency>AUD</transactionCurrency>
  <customerPhone/>
  <refundAmount>0.00</refundAmount>
  <transactionProcessed>2023-06-30 15:40:54</transactionProcessed>
  <transactionProduct>1234</transactionProduct>
  <customerState>N/A</customerState>
  <authCode>111118</authCode>
  <transactionAmount>10.12</transactionAmount>
  <customerAddress>N/A</customerAddress>
  <authResponseCode>00</authResponseCode>
  <cardNumberFirst>4622</cardNumberFirst>
  <customerCountry>AU</customerCountry>
  <transactionType>purchase</transactionType>
  <transactionID>20066-973c3b55-1708-11ee-94aa-005056a5723f</transactionID>
  <receiptNo/>
  <cardName/>
  <surchargeAmount>0.12</surchargeAmount>
  <customerEmail/>
  <customHash>9351c44b4c138c3dccb70f1decd000c3</customHash>
  <authSettledDate>2023-07-04</authSettledDate>
  <authMessage>Approved</authMessage>
  <posID>10050001</posID>
</mwResponse>
Transaction approved N/A N/A visa N/A 0 1034 AUD 0.00 2023-06-30 15:40:54 1234 N/A 111118 10.12 N/A 00 4622 AU purchase 20066-973c3b55-1708-11ee-94aa-005056a5723f 0.12 9351c44b4c138c3dccb70f1decd000c3 2023-07-04 Approved 10050001
{
    "custom1": "",
    "custom2": "",
    "custom3": "",
    "voidTransactionID": "",
    "responseMessage": "Transaction approved",
    "originalTransactionID": "",
    "transactionReferenceID": "",
    "customerCity": "N\/A",
    "customerName": "N\/A",
    "cardType": "visa",
    "customerPostcode": "N\/A",
    "responseCode": "0",
    "cardNumberLast": "1034",
    "transactionCurrency": "AUD",
    "customerPhone": "",
    "refundAmount": "0.00",
    "transactionProcessed": "2023-06-30 15:40:54",
    "transactionProduct": "1234",
    "customerState": "N\/A",
    "authCode": "111118",
    "transactionAmount": "10.12",
    "customerAddress": "N\/A",
    "authResponseCode": "00",
    "cardNumberFirst": "4622",
    "customerCountry": "AU",
    "transactionType": "purchase",
    "transactionID": "20066-973c3b55-1708-11ee-94aa-005056a5723f",
    "receiptNo": "",
    "cardName": "",
    "surchargeAmount": "0.12",
    "customerEmail": "",
    "customHash": "9351c44b4c138c3dccb70f1decd000c3",
    "authSettledDate": "2023-07-04",
    "authMessage": "Approved",
    "posID": "10050001"
}
{ "custom1": "", "custom2": "", "custom3": "", "voidTransactionID": "", "responseMessage": "Transaction approved", "originalTransactionID": "", "transactionReferenceID": "", "customerCity": "N\/A", "customerName": "N\/A", "cardType": "visa", "customerPostcode": "N\/A", "responseCode": "0", "cardNumberLast": "1034", "transactionCurrency": "AUD", "customerPhone": "", "refundAmount": "0.00", "transactionProcessed": "2023-06-30 15:40:54", "transactionProduct": "1234", "customerState": "N\/A", "authCode": "111118", "transactionAmount": "10.12", "customerAddress": "N\/A", "authResponseCode": "00", "cardNumberFirst": "4622", "customerCountry": "AU", "transactionType": "purchase", "transactionID": "20066-973c3b55-1708-11ee-94aa-005056a5723f", "receiptNo": "", "cardName": "", "surchargeAmount": "0.12", "customerEmail": "", "customHash": "9351c44b4c138c3dccb70f1decd000c3", "authSettledDate": "2023-07-04", "authMessage": "Approved", "posID": "10050001" }