1. Notifications
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. Notifications

Notifications

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).
NOTE: We are pleased to announce support for JSON notifications, replacing our legacy CSV notification format. For implementation details, please refer to the JSON Notifications documentation.

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#

HeaderRequiredDescription
MWFILEHASHYesAn 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#

ColumnDescription
Transaction IDThe direct debit transaction ID.
Example: 52-1031d519-a67e-11ec-abd4-005056b209e0
MW ResponseThe Merchant Warrior transaction status response.
Example: approved
AmountThe original transaction amount formatted to two decimal places.
Example: 10.00
CurrencyThe original transaction currency.
Example: AUD
CreatedThe date/time that the transaction was initially created.
Example: 18/03/2022 16:41:30
ProcessedThe date/time the transaction was processed.
Example: 18/03/2022 16:50:13
Account NameThe customer's bank account name.
Example: Bob Smith
Account BSBThe customer's bank account BSB.
Example: 111-111
Account NumberThe customer's bank account number.
Example: 12341234
Custom 1Freeform field for you use. If it is set it will be returned.
Example: 3516843
Custom 2Freeform field for you use. If it is set it will be returned.
Example: 3516843
Custom 3Freeform field for you use. If it is set it will be returned.
Example: 3516843
Store IDThe store identifier. If your account is enabled for this feature and it has been set, it will be returned.
Example: 90
TypeDefines the type of transaction.
Example: ddebit
Provider ResponseThe response code and message returned by the Bank.
Example: 0 - Approved

EFT Notification#

This notification is triggered daily 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#

HeaderDescription
Mw-FilehashA 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-SignatureA unique 25 character string prefixed with MW that is used to verify the Mw-Signaturehash.
Example: MW6253bdf46e05e9.33850753
Mw-SignaturehashA 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#

ColumnDescription
Merchant IDThe Merchant ID associated with the transaction.
Example: 4f90ea634abd6
Processed DateThe date (dd/mm/yyyy) the transaction was processed.
Example: 11/04/2096
Processed TimeThe time (hh:mm:ss) the transaction was processed.
Example: 15:03:32
Settled DateThe date (dd/mm/yyyy) the transaction will be settled to your settlement account. Example: 12/04/2096
Transaction IDThe EFT/PayID transaction ID.
Example: 52-1031d519-a67e-11ec-abd4-005056b209e0
Payment SourceThe source or channel of the transaction.
Example: EFT
AmountThe transaction amount formatted to two decimal places.
Example: 10.00
CurrencyThe transaction currency.
Example: AUD
StatusThe status of the transaction.
Example: approved
FeeThe fee associated with the transaction formatted to two decimal places.
Example 0.65
Incoming BSBYour BSB that the customer paid to.
Example: 801457
Incoming Account NumberYour account number that the customer paid to.
Example: 1234567
Customer Account NameThe account name of the payment initiator.
Example: Will Smith
Customer BSBThe BSB of the payment initiator.
Example: 325647
Customer Account NumberThe account number of the payment initiator.
Example: 5467898
Customer Account ReferenceThe reference the payment initiator used when submitting the transaction.
Example: ABCD1234
Customer BankThe bank name of the payment initiator.
Example: CBA
PayIDThe 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: willsmith@payid.yourcompany.com
Customer DescriptionThe 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#

HeaderDescription
Mw-FilehashA 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-SignatureA unique 25 character string prefixed with MW that is used to verify the Mw-Signaturehash.
Example: MW6253bdf46e05e9.33850753
Mw-SignaturehashA 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#

ColumnDescription
Merchant IDThe Merchant ID associated with the transaction.
Example: 4f90ea634abd6
Processed DateThe date (dd/mm/yyyy) the transaction was processed.
Example: 11/04/2096
Processed TimeThe time (hh:mm:ss) the transaction was processed.
Example: 15:03:32
Settled DateThe date (dd/mm/yyyy) the transaction will be settled to your settlement account. Example: 12/04/2096
Transaction IDThe BPAY transaction ID.
Example: 52-1031d519-a67e-11ec-abd4-005056b209e0
Payment SourceThe source or channel of the transaction.
Example: BPAY
AmountThe transaction amount formatted to two decimal places.
Example: 10.00
CurrencyThe transaction currency.
Example: AUD
StatusThe status of the transaction.
Example: approved
FeeThe fee associated with the transaction formatted to two decimal places.
Example 0.65
Biller CodeThe 6 digit Biller Code associated with your account.
Example: 548789
CRNThe 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 BankThe 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#

HeaderDescription
Mw-FilehashA 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-SignatureA unique 25 character string prefixed with MW that is used to verify the Mw-Signaturehash.
Example: MW6253bdf46e05e9.33850753
Mw-SignaturehashA 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#

ColumnDescription
Transaction IDThe transaction ID associated with the Chargeback.
Example: 52-1031d519-a67e-11ec-abd4-005056b209e0
Purchase DateThe date (mm/dd/yy) of the original purchase or captured transaction.
Example: 041996
Card NumberThe masked card number represented by first 6 (BIN) xxx last 4 digits of the card number.
Example: 512345xxx1245
Microfilm ReferenceReference data for use by the Acquirer.
Example: microfilm625e27cab61d1
Customer NameThe name of the customer associated with the chargeback transaction.
Example: Will Rock
Customer AddresssThe address of the customer associated with the chargeback transaction.
Example: 45 Venture Street
AmountThe chargeback amount formatted to two decimal places.
Example: 10.00
ReasonThe chargeback reason code and description. You can find a list of chargeback reason codes and their descriptions here.
Example: 11.3 - No Authorisation
Merchant IDThe 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#

ParameterDescription
responseCodeResponse code for the transaction, as described here.
responseMessageResponse message for the transaction.
transactionIDUnique transactionID for the transaction.
authSettledDateSettlement date returned by an issuer and/or acquiring switch when processing the transaction.
authCodeAuthorization code that is returned by an issuer and/or acquiring switch when processing the transaction.
receiptNoReceipt number that is returned by an issuer and/or acquiring switch when processing the transaction.
authMessageAuthorization Response Message that is returned by an issuer and/or acquiring switch when processing the transaction, as described here.
authResponseCodeAuthorization Response Code that is returned by an issuer and/or acquiring switch when processing the transaction, as described here.
transactionReferenceIDThis is a merchant’s unique reference ID for a transaction sent to Merchant Warrior.
custom1Freeform field, specified in request.
custom2Freeform field, specified in request.
custom3Freeform field, specified in request.
customHashVerification hash of custom fields, as described here.
storeIDThe value of this field is the merchant's store name.
paymentCardNumberMasked card number used in request.
transactionAmounttransactionAmount used in request.
feeAmountThe fee charged for the transaction.
cardTypeThe card type used in the transaction.
cardExpiryMonthExpiry month of the card used in the transaction.
cardExpiryYearExpiry year of the card used in the transaction.
binBankNameBank name that issued the card used in the transaction.
binCountryCountry of origin of the card used in the transaction.
binLevelCard level of the card used in the transaction.

Response#

{
  "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#

ParameterDescription
responseCodeMerchant Warrior response code
responseMessageMerchant Warrior response message
transactionIDUnique transactionID for the transaction.
authCodeAuthorization code that is returned by an issuer and/or acquiring switch when processing the transaction.
receiptNoReceipt number that is returned by an issuer and/or acquiring switch when processing the transaction.
authMessageAuthorization Response Message that is returned by an issuer and/or acquiring switch when processing the transaction, as described here.
authResponseCodeAuthorization Response Code that is returned by an issuer and/or acquiring switch when processing the transaction, as described here.
authSettledDateSettlement date returned by an issuer and/or acquiring switch when processing the transaction.
transactionAmounttransactionAmount used in request.
transactionCurrencytransactionCurrency used in request.
custom1Freeform field, specified in request.
custom2Freeform field, specified in request.
custom3Freeform field, specified in request.
transactionTypeOne of the following:
* purchase
* refund
* void
originalTransactionIDIf a refund, the original purchase transaction ID will be here.
customHashA hash of the custom fields, which can be used for verification purposes, as described here.
transactionProductA product (or sale) id or description. This field’s primary purpose is to help the transaction be identifiable for reporting and accounting purposes.
transactionReferenceIDThis is a merchant’s unique reference ID for a transaction sent to Merchant Warrior.
customerNameThe field of the same name used in the request.
customerCountryThe field of the same name used in the request.
customerStateThe field of the same name used in the request.
customerCityThe field of the same name used in the request.
customerAddressThe field of the same name used in the request.
customerPostcodeThe field of the same name used in the request.
customerPhoneThe field of the same name used in the request.
customerEmailThe field of the same name used in the request.
cardNameThe field of the same name used in the request.
cardNumberFirstThe first 4 digits of the card used in the transaction.
cardNumberLastThe last 4 digits of the card used in the transaction
cardTypeThe card type used in the transaction.
transactionProcessedThe date and time the transaction was processed
surchargeAmountThe amount specified as a surcharge. This value will already be reflected in the transactionAmount field. For example, if the purchase amount was 0.12 then the transaction amount will be $10.12.
refundAmountThe amount refunded, for refund transactions
voidTransactionIDIf a void, the original purchase transaction ID will be here.
posIDThe ID of the terminal.

Response#

{
  "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",
  "posID": "10050001",
  "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"
}

JSON Notifications#

We are pleased to announce support for JSON notifications, which replace our legacy CSV notification format. To enable JSON notifications for your account, please contact our Merchant Warrior support team. Detailed implementation guidelines are provided in the documentation below.

EFT JSON Notification#

JSON EFT Object#

ParameterDescription
transactionType:
Description:
Example:
transaction.idType: String
Description: Unique identifier for the transaction.
Example: 1500-b0138d9d-48a8-11ef-983a-005056a5521a
transaction.statusType: String
Description: Current status of the transaction (e.g., approved, declined).
Example: approved
transaction.amountType: Number
Description: Transaction amount.
Example: 89
transaction.currencyType: String
Description: ISO currency code.
Example: AUD
transaction.productType: String
Description: Description of the product or service.
Example: Product Name
transaction.referenceType: String
Description: Optional reference information.
Example: Reference Name
transaction.datesType: Object
Description: Timestamps for various transaction events.
transaction.dates.createdType: String
Description: Date and time when the transaction was created.
Example: 2024-07-23 14:04:41
transaction.dates.processedType: String
Description: Date and time when the transaction was processed.
Example: 2024-07-23 14:04:41
transaction.dates.settledType: String
Description: Date when the transaction was settled.
Example: 2024-07-24
transaction.feeType: Number
Description: Fee applied to the transaction.
Example: 0.01
transaction.providerType: Object
Description: Provider-specific details.
transaction.provider.referenceType: String
Description: Provider’s reference identifier.
Example:
transaction.provider.responseType: String
Description: Response message or code from the provider.
Example:
customerType: Object
Description: Information about the customer involved in the transaction
customer.nameType: String
Description: Full name of the customer.
Example: Tony Stark
customer.countryType: String
Description: Customer’s country code (ISO format).
Example: AU
customer.stateType: String
Description: Customer’s state or region.
Example: Queensland
customer.cityType: String
Description: Customer’s city.
Example: Brisbane
customer.addressType: String
Description: Customer’s physical address.
Example: 345 Ann St
customer.postcodeType: String
Description: Postal code of the customer.
Example: 4000
customer.phoneType: String
Description: Customer’s phone number.
Example: 0491 571 266
customer.emailType: String
Description: Customer’s email address.
Example: tony@starkenterprises.com
customer.accountType: Object
Description: Bank account details associated with the customer.
customer.account.nameType: String
Description: Account holder’s name.
Example: Tony Stark
customer.account.bsbType: String
Description: Bank State Branch (BSB) code.
Example: 035-502
customer.account.numberType: String
Description: Bank account number.
Example: 12341234
incomingType: Object
Description: Details about the incoming bank account information and payment identifier.
incoming.accountType: Object
Description: Details of the incoming bank account.
incoming.account.nameType: String
Description: Account holder’s name.
Example: Pepper Potts
incoming.account.bsbType: String
Description: Bank State Branch (BSB) code.
Example: 804991
incoming.account.numberType: String
Description: Bank account number.
Example: 12
incoming.payIdType: Mixed
Description: Payment identifier (can be null if not provided).
Example: pepper@mw.payby.id

EFT Notification#

{
    "transaction": {
      "id": "1500-b0138d9d-48a8-11ef-983a-005056a5521a",
      "status": "approved",
      "amount": 89,
      "currency": "AUD",
      "product": "SimulateNotify TestTransactionProduct",
      "reference": "",
      "dates": {
        "created": "2024-07-23 14:04:41",
        "processed": "2024-07-23 14:04:41",
        "settled": "2024-07-24"
      },
      "fee": 0.01,
      "provider": {
        "reference": "",
        "response": ""
      }
    },
    "customer": {
      "name": "Tony Stark",
      "country": "AU",
      "state": "Queensland",
      "city": "",
      "address": "NA",
      "postcode": "NA",
      "phone": "",
      "email": "",
      "account": {
        "name": "Tony Stark",
        "bsb": "035-502",
        "number": "12341234"
      }
    },
    "incoming": {
      "account": {
        "name": "Tony Stark",
        "bsb": "804991",
        "number": "12"
      },
      "payId": null
    }
  }

BPAY JSON Notification#

JSON BPay Notification#

ParameterDescription
transactionType: Object
Description: Contains details about the transaction.
transaction.idType: String
Description: Unique identifier for the transaction.
Example: "1500-279f9e9d-48b4-11ef-983a-005056a5521a"
transaction.statusType: String
Description: Current status of the transaction (e.g., approved, pending, failed).
Example: "approved"
transaction.amountType: Number
Description: Transaction amount.
Example: 121
transaction.currencyType: String
Description: Currency code in which the transaction was processed (ISO 4217 format).
Example: "AUD"
transaction.productType: String
Description: Name of the product associated with the transaction.
Example: "Product Name"
transaction.referenceType: String
Description: Reference identifier for the transaction.
Example: "Reference Name"
transaction.datesType: Object
Description: Contains timestamps related to the transaction.
transaction.dates.createdType: String (ISO DateTime Format)
Description: Timestamp when the transaction was created.
Example: "2024-07-23 15:26:46"
transaction.dates.processedType: String (ISO DateTime Format)
Description: Timestamp when the transaction was processed.
Example: "2024-07-23 15:26:46"
transaction.dates.settledType: String (ISO Date Format)
Description: Date when the transaction was settled.
Example: "2024-07-23"
transaction.feeType: Number
Description: Transaction fee applied.
Example: 0.02
transaction.providerType: Object
Description: Contains details about the transaction provider.
transaction.provider.referenceType: String
Description: Reference provided by the payment provider (if applicable).
Example: ""
transaction.provider.responseType: String
Description: Response from the payment provider.
Example: ""
customerType: Object
Description: Contains customer-related account details.
customer.accountType: Object
Description: Customer's bank account information.
customer.account.nameType: String
Description: Name associated with the customer's bank account.
Example: ""
customer.account.bsbType: String
Description: Bank-State-Branch (BSB) number for the customer's account.
Example: ""
customer.account.numberType: String
Description: Customer's bank account number.
Example: ""
bpayType: Object
Description: BPAY payment details.
bpay.billerCodeType: String
Description: The BPAY biller code assigned to the merchant.
Example: "165931"
bpay.crnType: String
Description: Customer Reference Number (CRN) used for BPAY transactions.
Example: "12345678"

BPay Notification#

{
    "transaction": {
      "id": "1500-279f9e9d-48b4-11ef-983a-005056a5521a",
      "status": "approved",
      "amount": 121,
      "currency": "AUD",
      "product": "SimulateNotify TestProduct",
      "reference": "",
      "dates": {
        "created": "2024-07-23 15:26:46",
        "processed": "2024-07-23 15:26:46",
        "settled": "2024-07-23"
      },
      "fee": 0.02,
      "provider": {
        "reference": "",
        "response": ""
      }
    },
    "customer": {
      "account": {
        "name": "",
        "bsb": "",
        "number": ""
      }
    },
    "bpay": {
      "billerCode": "165931",
      "crn": "SimulateNotify TestProduct"
    }
  }

Direct Debit JSON Notification#

Direct Debit JSON Notification#

ParameterDescription
transactionType: Object
Description: Contains details about the transaction.
transaction.idType: String
Description: Unique identifier for the transaction.
Example: "1500-9a0837a1-48b6-11ef-983a-005056a5521a"
transaction.statusType: String
Description: Current status of the transaction (e.g., approved, pending, failed).
Example: "approved"
transaction.amountType: Number
Description: Transaction amount.
Example: 2
transaction.currencyType: String
Description: Currency code in which the transaction was processed (ISO 4217 format).
Example: "AUD"
transaction.productType: String
Description: Name of the product associated with the transaction.
Example: "SimulateNotify TestProduct"
transaction.referenceType: String
Description: Reference identifier for the transaction.
Example: ""
transaction.datesType: Object
Description: Contains timestamps related to the transaction.
transaction.dates.createdType: String (ISO DateTime Format)
Description: Timestamp when the transaction was created.
Example: "2024-07-23 15:44:17"
transaction.dates.processedType: String (ISO DateTime Format)
Description: Timestamp when the transaction was processed.
Example: "2024-07-23 15:44:17"
transaction.dates.settledType: String (ISO Date Format)
Description: Date when the transaction was settled.
Example: "2024-07-23"
transaction.feeType: Number
Description: Transaction fee applied.
Example: 0
transaction.providerType: Object
Description: Contains details about the transaction provider.
transaction.provider.referenceType: String
Description: Reference provided by the payment provider (if applicable).
Example: ""
transaction.provider.responseType: String
Description: Response from the payment provider.
Example: "0 - Approved"
transaction.customFieldsType: Object
Description: Contains custom fields associated with the transaction.
transaction.customFields.custom1Type: String
Description: Custom field 1.
Example: ""
transaction.customFields.custom2Type: String
Description: Custom field 2.
Example: ""
transaction.customFields.custom3Type: String
Description: Custom field 3.
Example: ""
transaction.storeIdType: Number
Description: Identifier for the store associated with the transaction.
Example: 0
customerType: Object
Description: Contains customer-related details.
customer.nameType: String
Description: Name of the customer.
Example: "SimulateNotify TestCustomerName"
customer.countryType: String
Description: Country of the customer.
Example: "Australia"
customer.stateType: String
Description: State of the customer.
Example: "Queensland"
customer.cityType: String
Description: City of the customer.
Example: ""
customer.addressType: String
Description: Address of the customer.
Example: "Test Address"
customer.postcodeType: String
Description: Postcode of the customer.
Example: "4000"
customer.phoneType: String
Description: Phone number of the customer.
Example: "12341234"
customer.emailType: String
Description: Email address of the customer.
Example: "test@test.com"
customer.accountType: Object
Description: Customer's bank account information.
customer.account.nameType: String
Description: Name associated with the customer's bank account.
Example: "test test"
customer.account.bsbType: String
Description: Bank-State-Branch (BSB) number for the customer's account.
Example: "111-111"
customer.account.numberType: String
Description: Customer's bank account number.
Example: "12341234"

Direct Debit Notification#

{
    "transaction": {
      "id": "1500-9a0837a1-48b6-11ef-983a-005056a5521a",
      "status": "approved",
      "amount": 2,
      "currency": "AUD",
      "product": "SimulateNotify TestProduct",
      "reference": "",
      "dates": {
        "created": "2024-07-23 15:44:17",
        "processed": "2024-07-23 15:44:17",
        "settled": "2024-07-23"
      },
      "fee": 0,
      "provider": {
        "reference": "",
        "response": "0 - Approved"
      },
      "customFields": {
        "custom1": "",
        "custom2": "",
        "custom3": ""
      },
      "storeId": 0
    },
    "customer": {
      "name": "SimulateNotify TestCustomerName",
      "country": "Australia",
      "state": "Queensland",
      "city": "",
      "address": "Test Address",
      "postcode": "4000",
      "phone": "12341234",
      "email": "test@test.com",
      "account": {
        "name": "test test",
        "bsb": "111-111",
        "number": "12341234"
      }
    }
  }

Chargeback JSON Notification#

Chargeback JSON Notification#

ParameterDescription
transactionType: Object
Description: Contains details about the transaction.
transaction.idType: String
Description: Unique identifier for the transaction.
Example: "1500-66f3a192-4fc1-11ef-bf40-005056a5521a"
transaction.statusType: String
Description: Current status of the transaction (e.g., approved, pending, failed).
Example: "approved"
transaction.amountType: Number
Description: Transaction amount.
Example: 144.89
transaction.currencyType: String
Description: Currency code in which the transaction was processed (ISO 4217 format).
Example: "AUD"
transaction.productType: String
Description: Name of the product associated with the transaction.
Example: "SimulateNotify TestProduct"
transaction.referenceType: String
Description: Reference identifier for the transaction.
Example: ""
transaction.datesType: Object
Description: Contains timestamps related to the transaction.
transaction.dates.createdType: String (ISO DateTime Format)
Description: Timestamp when the transaction was created.
Example: "2024-08-01 14:49:14"
transaction.dates.processedType: String (ISO DateTime Format)
Description: Timestamp when the transaction was processed.
Example: "2024-08-01 14:49:15"
transaction.dates.settledType: String (ISO Date Format)
Description: Date when the transaction was settled.
Example: "2024-08-02"
transaction.feeType: Number
Description: Transaction fee applied.
Example: 5.89
transaction.providerType: Object
Description: Contains details about the transaction provider.
transaction.provider.referenceType: String
Description: Reference provided by the payment provider (if applicable).
Example: "609844"
transaction.provider.responseType: String
Description: Response from the payment provider.
Example: "00 - Approved"
customerType: Object
Description: Contains customer-related details.
customer.nameType: String
Description: Name of the customer.
Example: "SimulateNotify TestCustomerName"
customer.countryType: String
Description: Country of the customer.
Example: "Australia"
customer.stateType: String
Description: State of the customer.
Example: "Western Australia"
customer.cityType: String
Description: City of the customer.
Example: "609844"
customer.addressType: String
Description: Address of the customer.
Example: "Test Address"
customer.postcodeType: String
Description: Postcode of the customer.
Example: "4000"
customer.phoneType: String
Description: Phone number of the customer.
Example: "12341234"
customer.emailType: String
Description: Email address of the customer.
Example: "test@test.com"
customer.accountType: Object
Description: Customer's bank account information.
customer.account.nameType: String
Description: Name associated with the customer's bank account.
Example: ""
customer.account.bsbType: String
Description: Bank-State-Branch (BSB) number for the customer's account.
Example: ""
customer.account.numberType: String
Description: Customer's bank account number.
Example: ""
chargebackType: Object
Description: Contains chargeback details.
chargeback.microfilmReferenceType: String
Description: Microfilm reference number for the chargeback.
Example: "microfilm66ab13cfe1599"
chargeback.reasonType: String
Description: Reason for the chargeback.
Example: "10.1 - EMV Liability Shift"

Chargeback JSON Notification#

{
    "transaction": {
      "id": "1500-66f3a192-4fc1-11ef-bf40-005056a5521a",
      "status": "approved",
      "amount": 144.89,
      "currency": "AUD",
      "product": "SimulateNotify TestProduct",
      "reference": "",
      "dates": {
        "created": "2024-08-01 14:49:14",
        "processed": "2024-08-01 14:49:15",
        "settled": "2024-08-02"
      },
      "fee": 5.89,
      "provider": {
        "reference": "609844",
        "response": "00 - Approved"
      }
    },
    "customer": {
      "name": "SimulateNotify TestCustomerName",
      "country": "Australia",
      "state": "Western Australia",
      "city": "609844",
      "address": "Test Address",
      "postcode": "4000",
      "phone": "12341234",
      "email": "test@test.com",
      "account": {
        "name": "",
        "bsb": "",
        "number": ""
      }
    },
    "chargeback": {
      "microfilmReference": "microfilm66ab13cfe1599",
      "reason": "10.1 - EMV Liability Shift"
    }
  }
Modified at 2026-07-17 05:49:31
Previous
checkMerchant
Next
processCard
Built with