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

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

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 Not Supported
XML Not Supported
{
    "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 Not Supported
XML Not Supported
{
    "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"
}
{ "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

Parameter Description
transaction

Type:
Description:
Example:

transaction.id

Type: String
Description: Unique identifier for the transaction.
Example: 1500-b0138d9d-48a8-11ef-983a-005056a5521a
transaction.status

Type: String
Description: Current status of the transaction (e.g., approved, declined).
Example: approved
transaction.amount

Type: Number
Description: Transaction amount.
Example: 89
transaction.currency

Type: String
Description: ISO currency code.
Example: AUD
transaction.product

Type: String
Description: Description of the product or service.
Example: Product Name
transaction.reference

Type: String
Description: Optional reference information.
Example: Reference Name
transaction.dates

Type: Object
Description: Timestamps for various transaction events.
transaction.dates.created

Type: String
Description: Date and time when the transaction was created.
Example: 2024-07-23 14:04:41
transaction.dates.processed

Type: String
Description: Date and time when the transaction was processed.
Example: 2024-07-23 14:04:41
transaction.dates.settled

Type: String
Description: Date when the transaction was settled.
Example: 2024-07-24
transaction.fee

Type: Number
Description: Fee applied to the transaction.
Example: 0.01
transaction.provider

Type: Object
Description: Provider-specific details.
transaction.provider.reference

Type: String
Description: Provider’s reference identifier.
Example:

transaction.provider.response

Type: String
Description: Response message or code from the provider.
Example:

customer

Type: Object
Description: Information about the customer involved in the transaction
customer.name

Type: String
Description: Full name of the customer.
Example: Tony Stark
customer.country

Type: String
Description: Customer’s country code (ISO format).
Example: AU
customer.state

Type: String
Description: Customer’s state or region.
Example: Queensland
customer.city

Type: String
Description: Customer’s city.
Example: Brisbane
customer.address

Type: String
Description: Customer’s physical address.
Example: 345 Ann St
customer.postcode

Type: String
Description: Postal code of the customer.
Example: 4000
customer.phone

Type: String
Description: Customer’s phone number.
Example: 0491 571 266
customer.email

Type: String
Description: Customer’s email address.
Example: [email protected]
customer.account

Type: Object
Description: Bank account details associated with the customer.
customer.account.name

Type: String
Description: Account holder’s name.
Example: Tony Stark
customer.account.bsb

Type: String
Description: Bank State Branch (BSB) code.
Example: 035-502
customer.account.number

Type: String
Description: Bank account number.
Example: 12341234
incoming

Type: Object
Description: Details about the incoming bank account information and payment identifier.
incoming.account

Type: Object
Description: Details of the incoming bank account.
incoming.account.name

Type: String
Description: Account holder’s name.
Example: Pepper Potts
incoming.account.bsb

Type: String
Description: Bank State Branch (BSB) code.
Example: 804991
incoming.account.number

Type: String
Description: Bank account number.
Example: 12
incoming.payId

Type: Mixed
Description: Payment identifier (can be null if not provided).
Example: [email protected]

Copy 
{
    "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
    }
  }
{ "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 } }
No sample available
No sample available
No sample available
No sample available
No sample available
No sample available
No sample available
No sample available
No sample available
No sample available
No sample available
No sample available
BPAY JSON Notification

JSON BPay Notification

Parameter Description
transaction

Type: Object
Description: Contains details about the transaction.
transaction.id

Type: String
Description: Unique identifier for the transaction.
Example: "1500-279f9e9d-48b4-11ef-983a-005056a5521a"
transaction.status

Type: String
Description: Current status of the transaction (e.g., approved, pending, failed).
Example: "approved"
transaction.amount

Type: Number
Description: Transaction amount.
Example: 121
transaction.currency

Type: String
Description: Currency code in which the transaction was processed (ISO 4217 format).
Example: "AUD"
transaction.product

Type: String
Description: Name of the product associated with the transaction.
Example: "Product Name"
transaction.reference

Type: String
Description: Reference identifier for the transaction.
Example: "Reference Name"
transaction.dates

Type: Object
Description: Contains timestamps related to the transaction.
transaction.dates.created

Type: String (ISO DateTime Format)
Description: Timestamp when the transaction was created.
Example: "2024-07-23 15:26:46"
transaction.dates.processed

Type: String (ISO DateTime Format)
Description: Timestamp when the transaction was processed.
Example: "2024-07-23 15:26:46"
transaction.dates.settled

Type: String (ISO Date Format)
Description: Date when the transaction was settled.
Example: "2024-07-23"
transaction.fee

Type: Number
Description: Transaction fee applied.
Example: 0.02
transaction.provider

Type: Object
Description: Contains details about the transaction provider.
transaction.provider.reference

Type: String
Description: Reference provided by the payment provider (if applicable).
Example: ""
transaction.provider.response

Type: String
Description: Response from the payment provider.
Example: ""
customer

Type: Object
Description: Contains customer-related account details.
customer.account

Type: Object
Description: Customer's bank account information.
customer.account.name

Type: String
Description: Name associated with the customer's bank account.
Example: ""
customer.account.bsb

Type: String
Description: Bank-State-Branch (BSB) number for the customer's account.
Example: ""
customer.account.number

Type: String
Description: Customer's bank account number.
Example: ""
bpay

Type: Object
Description: BPAY payment details.
bpay.billerCode

Type: String
Description: The BPAY biller code assigned to the merchant.
Example: "165931"
bpay.crn

Type: String
Description: Customer Reference Number (CRN) used for BPAY transactions.
Example: "12345678"

Copy 
{
    "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"
    }
  }
{ "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" } }
No sample available
No sample available
No sample available
No sample available
No sample available
No sample available
No sample available
No sample available
No sample available
No sample available
No sample available
No sample available
Direct Debit JSON Notification

Direct Debit JSON Notification

Parameter Description
transaction

Type: Object
Description: Contains details about the transaction.
transaction.id

Type: String
Description: Unique identifier for the transaction.
Example: "1500-9a0837a1-48b6-11ef-983a-005056a5521a"
transaction.status

Type: String
Description: Current status of the transaction (e.g., approved, pending, failed).
Example: "approved"
transaction.amount

Type: Number
Description: Transaction amount.
Example: 2
transaction.currency

Type: String
Description: Currency code in which the transaction was processed (ISO 4217 format).
Example: "AUD"
transaction.product

Type: String
Description: Name of the product associated with the transaction.
Example: "SimulateNotify TestProduct"
transaction.reference

Type: String
Description: Reference identifier for the transaction.
Example: ""
transaction.dates

Type: Object
Description: Contains timestamps related to the transaction.
transaction.dates.created

Type: String (ISO DateTime Format)
Description: Timestamp when the transaction was created.
Example: "2024-07-23 15:44:17"
transaction.dates.processed

Type: String (ISO DateTime Format)
Description: Timestamp when the transaction was processed.
Example: "2024-07-23 15:44:17"
transaction.dates.settled

Type: String (ISO Date Format)
Description: Date when the transaction was settled.
Example: "2024-07-23"
transaction.fee

Type: Number
Description: Transaction fee applied.
Example: 0
transaction.provider

Type: Object
Description: Contains details about the transaction provider.
transaction.provider.reference

Type: String
Description: Reference provided by the payment provider (if applicable).
Example: ""
transaction.provider.response

Type: String
Description: Response from the payment provider.
Example: "0 - Approved"
transaction.customFields

Type: Object
Description: Contains custom fields associated with the transaction.
transaction.customFields.custom1

Type: String
Description: Custom field 1.
Example: ""
transaction.customFields.custom2

Type: String
Description: Custom field 2.
Example: ""
transaction.customFields.custom3

Type: String
Description: Custom field 3.
Example: ""
transaction.storeId

Type: Number
Description: Identifier for the store associated with the transaction.
Example: 0
customer

Type: Object
Description: Contains customer-related details.
customer.name

Type: String
Description: Name of the customer.
Example: "SimulateNotify TestCustomerName"
customer.country

Type: String
Description: Country of the customer.
Example: "Australia"
customer.state

Type: String
Description: State of the customer.
Example: "Queensland"
customer.city

Type: String
Description: City of the customer.
Example: ""
customer.address

Type: String
Description: Address of the customer.
Example: "Test Address"
customer.postcode

Type: String
Description: Postcode of the customer.
Example: "4000"
customer.phone

Type: String
Description: Phone number of the customer.
Example: "12341234"
customer.email

Type: String
Description: Email address of the customer.
Example: "[email protected]"
customer.account

Type: Object
Description: Customer's bank account information.
customer.account.name

Type: String
Description: Name associated with the customer's bank account.
Example: "test test"
customer.account.bsb

Type: String
Description: Bank-State-Branch (BSB) number for the customer's account.
Example: "111-111"
customer.account.number

Type: String
Description: Customer's bank account number.
Example: "12341234"

Copy 
{
    "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": "[email protected]",
      "account": {
        "name": "test test",
        "bsb": "111-111",
        "number": "12341234"
      }
    }
  }
{ "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": "[email protected]", "account": { "name": "test test", "bsb": "111-111", "number": "12341234" } } }
No sample available
No sample available
No sample available
No sample available
No sample available
No sample available
No sample available
No sample available
No sample available
No sample available
No sample available
No sample available
Chargeback JSON Notification

Chargeback JSON Notification

Parameter Description
transaction

Type: Object
Description: Contains details about the transaction.
transaction.id

Type: String
Description: Unique identifier for the transaction.
Example: "1500-66f3a192-4fc1-11ef-bf40-005056a5521a"
transaction.status

Type: String
Description: Current status of the transaction (e.g., approved, pending, failed).
Example: "approved"
transaction.amount

Type: Number
Description: Transaction amount.
Example: 144.89
transaction.currency

Type: String
Description: Currency code in which the transaction was processed (ISO 4217 format).
Example: "AUD"
transaction.product

Type: String
Description: Name of the product associated with the transaction.
Example: "SimulateNotify TestProduct"
transaction.reference

Type: String
Description: Reference identifier for the transaction.
Example: ""
transaction.dates

Type: Object
Description: Contains timestamps related to the transaction.
transaction.dates.created

Type: String (ISO DateTime Format)
Description: Timestamp when the transaction was created.
Example: "2024-08-01 14:49:14"
transaction.dates.processed

Type: String (ISO DateTime Format)
Description: Timestamp when the transaction was processed.
Example: "2024-08-01 14:49:15"
transaction.dates.settled

Type: String (ISO Date Format)
Description: Date when the transaction was settled.
Example: "2024-08-02"
transaction.fee

Type: Number
Description: Transaction fee applied.
Example: 5.89
transaction.provider

Type: Object
Description: Contains details about the transaction provider.
transaction.provider.reference

Type: String
Description: Reference provided by the payment provider (if applicable).
Example: "609844"
transaction.provider.response

Type: String
Description: Response from the payment provider.
Example: "00 - Approved"
customer

Type: Object
Description: Contains customer-related details.
customer.name

Type: String
Description: Name of the customer.
Example: "SimulateNotify TestCustomerName"
customer.country

Type: String
Description: Country of the customer.
Example: "Australia"
customer.state

Type: String
Description: State of the customer.
Example: "Western Australia"
customer.city

Type: String
Description: City of the customer.
Example: "609844"
customer.address

Type: String
Description: Address of the customer.
Example: "Test Address"
customer.postcode

Type: String
Description: Postcode of the customer.
Example: "4000"
customer.phone

Type: String
Description: Phone number of the customer.
Example: "12341234"
customer.email

Type: String
Description: Email address of the customer.
Example: "[email protected]"
customer.account

Type: Object
Description: Customer's bank account information.
customer.account.name

Type: String
Description: Name associated with the customer's bank account.
Example: ""
customer.account.bsb

Type: String
Description: Bank-State-Branch (BSB) number for the customer's account.
Example: ""
customer.account.number

Type: String
Description: Customer's bank account number.
Example: ""
chargeback

Type: Object
Description: Contains chargeback details.
chargeback.microfilmReference

Type: String
Description: Microfilm reference number for the chargeback.
Example: "microfilm66ab13cfe1599"
chargeback.reason

Type: String
Description: Reason for the chargeback.
Example: "10.1 - EMV Liability Shift"

Copy 
{
    "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": "[email protected]",
      "account": {
        "name": "",
        "bsb": "",
        "number": ""
      }
    },
    "chargeback": {
      "microfilmReference": "microfilm66ab13cfe1599",
      "reason": "10.1 - EMV Liability Shift"
    }
  }
{ "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": "[email protected]", "account": { "name": "", "bsb": "", "number": "" } }, "chargeback": { "microfilmReference": "microfilm66ab13cfe1599", "reason": "10.1 - EMV Liability Shift" } }
No sample available
No sample available
No sample available
No sample available
No sample available
No sample available
No sample available
No sample available
No sample available
No sample available
No sample available
No sample available