PayTo
Introduction

PayTo is an Australian modern digital payment solution offering a fast, easy and secure way to pay. It gives consumers more visibility and control over their payments, and enables merchants and businesses to initiate real-time payments from their customers’ bank accounts.


The illustrations and accompanying explanations provided here offer an overview of the PayTo procedure, which encompasses everything from establishing an agreement to the processing of a payment.

Establishing an Agreement

PayTo Agreement.svg

Authorization Request

  • You initiate an authorization request (Create Agreement) to debit your customer's bank account.
  • This request includes details such as the payment amount, frequency, and other terms.
  • The authorization request is sent to your customer's bank.

Payer Review and Approval

  • Your customer receives the authorization request via their internet banking app.
  • They review the terms and decide whether to approve or decline.
  • If approved, your customer provides consent for future debits.

Agreement Confirmation

  • A notification (Agreement Notification) is dispatched to you in near real-time when the customer actions the agreement.
  • Upon approval, an agreement is established between the customer and your business.
  • The agreement specifies the terms for future payments (or a one-off payment).

Requesting a Payment

PayTo Payment.svg

Payment Creation

  • With an active agreement, you can request a payment from your customer's bank account.
  • Payments are generated within the agreed-upon terms (e.g., specific dates, amounts).
  • You submit a request for payment (Create Payment) to the customer's bank.

Near real-time response

  • When the customer’s bank receives your payment request, it commences the process of transferring funds to your business.
  • You receive a synchronous response indicating the status of your payment request (Create Payment).
  • An asynchronous response (Payment Resolution Notification) is delivered to you when the bank has successfully transferred the funds to your business.
Simulator

PayTo responses in the Sandbox environment are fully simulated, so you can control exactly what response you would like to see for every scenario. All requests in the Sandbox environment will respond with a "success" response, unless the following values are used in the request. This allows you to test both success and failure scenarios in your implementation.

Create Agreement

Use the following values when creating your agreements to receive a failure response.

Agreement Type Value
Account 802950 7654321
Phone 61422222222
Email [email protected]
ABN 22222222222

Use the following values when creating your agreements to receive a pending response.

Agreement Type Value
Email [email protected]


Amend Agreement

Use any of the above values in the "arrangement" property in the Amend Agreement request to generate a failure response.

Create Payment

Use the following emails in your request to simulate the specified responses.

Scenario Value Notes
Failure [email protected]
Timeout [email protected] No notification will be sent for this scenario
Timeout [email protected] A notification will be sent for this scenario


Payer Suspended Account

This simulates a payer suspending an agreement. The agreement is set to suspended and a agreement notify (PTA) is sent.

Agreement Type Email
Email [email protected]
Account 802950 787736333


Payer Declined Account

This simulates a payer declining an agreement. The agreement is set to cancelled and a agreement notify (PTA) is sent

Agreement Type Email
Email [email protected]
Account 802950 33254633
Certification

Prior to going live with PayTo, all merchants are required to undergo a certification process. This process involves the submission of transaction IDs for test cases, which outline the necessary steps and expected outcomes. Approval from Merchant Warrior is essential before proceeding to the live phase.

Agreements

At the heart of every PayTo transaction is an agreement. This is a digital version of a Direct Debit Authority that is generated and sent directly to the payer's internet banking app. When the agreement is sent, they will receive a notification to review the agreement, allowing them to approve or decline it.

The agreement will list the frequency, amount, merchant's details and description for the agreement.

Once the agreement is approved, it can then be used to process transactions.

Actions and Statuses

Agreements will always have a status, but actions can also be performed on agreements with the Amend Agreement Status endpoint. The table below details what actions are available, and what status the agreement will transition to once the action is complete.

Action Status Description
CRTD Created. This is the default status of all newly created agreements.
SUSP SUSD Suspend action. Used to suspend, but not cancel an agreement. This will result in a suspended status.
RELS ACTV Release action. Used when an agreement is suspended to unsuspend it. This will result in an a active status.
CNCL CNCD Cancel action. Used to completely cancel an agreement. This will result in a cancelled status and cannot be undone.
Create Agreement

HTTP Verb: POST
Endpoint: /npp/payto/agreement

Headers

Parameter Description
MW-MERCHANTID

The value of this parameter is provided to you by Merchant Warrior. Also known as your Merchant UUID.
Example: 4aa82af83c95d
MW-APIKEY

The value of this parameter is provided to you by Merchant Warrior.
Example: mz3dz5fp
MW-MESSAGEHASH

The verification hash is a combination of the HMAC SHA256 of your API Passphrase, and the entire JSON body. See MW-MESSAGEHASH (JSON) for information on how to construct the hash correctly.
Example: 59e5f6f02777398bfd5652d041f1e0d3e44e30587308c55c7053f5e7d4b3a48d
MW-API-VERSION

Must be set to 2.0 for this product.
Example: 2.0

JSON Body

Parameter Description
payer

Type: Object
Required: Yes

An object describing the payer.
payer.identificationType

Type: String
Required: Yes

Can be one of the following -

  • account
  • email
  • phone
  • abn
payer.account

Type: Object
Required: Yes, if identificationType is account.

An object describing the account.
payer.account.bsb

Type: String
Format: 6 digits
Required: Yes

The account's BSB.
payer.account.accountNumber

Type: String
Required: Yes

The account number.
payer.name

Type: String
Format: Maximum length 140 characters
Required: Yes

Name of the payer. For an individual, use the individual's name. For a business, use the business name here.
payer.principalName

Type: String
Required: No

The principal name of the entity. For an individual, use the individual's name. If a company, use the company's full name (eg. ABC Pty Ltd), or if belonging to a trust, use the trust name here.
payer.type

Type: Enum (String)
Required: Yes

One of the following -

  • PERS - person
  • ORGN - organisation
payer.reference

Type: String
Format: 35 characters maximum
Required: No

A unique identifier for the payer.
agreement

Type: Object
Required: Yes

An object describing the agreement.
agreement.description

Type: String
Format: Maximum 140 characters
Required: No

Long description about the agreement.
agreement.summary

Type: String
Format: Maximum 35 characters
Required: Yes

Short description about the agreement.
agreement.purpose

Type: Enum (String)
Required: Yes

One of the following -

  • MORT - Mortgage Payments
  • UTIL - Utility Payments
  • LOAN - Loan Payments
  • DEPD - Dependant Support Payments
  • GAMP - Gambling Payments
  • RETL - Retail Payments
  • SALA - Salary Payments
  • PERS - Personal Payment
  • GOVT - Government Payments
  • PENS - Pension Payments
  • TAXS - Tax Payments
  • OTHR - Other Service Payments
agreement.arrangement

Type: String
Format: Maximum 140 characters
Required: Yes

A text based description of how much will be debited, and when.
agreement.reference

Type: String
Format: Maximum 35 characters
Required: Yes

A reference for the agreement.
agreement.actionByDate

Type: String
Format: YYYY-MM-DD
Required: Yes

Date that the agreement must be actioned by (approved or declined). If no action is taken by the specified date, the agreement will be declined.
agreement.startDate

Type: String
Format: YYYY-MM-DD
Required: Yes

Date that the first debit will occur.
agreement.endDate

Type: String
Format: YYYY-MM-DD
Required: No

Date that the last debit will occur.
agreement.payment

Type: Object
Required: Yes

Object describing the payment.
agreement.payment.amount

Type: Number
Required: Yes

The amount to be debited, expressed as a decimal.
agreement.payment.maximum

Type: Number
Required: No

The maximum amount to be debited, expressed as a decimal.
agreement.payment.firstPaymentDate

Type: String
Format: YYYY-MM-DD
Required: No

Date that the first debit will occur.
agreement.payment.lastPaymentDate

Type: String
Format: YYYY-MM-DD
Required: No

Date that the last debit will occur.
agreement.payment.firstPaymentAmount

Type: Number
Required: No

The first amount to be debited, expressed as a decimal.
agreement.payment.lastPaymentAmount

Type: Number
Required: No

The last amount to be debited, expressed as a decimal.
agreement.payment.type

Type: Enum (String)
Required: Yes

One of the following -

  • BALN - Balloon - Payment amount is fixed with large final payment amount.
    • If used, only amount should have a value. Max amount should not be present.
  • FIXE - Fixed - Payment amount is fixed.
    • If used, only amount should have a value. Max amount should not be present.
  • USGB - Usage Based - Payment amount is based on usage.
    • If used, max amount is mandatory. Amount value is optional, and if present, should be less than max amount.
  • VARI - Variable - Payment amount is variable.
    • If used, max amount is mandatory. Amount value is optional, and if present, should be less than max amount.
agreement.payment.frequency

Type: Enum (String)
Required: Yes

One of the following -

  • ADHO - Adhoc - Event takes place on request or as necessary.
  • DAIL - Daily - Event takes place every day.
    • If included, pointInTime must be 1-24
    • If included, countPerPeriod must be > 0
  • FRTN - Fortnightly - Event takes place every two weeks.
    • If included, pointInTime must be 1-14
    • If included, countPerPeriod must be > 0
  • INDA - IntraDay - Event takes place several times a day.
    • If included, pointInTime must be 1-24
    • If included, countPerPeriod must be > 0
  • MIAN - SemiAnnual - Event takes place every six months or two times a year.
    • If included, pointInTime must be 1-6
    • If included, countPerPeriod must be > 0
  • MNTH - Monthly - Event takes place every month or once a month.
    • If included, pointInTime must be 1-31
    • If included, countPerPeriod must be > 0
  • QURT - Quarterly - Event takes place every three months or four times a year.
    • If included, pointInTime must be 1-3
    • If included, countPerPeriod must be > 0
  • WEEK - Weekly - Event takes place once a week.
    • If included, pointInTime must be 1-7
    • If included, countPerPeriod must be > 0
  • YEAR - Annual - Event takes place every year or once a year.
    • If included, pointInTime must be 1-12
    • If included, countPerPeriod must be > 0

NOTE: Either countPerPeriod or pointInTime must be used for each frequency (except Adhoc), but never include both. Neither are required for Adhoc.
agreement.payment.pointInTime

Type: Number
Required: No

Dependent on the frequency field. For example, if frequency is MNTH (monthly), then 8 would mean on the 8th of every month. See specific examples below -

  • FRTN - Fortnightly - Valid values include 1 (Monday of the first week) to 14 (Sunday of the second week)
  • INDA - IntraDay - Valid values include 1 (0:00) to 24 (23:00)
  • MIAN - SemiAnnual - Valid values include 1 (January/July) to 6 (June/December)
  • MNTH - Monthly - Valid values include 1 (1st of the month) to 31 (31st of the month)
  • QURT - Quarterly - Valid values include 1 (January/April/July/October), 2 (February/May/August/November), 3 (March/June/September/December)
  • WEEK - Weekly - Valid values include 1 (Monday) to 7 (Sunday)
  • YEAR - Annual - Valid values include 1 (January) to 12 (December)

Copy 
{
    "payer": {
        "identificationType": "account",
        "account": {
            "bsb": "802950",
            "accountNumber": "1234569"
        },
        "name": "Bruce Wayne",
        "principalName": "Wayne Industries",
        "type": "PERS",
        "reference": "PHUID9876578"
    },
    "agreement": {
        "description": "Weekly Gym Membership to Powerhouse Gym Southside",
        "summary": "Weekly Gym Membership",
        "purpose": "OTHR",
        "arrangement": "Powerhouse Gym will deduct $10.00 every Monday until cancelled, with a one-time signup fee of $99.00 and a cancellation fee of $299.00",
        "reference": "PHAID123456789",
        "actionByDate": "2023-11-11",
        "startDate": "2023-11-07",
        "endDate": "2024-11-07",
        "payment": {
            "amount": 10,
            "maximum": 100,
            "firstPaymentDate": "2023-11-07",
            "lastPaymentDate": "2023-12-07",
            "firstPaymentAmount": 99,
            "type": "VARI",
            "frequency": "WEEK",
            "pointInTime": 1
        }
    }
}
{ "payer": { "identificationType": "account", "account": { "bsb": "802950", "accountNumber": "1234569" }, "name": "Bruce Wayne", "principalName": "Wayne Industries", "type": "PERS", "reference": "PHUID9876578" }, "agreement": { "description": "Weekly Gym Membership to Powerhouse Gym Southside", "summary": "Weekly Gym Membership", "purpose": "OTHR", "arrangement": "Powerhouse Gym will deduct $10.00 every Monday until cancelled, with a one-time signup fee of $99.00 and a cancellation fee of $299.00", "reference": "PHAID123456789", "actionByDate": "2023-11-11", "startDate": "2023-11-07", "endDate": "2024-11-07", "payment": { "amount": 10, "maximum": 100, "firstPaymentDate": "2023-11-07", "lastPaymentDate": "2023-12-07", "firstPaymentAmount": 99, "type": "VARI", "frequency": "WEEK", "pointInTime": 1 } } }
{
    "payer": {
      "identificationType": "email",
      "email": "[email protected]",
      "name": "Bruce Wayne",
      "principalName": "Wayne Industries",
      "type": "PERS",
      "reference": "PHUID9876578"
    },
    "agreement": {
        "description": "Weekly Gym Membership to Powerhouse Gym Southside",
        "summary": "Weekly Gym Membership",
        "purpose": "OTHR",
        "arrangement": "Powerhouse Gym will deduct $10.00 every Monday until cancelled, with a one-time signup fee of $99.00 and a cancellation fee of $299.00",
        "reference": "PHAID123456789",
        "actionByDate": "2023-11-11",
        "startDate": "2023-11-07",
        "endDate": "2024-11-07",
        "payment": {
            "amount": 10,
            "maximum": 100,
            "firstPaymentDate": "2023-11-07",
            "lastPaymentDate": "2023-12-07",
            "firstPaymentAmount": 99,
            "type": "VARI",
            "frequency": "WEEK",
            "pointInTime": 1
        }
    }
}
{ "payer": { "identificationType": "email", "email": "[email protected]", "name": "Bruce Wayne", "principalName": "Wayne Industries", "type": "PERS", "reference": "PHUID9876578" }, "agreement": { "description": "Weekly Gym Membership to Powerhouse Gym Southside", "summary": "Weekly Gym Membership", "purpose": "OTHR", "arrangement": "Powerhouse Gym will deduct $10.00 every Monday until cancelled, with a one-time signup fee of $99.00 and a cancellation fee of $299.00", "reference": "PHAID123456789", "actionByDate": "2023-11-11", "startDate": "2023-11-07", "endDate": "2024-11-07", "payment": { "amount": 10, "maximum": 100, "firstPaymentDate": "2023-11-07", "lastPaymentDate": "2023-12-07", "firstPaymentAmount": 99, "type": "VARI", "frequency": "WEEK", "pointInTime": 1 } } }
{
    "payer": {
      "identificationType": "phone",
      "phone": "+61-422222666",
      "name": "Bruce Wayne",
      "principalName": "Wayne Industries",
      "type": "PERS",
      "reference": "PHUID9876578"
    },
    "agreement": {
        "description": "Weekly Gym Membership to Powerhouse Gym Southside",
        "summary": "Weekly Gym Membership",
        "purpose": "OTHR",
        "arrangement": "Powerhouse Gym will deduct $10.00 every Monday until cancelled, with a one-time signup fee of $99.00 and a cancellation fee of $299.00",
        "reference": "PHAID123456789",
        "actionByDate": "2023-11-11",
        "startDate": "2023-11-07",
        "endDate": "2024-11-07",
        "payment": {
            "amount": 10,
            "maximum": 100,
            "firstPaymentDate": "2023-11-07",
            "lastPaymentDate": "2023-12-07",
            "firstPaymentAmount": 99,
            "type": "VARI",
            "frequency": "WEEK",
            "pointInTime": 1
        }
    }
}
{ "payer": { "identificationType": "phone", "phone": "+61-422222666", "name": "Bruce Wayne", "principalName": "Wayne Industries", "type": "PERS", "reference": "PHUID9876578" }, "agreement": { "description": "Weekly Gym Membership to Powerhouse Gym Southside", "summary": "Weekly Gym Membership", "purpose": "OTHR", "arrangement": "Powerhouse Gym will deduct $10.00 every Monday until cancelled, with a one-time signup fee of $99.00 and a cancellation fee of $299.00", "reference": "PHAID123456789", "actionByDate": "2023-11-11", "startDate": "2023-11-07", "endDate": "2024-11-07", "payment": { "amount": 10, "maximum": 100, "firstPaymentDate": "2023-11-07", "lastPaymentDate": "2023-12-07", "firstPaymentAmount": 99, "type": "VARI", "frequency": "WEEK", "pointInTime": 1 } } }
{
    "payer": {
      "identificationType": "abn",
      "abn": "12345678932",
      "name": "Bruce Wayne",
      "principalName": "Wayne Industries",
      "type": "PERS",
      "reference": "PHUID9876578"
    },
    "agreement": {
        "description": "Weekly Gym Membership to Powerhouse Gym Southside",
        "summary": "Weekly Gym Membership",
        "purpose": "OTHR",
        "arrangement": "Powerhouse Gym will deduct $10.00 every Monday until cancelled, with a one-time signup fee of $99.00 and a cancellation fee of $299.00",
        "reference": "PHAID123456789",
        "actionByDate": "2023-11-11",
        "startDate": "2023-11-07",
        "endDate": "2024-11-07",
        "payment": {
            "amount": 10,
            "maximum": 100,
            "firstPaymentDate": "2023-11-07",
            "lastPaymentDate": "2023-12-07",
            "firstPaymentAmount": 99,
            "type": "VARI",
            "frequency": "WEEK",
            "pointInTime": 1
        }
    }
}
{ "payer": { "identificationType": "abn", "abn": "12345678932", "name": "Bruce Wayne", "principalName": "Wayne Industries", "type": "PERS", "reference": "PHUID9876578" }, "agreement": { "description": "Weekly Gym Membership to Powerhouse Gym Southside", "summary": "Weekly Gym Membership", "purpose": "OTHR", "arrangement": "Powerhouse Gym will deduct $10.00 every Monday until cancelled, with a one-time signup fee of $99.00 and a cancellation fee of $299.00", "reference": "PHAID123456789", "actionByDate": "2023-11-11", "startDate": "2023-11-07", "endDate": "2024-11-07", "payment": { "amount": 10, "maximum": 100, "firstPaymentDate": "2023-11-07", "lastPaymentDate": "2023-12-07", "firstPaymentAmount": 99, "type": "VARI", "frequency": "WEEK", "pointInTime": 1 } } }
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
Copy 
XML Not Supported
XML Not Supported
{
    "responseCode": 0,
    "responseMessage": "Operation successful",
    "result": {
        "agreementIdentification": "6ecae9efaeee1ba39a5dcc9ecbf36e09"
    }
}
{ "responseCode": 0, "responseMessage": "Operation successful", "result": { "agreementIdentification": "6ecae9efaeee1ba39a5dcc9ecbf36e09" } }
<?xml version="1.0"?>
<mwResponse>
  <responseCode>0</responseCode>
  <responseMessage>Operation successful</responseMessage>
  <result>
    <agreementIdentification>6ecae9efaeee1ba39a5dcc9ecbf36e09</agreementIdentification>
    <payer>
      <account>
        <name>Tony Stark</name>
      </account>
    </payer>
  </result>
</mwResponse>
0 Operation successful 6ecae9efaeee1ba39a5dcc9ecbf36e09 Tony Stark 
{
    "responseCode": 0,
    "responseMessage": "Operation successful",
    "result": {
        "agreementIdentification": "6ecae9efaeee1ba39a5dcc9ecbf36e09",
        "payer": {
            "account": {
                "name": "Tony Stark"
            }
        }
    }
}
{ "responseCode": 0, "responseMessage": "Operation successful", "result": { "agreementIdentification": "6ecae9efaeee1ba39a5dcc9ecbf36e09", "payer": { "account": { "name": "Tony Stark" } } } }
XML Not Supported
XML Not Supported
{
    "responseCode": -2,
    "responseMessage": "MW - 035:Validation failed: type, name"
}
{ "responseCode": -2, "responseMessage": "MW - 035:Validation failed: type, name" }
Get Agreement

HTTP Verb: GET
Endpoint: /npp/payto/agreement/{{agreementIdentification}}

Headers

Parameter Description
MW-MERCHANTID

The value of this parameter is provided to you by Merchant Warrior. Also known as your Merchant UUID.
Example: 4aa82af83c95d
MW-APIKEY

The value of this parameter is provided to you by Merchant Warrior.
Example: mz3dz5fp
MW-MESSAGEHASH

The verification hash is a combination of the HMAC SHA256 of your API Passphrase, and URL path. See MW-MESSAGEHASH (GET) for information on how to construct the hash correctly.
Example: 59e5f6f02777398bfd5652d041f1e0d3e44e30587308c55c7053f5e7d4b3a48d
MW-API-VERSION

Must be set to 2.0 for this product.
Example: 2.0

Path Parameters

Parameter Description
agreementIdentification

The agreementIdentification returned by the Create Agreement endpoint
Example: 6ecae9efaeee1ba39a5dcc9ecbf36e09

Copy 
XML Not Supported
XML Not Supported
{
    "responseCode": 0,
    "responseMessage": "Operation successful",
    "result": {
        "payer": {
            "identificationType": "account",
            "account": {
                "bsb": "802950",
                "accountNumber": "1234569"
            },
            "name": "Bruce Wayne",
            "ultimateName": "Wayne Industries",
            "reference": "PHUID9876578"
        },
        "agreement": {
            "payment": {
                "maximum": 100,
                "pointInTime": "01",
                "firstPaymentDate": "2023-08-09",
                "lastPaymentAmount": "",
                "firstPaymentAmount": 99,
                "countPerPeriod": "",
                "amount": 10,
                "type": "VARI",
                "frequency": "WEEK",
                "lastPaymentDate": "2023-09-08"
            },
            "summary": "Weekly Gym Membership",
            "endDate": "2024-08-08",
            "arrangement": "Powerhouse Gym will deduct $10.00 every Monday until cancelled, with a one-time signup fee of $99.00 and a cancellation fee of $299.00",
            "reference": "PHAID123456789",
            "startDate": "2023-08-09",
            "status": "ACTV",
            "version": 5,
            "description": "Weekly Gym Membership to Powerhouse Gym Southside.",
            "purpose": "OTHR"
        }
    }
}
{ "responseCode": 0, "responseMessage": "Operation successful", "result": { "payer": { "identificationType": "account", "account": { "bsb": "802950", "accountNumber": "1234569" }, "name": "Bruce Wayne", "ultimateName": "Wayne Industries", "reference": "PHUID9876578" }, "agreement": { "payment": { "maximum": 100, "pointInTime": "01", "firstPaymentDate": "2023-08-09", "lastPaymentAmount": "", "firstPaymentAmount": 99, "countPerPeriod": "", "amount": 10, "type": "VARI", "frequency": "WEEK", "lastPaymentDate": "2023-09-08" }, "summary": "Weekly Gym Membership", "endDate": "2024-08-08", "arrangement": "Powerhouse Gym will deduct $10.00 every Monday until cancelled, with a one-time signup fee of $99.00 and a cancellation fee of $299.00", "reference": "PHAID123456789", "startDate": "2023-08-09", "status": "ACTV", "version": 5, "description": "Weekly Gym Membership to Powerhouse Gym Southside.", "purpose": "OTHR" } } }
Amend Agreement

HTTP Verb: PATCH
Endpoint: /npp/payto/agreement/{{agreementIdentification}}

Headers

Parameter Description
MW-MERCHANTID

The value of this parameter is provided to you by Merchant Warrior. Also known as your Merchant UUID.
Example: 4aa82af83c95d
MW-APIKEY

The value of this parameter is provided to you by Merchant Warrior.
Example: mz3dz5fp
MW-MESSAGEHASH

The verification hash is a combination of the HMAC SHA256 of your API Passphrase, and the entire JSON body. See MW-MESSAGEHASH (JSON) for information on how to construct the hash correctly.
Example: 59e5f6f02777398bfd5652d041f1e0d3e44e30587308c55c7053f5e7d4b3a48d
MW-API-VERSION

Must be set to 2.0 for this product.
Example: 2.0

Path Parameters

Parameter Description
agreementIdentification

The agreementIdentification returned by the Create Agreement endpoint
Example: 6ecae9efaeee1ba39a5dcc9ecbf36e09

JSON Body

Parameter Description
agreement

Type: Object
Required: Yes

An object describing the agreement.
agreement.arrangement

Type: String
Format: Maximum 140 characters
Required: Yes

A text based description of how much will be debited, and when.
agreement.approvalDate

Type: String
Format: YYYY-MM-DD
Required: Yes

Date the agreement was approved.
agreement.payment

Type: Object
Required: Yes

Object describing the payment.
agreement.payment.amount

Type: Number
Required: Yes

The amount to be debited, expressed as a decimal.
agreement.payment.maximum

Type: Number
Required: No

The maximum amount to be debited, expressed as a decimal.
agreement.payment.firstPaymentAmount

Type: Number
Required: No

The first amount to be debited, expressed as a decimal.
agreement.payment.lastPaymentAmount

Type: Number
Required: No

The last amount to be debited, expressed as a decimal.
agreement.payment.firstPaymentDate

Type: String
Format: YYYY-MM-DD
Required: No

Date that the first debit will occur.
agreement.payment.lastPaymentDate

Type: String
Format: YYYY-MM-DD
Required: No

Date that the last debit will occur.
agreement.payment.type

Type: Enum (String)
Required: Yes

One of the following -

  • BALN - Balloon - Payment amount is fixed with large final payment amount.
  • FIXE - Fixed - Payment amount is fixed.
  • USGB - Usage Based - Payment amount is based on usage.
  • VARI - Variable - Payment amount is variable.
agreement.payment.frequency

Type: Enum (String)
Required: Yes

One of the following -

  • ADHO - Adhoc - Event takes place on request or as necessary.
  • DAIL - Daily - Event takes place every day.
  • FRTN - Fortnightly - Event takes place every two weeks.
  • INDA - IntraDay - Event takes place several times a day.
  • MIAN - SemiAnnual - Event takes place every six months or two times a year.
  • MNTH - Monthly - Event takes place every month or once a month.
  • QURT - Quarterly - Event takes place every three months or four times a year.
  • WEEK - Weekly - Event takes place once a week.
  • YEAR - Annual - Event takes place every year or once a year.
agreement.payment.pointInTime

Type: Number
Required: No

Dependent on the frequency field. For example, if frequency is MNTH (monthly), then 8 would mean on the 8th of every month. See specific examples below -

  • FRTN - Fortnightly - Valid values include 1 (Monday of the first week) to 14 (Sunday of the second week)
  • INDA - IntraDay - Valid values include 1 (0:00) to 24 (23:00)
  • MIAN - SemiAnnual - Valid values include 1 (January/July) to 6 (June/December)
  • MNTH - Monthly - Valid values include 1 (1st of the month) to 31 (31st of the month)
  • QURT - Quarterly - Valid values include 1 (January/April/July/October), 2 (February/May/August/November), 3 (March/June/September/December)
  • WEEK - Weekly - Valid values include 1 (Monday) to 7 (Sunday)
  • YEAR - Annual - Valid values include 1 (January) to 12 (December)

Copy 
{
  "agreement": {
    "arrangement": "Powerhouse Gym will deduct $20.00 every Wednesday until cancelled, with a one-time signup fee of $99.00 and a cancellation fee of $299.00",
    "approvalDate": "2023-11-11",
    "payment": {
      "amount": 20,
      "maximum": 150,
      "firstPaymentAmount": 25,
      "lastPaymentAmount": 149,
      "lastPaymentDate": "2024-01-05",
      "firstPaymentDate": "2023-11-07",
      "type": "VARI",
      "frequency": "WEEK",
      "pointInTime": "03"
    }
  }
}
{ "agreement": { "arrangement": "Powerhouse Gym will deduct $20.00 every Wednesday until cancelled, with a one-time signup fee of $99.00 and a cancellation fee of $299.00", "approvalDate": "2023-11-11", "payment": { "amount": 20, "maximum": 150, "firstPaymentAmount": 25, "lastPaymentAmount": 149, "lastPaymentDate": "2024-01-05", "firstPaymentDate": "2023-11-07", "type": "VARI", "frequency": "WEEK", "pointInTime": "03" } } }
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
Copy 
XML Not Supported
XML Not Supported
{
    "responseCode": 0,
    "responseMessage": "Operation successful"
}
{ "responseCode": 0, "responseMessage": "Operation successful" }
XML Not Supported
XML Not Supported
{
    "responseCode": -4,
    "responseMessage": "Can not amend mandate due to a pending bilateral amend."
}
{ "responseCode": -4, "responseMessage": "Can not amend mandate due to a pending bilateral amend." }
Amend Agreement Status

HTTP Verb: PATCH
Endpoint: /npp/payto/agreement/{{agreementIdentification}}/status

Headers

Parameter Description
MW-MERCHANTID

The value of this parameter is provided to you by Merchant Warrior. Also known as your Merchant UUID.
Example: 4aa82af83c95d
MW-APIKEY

The value of this parameter is provided to you by Merchant Warrior.
Example: mz3dz5fp
MW-MESSAGEHASH

The verification hash is a combination of the HMAC SHA256 of your API Passphrase, and the entire JSON body. See MW-MESSAGEHASH (JSON) for information on how to construct the hash correctly.
Example: 59e5f6f02777398bfd5652d041f1e0d3e44e30587308c55c7053f5e7d4b3a48d
MW-API-VERSION

Must be set to 2.0 for this product.
Example: 2.0

JSON Body

Parameter Description
status

Type: Enum (String)
Required: Yes

One of the following -

  • CNCL - Cancel - Cancel a mandate.
  • RELS - Release - Unsuspend a suspended mandate.
  • SUSP - Suspend - Suspend an active mandate.
reason

Type: Object
Required: Yes

Object describing the reason.
reason.code

Type: Enum (String)
Required: Yes

One of the following -

  • AC02 - Invalid Debtor Account Number
  • AC04 - Closed Account Number
  • AC05 - Closed Debtor Account Number
  • AC06 - Blocked Account
  • AC13 - Invalid Debtor Account Type
  • AG01 - Transaction Forbidden
  • AG03 - Transaction Not Supported
  • AM03 - Not Allowed Currency
  • AM12 - Invalid Amount
  • AM14 - Amount Exceeds Agreed Limit
  • CTAM - Contract Amended
  • CTCA - Contract Cancellation Initiated By Debtor
  • CTEX - Contract Expired
  • MCFC - Mandate Suspended Final Collection
  • MCOC - Mandate Suspended Once Off Collection
  • MD07 - End Customer Deceased
  • MD08 - No Mandate Service By Agent
  • MD09 - No Mandate Service On Customer
  • MD16 - Requested By Customer
  • MD17 - Requested By Initiating Party
  • MD20 - Mandate Expired
  • MD21 - Mandate Cancelled Due To Fraud
  • MS02 - Not Specified Reason Customer Generated
  • MS03 - Not Specified Reason Agent Generated
  • MSUC - Mandate Suspended 7 Consecutive Unsuccessful Collections
  • NARR - Narrative
  • NOAS - No Answer From Customer
  • RR04 - Regulatory Reason
  • SL01 - Specific Service offered by Debtor Agent
  • SL11 - Creditor not on Whitelist of Debtor
  • SL12 - Creditor on Blacklist of Debtor
reason.description

Type: String
Format: Maximum 256 characters
Required: Yes

A description about why the status is changing.

Path Parameters

Parameter Description
agreementIdentification

The agreementIdentification returned by the Create Agreement endpoint
Example: 6ecae9efaeee1ba39a5dcc9ecbf36e09

Copy 
{
    "status": "RELS",
    "reason": {
        "code": "MD16",
        "description": "Customer requested gym membership be put on hold while overseas."
    }
}
{ "status": "RELS", "reason": { "code": "MD16", "description": "Customer requested gym membership be put on hold while overseas." } }
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
Copy 
XML Not Supported
XML Not Supported
{
    "responseCode": 0,
    "responseMessage": "Operation successful"
}
{ "responseCode": 0, "responseMessage": "Operation successful" }
XML Not Supported
XML Not Supported
{
    "responseCode": -4,
    "responseMessage": "Mandate status invalid for the operation"
}
{ "responseCode": -4, "responseMessage": "Mandate status invalid for the operation" }
Recall Agreement Action

HTTP Verb: PATCH
Endpoint: /npp/payto/agreement/{{agreementIdentification}}/recall

Headers

Parameter Description
MW-MERCHANTID

The value of this parameter is provided to you by Merchant Warrior. Also known as your Merchant UUID.
Example: 4aa82af83c95d
MW-APIKEY

The value of this parameter is provided to you by Merchant Warrior.
Example: mz3dz5fp
MW-MESSAGEHASH

The verification hash is a combination of the HMAC SHA256 of your API Passphrase, and URL path. See MW-MESSAGEHASH (GET) for information on how to construct the hash correctly.
Example: 59e5f6f02777398bfd5652d041f1e0d3e44e30587308c55c7053f5e7d4b3a48d
MW-API-VERSION

Must be set to 2.0 for this product.
Example: 2.0

Path Parameters

Parameter Description
agreementIdentification

The agreementIdentification returned by the Create Agreement endpoint
Example: 6ecae9efaeee1ba39a5dcc9ecbf36e09

Copy 
XML Not Supported
XML Not Supported
{
    "responseCode": 0,
    "responseMessage": "Operation successful"
}
{ "responseCode": 0, "responseMessage": "Operation successful" }
XML Not Supported
XML Not Supported
{
    "responseCode": -4,
    "responseMessage": "Mandate action has already been resolved"
}
{ "responseCode": -4, "responseMessage": "Mandate action has already been resolved" }
Payments

Once an agreement is in place, transaction can take place. The payments created here must be in line with the agreement that has been agreed upon. Once a payment request is made, an instant response will be returned with the outcome of the transaction, along with a reason for failure (if any).

Create Payment

HTTP Verb: POST
Endpoint: /npp/payto/agreement/{{agreementIdentification}}/payment

Headers

Parameter Description
MW-MERCHANTID

The value of this parameter is provided to you by Merchant Warrior. Also known as your Merchant UUID.
Example: 4aa82af83c95d
MW-APIKEY

The value of this parameter is provided to you by Merchant Warrior.
Example: mz3dz5fp
MW-MESSAGEHASH

The verification hash is a combination of the HMAC SHA256 of your API Passphrase, and the entire JSON body. See MW-MESSAGEHASH (JSON) for information on how to construct the hash correctly.
Example: 59e5f6f02777398bfd5652d041f1e0d3e44e30587308c55c7053f5e7d4b3a48d
MW-API-VERSION

Must be set to 2.0 for this product.
Example: 2.0

Path Parameters

Parameter Description
agreementIdentification

The agreementIdentification returned by the Create Agreement endpoint
Example: 6ecae9efaeee1ba39a5dcc9ecbf36e09

JSON Body

Parameter Description
payer

Type: Object
Required: Yes

An object describing the payer.
payer.name

Type: String
Required: Yes

The payer's name.
payer.address

Type: String
Required: Yes

The payer's address.
payer.city

Type: String
Required: Yes

The payer's city.
payer.state

Type: String
Required: Yes

The payer's state.
payer.postcode

Type: String
Required: Yes

The payer's postcode.
payer.country

Type: String
Required: Yes

The payer's country.
payer.phone

Type: String
Required: Yes

The payer's phone.
payer.email

Type: String
Required: Yes

The payer's email.
transaction

Type: Object
Required: Yes

An object describing the transaction.
transaction.reference

Type: String
Max length: 35
Required: Yes

A unique reference for the transaction.
transaction.product

Type: String
Max length: 255
Required: Yes

The product/service that the transaction is for.
transaction.amount

Type: Number
Required: Yes

The transaction amount.
transaction.lastPayment

Type: Boolean
Required: No

A boolean value indicating if this transaction is the last in the series.

Copy 
{
    "payer": {
        "name": "Bruce Wayne",
        "address": "345 Ann Street",
        "city": "Brisbane",
        "state": "Queensland",
        "postcode": "4127",
        "country": "Australia",
        "phone": "0422222666",
        "email": "[email protected]"
    },
    "transaction": {
        "reference": "7ba556ac7be641868ffe441630540b1d",
        "product" : "$20.00 Weekly Gym Membership",
        "amount": 50
        "lastPayment": true,
    }
}
{ "payer": { "name": "Bruce Wayne", "address": "345 Ann Street", "city": "Brisbane", "state": "Queensland", "postcode": "4127", "country": "Australia", "phone": "0422222666", "email": "[email protected]" }, "transaction": { "reference": "7ba556ac7be641868ffe441630540b1d", "product" : "$20.00 Weekly Gym Membership", "amount": 50 "lastPayment": true, } }
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
Copy 
<?xml version="1.0"?>
<mwResponse>
  <responseCode>0</responseCode>
  <responseMessage>Operation successful</responseMessage>
  <result>
    <payer>
      <account>
        <name>Bruce Wayne</name>
        <bsb>802950</bsb>
        <accountNumber>1234569</accountNumber>
      </account>
    </payer>
    <transaction>
      <id>1600-42a02811-7c6a-11ee-b58c-005056a5521a</id>
      <status>approved</status>
    </transaction>
  </result>
</mwResponse>
0 Operation successful Bruce Wayne 802950 1234569 1600-42a02811-7c6a-11ee-b58c-005056a5521a approved 
{
    "responseCode": 0,
    "responseMessage": "Operation successful",
    "result": {
        "payer": {
            "account": {
                "name": "Bruce Wayne",
                "bsb": "802950",
                "accountNumber": "1234569"
            }
        },
        "transaction": {
            "id": "1600-42a02811-7c6a-11ee-b58c-005056a5521a",
            "status": "approved"
        }
    }
}
{ "responseCode": 0, "responseMessage": "Operation successful", "result": { "payer": { "account": { "name": "Bruce Wayne", "bsb": "802950", "accountNumber": "1234569" } }, "transaction": { "id": "1600-42a02811-7c6a-11ee-b58c-005056a5521a", "status": "approved" } } }
XML Not Supported
XML Not Supported
{
    "responseCode": 1,
    "responseMessage": "Provider error",
    "providerMessage": "Connection timed out after 30000 milliseconds"
}
{ "responseCode": 1, "responseMessage": "Provider error", "providerMessage": "Connection timed out after 30000 milliseconds" }
Get Payment

HTTP Verb: GET
Endpoint: /npp/payto/agreement/{{agreementIdentification}}/payment/{{transactionId}}

Headers

Parameter Description
MW-MERCHANTID

The value of this parameter is provided to you by Merchant Warrior. Also known as your Merchant UUID.
Example: 4aa82af83c95d
MW-APIKEY

The value of this parameter is provided to you by Merchant Warrior.
Example: mz3dz5fp
MW-MESSAGEHASH

The verification hash is a combination of the HMAC SHA256 of your API Passphrase, and URL path. See MW-MESSAGEHASH (GET) for information on how to construct the hash correctly.
Example: 59e5f6f02777398bfd5652d041f1e0d3e44e30587308c55c7053f5e7d4b3a48d
MW-API-VERSION

Must be set to 2.0 for this product.
Example: 2.0

Path Parameters

Parameter Description
agreementIdentification

The agreementIdentification returned by the Create Agreement endpoint
Example: 6ecae9efaeee1ba39a5dcc9ecbf36e09
transactionId

Copy 
XML Not Supported
XML Not Supported
{
    "responseCode": 0,
    "responseMessage": "Operation successful",
    "result": {
        "payer": {
            "name": "Bruce Wayne",
            "address": "345 Ann Street",
            "city": "Brisbane",
            "state": "Queensland",
            "postcode": "4127",
            "country": "Australia",
            "phone": "0422222666",
            "email": "[email protected]"
        },
        "transaction": {
            "id": "1600-7c4cedcd-1d51-11ef-9422-005056a5521a",
            "status": "approved",
            "reference": "b3b544d202714e6792af61a1de83272d",
            "product": "$20.00 Weekly Gym Membership",
            "amount": 50,
            "created": "2023-08-10 16:26",
            "udpated": "2023-08-10 16:26"
        }
    }
}
{ "responseCode": 0, "responseMessage": "Operation successful", "result": { "payer": { "name": "Bruce Wayne", "address": "345 Ann Street", "city": "Brisbane", "state": "Queensland", "postcode": "4127", "country": "Australia", "phone": "0422222666", "email": "[email protected]" }, "transaction": { "id": "1600-7c4cedcd-1d51-11ef-9422-005056a5521a", "status": "approved", "reference": "b3b544d202714e6792af61a1de83272d", "product": "$20.00 Weekly Gym Membership", "amount": 50, "created": "2023-08-10 16:26", "udpated": "2023-08-10 16:26" } } }
Get Payment Status

HTTP Verb: GET
Endpoint: /npp/payto/agreement/{{agreementIdentification}}/payment/{{transactionId}}/status

Headers

Parameter Description
MW-MERCHANTID

The value of this parameter is provided to you by Merchant Warrior. Also known as your Merchant UUID.
Example: 4aa82af83c95d
MW-APIKEY

The value of this parameter is provided to you by Merchant Warrior.
Example: mz3dz5fp
MW-MESSAGEHASH

The verification hash is a combination of the HMAC SHA256 of your API Passphrase, and URL path. See MW-MESSAGEHASH (GET) for information on how to construct the hash correctly.
Example: 59e5f6f02777398bfd5652d041f1e0d3e44e30587308c55c7053f5e7d4b3a48d
MW-API-VERSION

Must be set to 2.0 for this product.
Example: 2.0

Path Parameters

Parameter Description
agreementIdentification

The agreementIdentification returned by the Create Agreement endpoint
Example: 6ecae9efaeee1ba39a5dcc9ecbf36e09
transactionId

The transactionId, as returned in the Create Payment response.
Example: 1600-42a02811-7c6a-11ee-b58c-005056a5521a

Copy 
XML Not Supported
XML Not Supported
{
    "responseCode": 0,
    "responseMessage": "Operation successful",
    "result": {
        "status": "approved"
    }
}
{ "responseCode": 0, "responseMessage": "Operation successful", "result": { "status": "approved" } }
Search Payments

HTTP Verb: GET
Endpoint: /npp/payto/agreement/{{agreementIdentification}}/payment

Headers

Parameter Description
MW-MERCHANTID

The value of this parameter is provided to you by Merchant Warrior. Also known as your Merchant UUID.
Example: 4aa82af83c95d
MW-APIKEY

The value of this parameter is provided to you by Merchant Warrior.
Example: mz3dz5fp
MW-MESSAGEHASH

The verification hash is a combination of the HMAC SHA256 of your API Passphrase, and URL path. See MW-MESSAGEHASH (GET) for information on how to construct the hash correctly.
Example: 59e5f6f02777398bfd5652d041f1e0d3e44e30587308c55c7053f5e7d4b3a48d
MW-API-VERSION

Must be set to 2.0 for this product.
Example: 2.0

Path Parameters

Parameter Description
agreementIdentification

The agreementIdentification returned by the Create Agreement endpoint
Example: 6ecae9efaeee1ba39a5dcc9ecbf36e09

Query Parameters

Parameter Description
from

Type: String
Format: 2023-10-01 00:00

The lower end of the date search.
to

Type: String
Format: 2023-10-31 23:59

The upper end of the date search.
pageNumber

Type: Integer

The page number to display for the specified search parameters
pageSize

Type: Integer

The number of results to display per page.
timezone

Type: String
Default: Australia/Brisbane

The timezone to use for the date search, as shown at https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

Copy 
XML Not Supported
XML Not Supported
{
    "responseCode": 0,
    "responseMessage": "Operation successful",
    "result": [
        {
            "payer": {
                "name": "Bruce Wayne",
                "address": "345 Ann Street",
                "city": "Brisbane",
                "state": "Queensland",
                "postcode": "4127",
                "country": "Australia",
                "phone": "0422222666",
                "email": "[email protected]"
            },
            "transaction": {
                "status": "approved",
                "reference": "e828bebaf1c24e2291ca06835794bfa1",
                "product": "$20.00 Weekly Gym Membership",
                "amount": 50,
                "created": "2023-08-09 17:16",
                "udpated": "2023-08-10 16:10"
            }
        },
        {
            "payer": {
                "name": "Bruce Wayne",
                "address": "345 Ann Street",
                "city": "Brisbane",
                "state": "Queensland",
                "postcode": "4127",
                "country": "Australia",
                "phone": "0422222666",
                "email": "[email protected]"
            },
            "transaction": {
                "status": "approved",
                "reference": "163c25f88f5d4833a8c3d7d2f59efabb",
                "product": "$20.00 Weekly Gym Membership",
                "amount": 50,
                "created": "2023-08-09 17:16",
                "udpated": "2023-08-10 16:10"
            }
        },
        {
            "payer": {
                "name": "Bruce Wayne",
                "address": "345 Ann Street",
                "city": "Brisbane",
                "state": "Queensland",
                "postcode": "4127",
                "country": "Australia",
                "phone": "0422222666",
                "email": "[email protected]"
            },
            "transaction": {
                "status": "approved",
                "reference": "e25d0f5998f346c8903f1e991e5e5e21",
                "product": "$20.00 Weekly Gym Membership",
                "amount": 50,
                "created": "2023-08-09 17:16",
                "udpated": "2023-08-10 16:10"
            }
        }
    ]
}
{ "responseCode": 0, "responseMessage": "Operation successful", "result": [ { "payer": { "name": "Bruce Wayne", "address": "345 Ann Street", "city": "Brisbane", "state": "Queensland", "postcode": "4127", "country": "Australia", "phone": "0422222666", "email": "[email protected]" }, "transaction": { "status": "approved", "reference": "e828bebaf1c24e2291ca06835794bfa1", "product": "$20.00 Weekly Gym Membership", "amount": 50, "created": "2023-08-09 17:16", "udpated": "2023-08-10 16:10" } }, { "payer": { "name": "Bruce Wayne", "address": "345 Ann Street", "city": "Brisbane", "state": "Queensland", "postcode": "4127", "country": "Australia", "phone": "0422222666", "email": "[email protected]" }, "transaction": { "status": "approved", "reference": "163c25f88f5d4833a8c3d7d2f59efabb", "product": "$20.00 Weekly Gym Membership", "amount": 50, "created": "2023-08-09 17:16", "udpated": "2023-08-10 16:10" } }, { "payer": { "name": "Bruce Wayne", "address": "345 Ann Street", "city": "Brisbane", "state": "Queensland", "postcode": "4127", "country": "Australia", "phone": "0422222666", "email": "[email protected]" }, "transaction": { "status": "approved", "reference": "e25d0f5998f346c8903f1e991e5e5e21", "product": "$20.00 Weekly Gym Membership", "amount": 50, "created": "2023-08-09 17:16", "udpated": "2023-08-10 16:10" } } ] }
Notifications

Notifications are sent to your notify URL for any asynchronous action that the account holder may take, such as accepting or rejecting an agreement, or when funds have successfully been transferred (Payment Resolution). The notification payloads sent to your notify URL are shown here.

Agreement Notifications

  1. Email based agreement acceptance
  2. Email based agreement rejection
  3. Account based agreement acceptance
  4. Account based agreement rejection
  5. Phone based agreement acceptance
  6. Phone based agreement rejection
  7. ABN based agreement acceptance
  8. ABN based agreement rejection

Payment Notifications

  1. Payment Resolution

Copy 
XML Not Supported
XML Not Supported
{
    "payer": {
        "identificationType": "email",
        "email": "[email protected]",
        "name": "Tony Stark",
        "principalName": "Stark Enterprises",
        "type": "PERS",
        "reference": "PHUID9876578"
    },
    "notifyType": "PTA",
    "trigger": "MCRC",
    "action": {
        "id": "v6f16817e5ct6w993h41oemekytzcarw",
        "type": "CREA",
        "status": "CMPL"
    },
    "agreement": {
        "payment": {
            "maximum": 100,
            "pointInTime": 1,
            "firstPaymentDate": "2024-03-12",
            "lastPaymentAmount": null,
            "firstPaymentAmount": 99,
            "countPerPeriod": null,
            "amount": 10,
            "type": "VARI",
            "frequency": "WEEK",
            "lastPaymentDate": "2024-04-11"
        },
        "summary": "Weekly Gym Membership",
        "endDate": "2025-03-12",
        "arrangement": "Powerhouse Gym will deduct $10.00 every Monday until cancelled, with a one-time signup fee of $99.00 and a cancellation fee of $299.00",
        "reference": "PHAID123456789",
        "startDate": "2024-03-12",
        "status": "ACTV",
        "version": 1,
        "id": "udf5soytom7j1voxxbe8p1zr5w4ffm3c",
        "actionByDate": "2024-03-16",
        "description": "Weekly Gym Membership to Powerhouse Gym Southside.",
        "purpose": "OTHR"
    }
}
{ "payer": { "identificationType": "email", "email": "[email protected]", "name": "Tony Stark", "principalName": "Stark Enterprises", "type": "PERS", "reference": "PHUID9876578" }, "notifyType": "PTA", "trigger": "MCRC", "action": { "id": "v6f16817e5ct6w993h41oemekytzcarw", "type": "CREA", "status": "CMPL" }, "agreement": { "payment": { "maximum": 100, "pointInTime": 1, "firstPaymentDate": "2024-03-12", "lastPaymentAmount": null, "firstPaymentAmount": 99, "countPerPeriod": null, "amount": 10, "type": "VARI", "frequency": "WEEK", "lastPaymentDate": "2024-04-11" }, "summary": "Weekly Gym Membership", "endDate": "2025-03-12", "arrangement": "Powerhouse Gym will deduct $10.00 every Monday until cancelled, with a one-time signup fee of $99.00 and a cancellation fee of $299.00", "reference": "PHAID123456789", "startDate": "2024-03-12", "status": "ACTV", "version": 1, "id": "udf5soytom7j1voxxbe8p1zr5w4ffm3c", "actionByDate": "2024-03-16", "description": "Weekly Gym Membership to Powerhouse Gym Southside.", "purpose": "OTHR" } }
XML Not Supported
XML Not Supported
{
    "payer": {
        "identificationType": "email",
        "email": "[email protected]",
        "name": "Tony Stark",
        "principalName": "Stark Enterprises",
        "type": "PERS",
        "reference": "PHUID9876578"
    },
    "notifyType": "PTA",
    "trigger": "MCRC",
    "action": {
        "id": "v6f16817e5ct6w993h41oemekytzcarw",
        "type": "CREA",
        "status": "DECL"
    },
    "agreement": {
        "payment": {
            "maximum": 100,
            "pointInTime": 1,
            "firstPaymentDate": "2024-03-12",
            "lastPaymentAmount": null,
            "firstPaymentAmount": 99,
            "countPerPeriod": null,
            "amount": 10,
            "type": "VARI",
            "frequency": "WEEK",
            "lastPaymentDate": "2024-04-11"
        },
        "summary": "Weekly Gym Membership",
        "endDate": "2025-03-12",
        "arrangement": "Powerhouse Gym will deduct $10.00 every Monday until cancelled, with a one-time signup fee of $99.00 and a cancellation fee of $299.00",
        "reference": "PHAID123456789",
        "startDate": "2024-03-12",
        "status": "CNCD",
        "version": 1,
        "id": "udf5soytom7j1voxxbe8p1zr5w4ffm3c",
        "actionByDate": "2024-03-16",
        "description": "Weekly Gym Membership to Powerhouse Gym Southside.",
        "purpose": "OTHR"
    }
}
{ "payer": { "identificationType": "email", "email": "[email protected]", "name": "Tony Stark", "principalName": "Stark Enterprises", "type": "PERS", "reference": "PHUID9876578" }, "notifyType": "PTA", "trigger": "MCRC", "action": { "id": "v6f16817e5ct6w993h41oemekytzcarw", "type": "CREA", "status": "DECL" }, "agreement": { "payment": { "maximum": 100, "pointInTime": 1, "firstPaymentDate": "2024-03-12", "lastPaymentAmount": null, "firstPaymentAmount": 99, "countPerPeriod": null, "amount": 10, "type": "VARI", "frequency": "WEEK", "lastPaymentDate": "2024-04-11" }, "summary": "Weekly Gym Membership", "endDate": "2025-03-12", "arrangement": "Powerhouse Gym will deduct $10.00 every Monday until cancelled, with a one-time signup fee of $99.00 and a cancellation fee of $299.00", "reference": "PHAID123456789", "startDate": "2024-03-12", "status": "CNCD", "version": 1, "id": "udf5soytom7j1voxxbe8p1zr5w4ffm3c", "actionByDate": "2024-03-16", "description": "Weekly Gym Membership to Powerhouse Gym Southside.", "purpose": "OTHR" } }
XML Not Supported
XML Not Supported
{
    "payer": {
        "identificationType": "account",
        "account": {
            "bsb": "111111",
            "accountNumber": "999999999"
        },
        "name": "Tony Stark",
        "principalName": "Stark Enterprises",
        "type": "PERS",
        "reference": "PHUID9876578"
    },
    "notifyType": "PTA",
    "trigger": "MCRC",
    "action": {
        "id": "bpg3rfmbnfbtp9qzi8ljym0ldrq0hcxm",
        "type": "CREA",
        "status": "CMPL"
    },
    "agreement": {
        "payment": {
            "maximum": 100,
            "pointInTime": 1,
            "firstPaymentDate": "2024-03-12",
            "lastPaymentAmount": null,
            "firstPaymentAmount": 99,
            "countPerPeriod": null,
            "amount": 10,
            "type": "VARI",
            "frequency": "WEEK",
            "lastPaymentDate": "2024-04-11"
        },
        "summary": "Weekly Gym Membership",
        "endDate": "2025-03-12",
        "arrangement": "Powerhouse Gym will deduct $10.00 every Monday until cancelled, with a one-time signup fee of $99.00 and a cancellation fee of $299.00",
        "reference": "PHAID123456789",
        "startDate": "2024-03-12",
        "status": "ACTV",
        "version": 1,
        "id": "ab97ndvd8n8yb5dyqrlpbrpjwjnhelhq",
        "actionByDate": "2024-03-16",
        "description": "Weekly Gym Membership to Powerhouse Gym Southside.",
        "purpose": "OTHR"
    }
}
{ "payer": { "identificationType": "account", "account": { "bsb": "111111", "accountNumber": "999999999" }, "name": "Tony Stark", "principalName": "Stark Enterprises", "type": "PERS", "reference": "PHUID9876578" }, "notifyType": "PTA", "trigger": "MCRC", "action": { "id": "bpg3rfmbnfbtp9qzi8ljym0ldrq0hcxm", "type": "CREA", "status": "CMPL" }, "agreement": { "payment": { "maximum": 100, "pointInTime": 1, "firstPaymentDate": "2024-03-12", "lastPaymentAmount": null, "firstPaymentAmount": 99, "countPerPeriod": null, "amount": 10, "type": "VARI", "frequency": "WEEK", "lastPaymentDate": "2024-04-11" }, "summary": "Weekly Gym Membership", "endDate": "2025-03-12", "arrangement": "Powerhouse Gym will deduct $10.00 every Monday until cancelled, with a one-time signup fee of $99.00 and a cancellation fee of $299.00", "reference": "PHAID123456789", "startDate": "2024-03-12", "status": "ACTV", "version": 1, "id": "ab97ndvd8n8yb5dyqrlpbrpjwjnhelhq", "actionByDate": "2024-03-16", "description": "Weekly Gym Membership to Powerhouse Gym Southside.", "purpose": "OTHR" } }
XML Not Supported
XML Not Supported
{
    "payer": {
        "identificationType": "account",
        "account": {
            "bsb": "111111",
            "accountNumber": "999999999"
        },
        "name": "Tony Stark",
        "principalName": "Stark Enterprises",
        "type": "PERS",
        "reference": "PHUID9876578"
    },
    "notifyType": "PTA",
    "trigger": "MCRC",
    "action": {
        "id": "bpg3rfmbnfbtp9qzi8ljym0ldrq0hcxm",
        "type": "CREA",
        "status": "DECL"
    },
    "agreement": {
        "payment": {
            "maximum": 100,
            "pointInTime": 1,
            "firstPaymentDate": "2024-03-12",
            "lastPaymentAmount": null,
            "firstPaymentAmount": 99,
            "countPerPeriod": null,
            "amount": 10,
            "type": "VARI",
            "frequency": "WEEK",
            "lastPaymentDate": "2024-04-11"
        },
        "summary": "Weekly Gym Membership",
        "endDate": "2025-03-12",
        "arrangement": "Powerhouse Gym will deduct $10.00 every Monday until cancelled, with a one-time signup fee of $99.00 and a cancellation fee of $299.00",
        "reference": "PHAID123456789",
        "startDate": "2024-03-12",
        "status": "CNCD",
        "version": 1,
        "id": "ab97ndvd8n8yb5dyqrlpbrpjwjnhelhq",
        "actionByDate": "2024-03-16",
        "description": "Weekly Gym Membership to Powerhouse Gym Southside.",
        "purpose": "OTHR"
    }
}
{ "payer": { "identificationType": "account", "account": { "bsb": "111111", "accountNumber": "999999999" }, "name": "Tony Stark", "principalName": "Stark Enterprises", "type": "PERS", "reference": "PHUID9876578" }, "notifyType": "PTA", "trigger": "MCRC", "action": { "id": "bpg3rfmbnfbtp9qzi8ljym0ldrq0hcxm", "type": "CREA", "status": "DECL" }, "agreement": { "payment": { "maximum": 100, "pointInTime": 1, "firstPaymentDate": "2024-03-12", "lastPaymentAmount": null, "firstPaymentAmount": 99, "countPerPeriod": null, "amount": 10, "type": "VARI", "frequency": "WEEK", "lastPaymentDate": "2024-04-11" }, "summary": "Weekly Gym Membership", "endDate": "2025-03-12", "arrangement": "Powerhouse Gym will deduct $10.00 every Monday until cancelled, with a one-time signup fee of $99.00 and a cancellation fee of $299.00", "reference": "PHAID123456789", "startDate": "2024-03-12", "status": "CNCD", "version": 1, "id": "ab97ndvd8n8yb5dyqrlpbrpjwjnhelhq", "actionByDate": "2024-03-16", "description": "Weekly Gym Membership to Powerhouse Gym Southside.", "purpose": "OTHR" } }
XML Not Supported
XML Not Supported
{
    "payer": {
        "identificationType": "phone",
        "phone": "+61-491570156",
        "name": "Tony Stark",
        "principalName": "Stark Enterprises",
        "type": "PERS",
        "reference": "PHUID9876578"
    },
    "notifyType": "PTA",
    "trigger": "MCRC",
    "action": {
        "id": "ri3sjn4ar9cc19h0xvmhqxyoc06ogq3w",
        "type": "CREA",
        "status": "CMPL"
    },
    "agreement": {
        "payment": {
            "maximum": 100,
            "pointInTime": 1,
            "firstPaymentDate": "2024-03-12",
            "lastPaymentAmount": null,
            "firstPaymentAmount": 99,
            "countPerPeriod": null,
            "amount": 10,
            "type": "VARI",
            "frequency": "WEEK",
            "lastPaymentDate": "2024-04-11"
        },
        "summary": "Weekly Gym Membership",
        "endDate": "2025-03-12",
        "arrangement": "Powerhouse Gym will deduct $10.00 every Monday until cancelled, with a one-time signup fee of $99.00 and a cancellation fee of $299.00",
        "reference": "PHAID123456789",
        "startDate": "2024-03-12",
        "status": "ACTV",
        "version": 1,
        "id": "2s1ku5cqg5qdrv6hcfw0sokfj5apcn8f",
        "actionByDate": "2024-03-16",
        "description": "Weekly Gym Membership to Powerhouse Gym Southside.",
        "purpose": "OTHR"
    }
}
{ "payer": { "identificationType": "phone", "phone": "+61-491570156", "name": "Tony Stark", "principalName": "Stark Enterprises", "type": "PERS", "reference": "PHUID9876578" }, "notifyType": "PTA", "trigger": "MCRC", "action": { "id": "ri3sjn4ar9cc19h0xvmhqxyoc06ogq3w", "type": "CREA", "status": "CMPL" }, "agreement": { "payment": { "maximum": 100, "pointInTime": 1, "firstPaymentDate": "2024-03-12", "lastPaymentAmount": null, "firstPaymentAmount": 99, "countPerPeriod": null, "amount": 10, "type": "VARI", "frequency": "WEEK", "lastPaymentDate": "2024-04-11" }, "summary": "Weekly Gym Membership", "endDate": "2025-03-12", "arrangement": "Powerhouse Gym will deduct $10.00 every Monday until cancelled, with a one-time signup fee of $99.00 and a cancellation fee of $299.00", "reference": "PHAID123456789", "startDate": "2024-03-12", "status": "ACTV", "version": 1, "id": "2s1ku5cqg5qdrv6hcfw0sokfj5apcn8f", "actionByDate": "2024-03-16", "description": "Weekly Gym Membership to Powerhouse Gym Southside.", "purpose": "OTHR" } }
XML Not Supported
XML Not Supported
{
    "payer": {
        "identificationType": "phone",
        "phone": "+61-491570156",
        "name": "Tony Stark",
        "principalName": "Stark Enterprises",
        "type": "PERS",
        "reference": "PHUID9876578"
    },
    "notifyType": "PTA",
    "trigger": "MCRC",
    "action": {
        "id": "ri3sjn4ar9cc19h0xvmhqxyoc06ogq3w",
        "type": "CREA",
        "status": "DECL"
    },
    "agreement": {
        "payment": {
            "maximum": 100,
            "pointInTime": 1,
            "firstPaymentDate": "2024-03-12",
            "lastPaymentAmount": null,
            "firstPaymentAmount": 99,
            "countPerPeriod": null,
            "amount": 10,
            "type": "VARI",
            "frequency": "WEEK",
            "lastPaymentDate": "2024-04-11"
        },
        "summary": "Weekly Gym Membership",
        "endDate": "2025-03-12",
        "arrangement": "Powerhouse Gym will deduct $10.00 every Monday until cancelled, with a one-time signup fee of $99.00 and a cancellation fee of $299.00",
        "reference": "PHAID123456789",
        "startDate": "2024-03-12",
        "status": "CNCD",
        "version": 1,
        "id": "2s1ku5cqg5qdrv6hcfw0sokfj5apcn8f",
        "actionByDate": "2024-03-16",
        "description": "Weekly Gym Membership to Powerhouse Gym Southside.",
        "purpose": "OTHR"
    }
}
{ "payer": { "identificationType": "phone", "phone": "+61-491570156", "name": "Tony Stark", "principalName": "Stark Enterprises", "type": "PERS", "reference": "PHUID9876578" }, "notifyType": "PTA", "trigger": "MCRC", "action": { "id": "ri3sjn4ar9cc19h0xvmhqxyoc06ogq3w", "type": "CREA", "status": "DECL" }, "agreement": { "payment": { "maximum": 100, "pointInTime": 1, "firstPaymentDate": "2024-03-12", "lastPaymentAmount": null, "firstPaymentAmount": 99, "countPerPeriod": null, "amount": 10, "type": "VARI", "frequency": "WEEK", "lastPaymentDate": "2024-04-11" }, "summary": "Weekly Gym Membership", "endDate": "2025-03-12", "arrangement": "Powerhouse Gym will deduct $10.00 every Monday until cancelled, with a one-time signup fee of $99.00 and a cancellation fee of $299.00", "reference": "PHAID123456789", "startDate": "2024-03-12", "status": "CNCD", "version": 1, "id": "2s1ku5cqg5qdrv6hcfw0sokfj5apcn8f", "actionByDate": "2024-03-16", "description": "Weekly Gym Membership to Powerhouse Gym Southside.", "purpose": "OTHR" } }
XML Not Supported
XML Not Supported
{
    "payer": {
        "identificationType": "abn",
        "abn": "13132951172",
        "name": "Tony Stark",
        "principalName": "Stark Enterprises",
        "type": "PERS",
        "reference": "PHUID9876578"
    },
    "notifyType": "PTA",
    "trigger": "MCRC",
    "action": {
        "id": "7lbwxqm8irtru0c4azdob0uc09qfbu3g",
        "type": "CREA",
        "status": "CMPL"
    },
    "agreement": {
        "payment": {
            "maximum": 100,
            "pointInTime": 1,
            "firstPaymentDate": "2024-03-12",
            "lastPaymentAmount": null,
            "firstPaymentAmount": 99,
            "countPerPeriod": null,
            "amount": 10,
            "type": "VARI",
            "frequency": "WEEK",
            "lastPaymentDate": "2024-04-11"
        },
        "summary": "Weekly Gym Membership",
        "endDate": "2025-03-12",
        "arrangement": "Powerhouse Gym will deduct $10.00 every Monday until cancelled, with a one-time signup fee of $99.00 and a cancellation fee of $299.00",
        "reference": "PHAID123456789",
        "startDate": "2024-03-12",
        "status": "ACTV",
        "version": 1,
        "id": "yj56ya15fa0p9ivstn1f9mhbkylfo1nu",
        "actionByDate": "2024-03-16",
        "description": "Weekly Gym Membership to Powerhouse Gym Southside.",
        "purpose": "OTHR"
    }
}
{ "payer": { "identificationType": "abn", "abn": "13132951172", "name": "Tony Stark", "principalName": "Stark Enterprises", "type": "PERS", "reference": "PHUID9876578" }, "notifyType": "PTA", "trigger": "MCRC", "action": { "id": "7lbwxqm8irtru0c4azdob0uc09qfbu3g", "type": "CREA", "status": "CMPL" }, "agreement": { "payment": { "maximum": 100, "pointInTime": 1, "firstPaymentDate": "2024-03-12", "lastPaymentAmount": null, "firstPaymentAmount": 99, "countPerPeriod": null, "amount": 10, "type": "VARI", "frequency": "WEEK", "lastPaymentDate": "2024-04-11" }, "summary": "Weekly Gym Membership", "endDate": "2025-03-12", "arrangement": "Powerhouse Gym will deduct $10.00 every Monday until cancelled, with a one-time signup fee of $99.00 and a cancellation fee of $299.00", "reference": "PHAID123456789", "startDate": "2024-03-12", "status": "ACTV", "version": 1, "id": "yj56ya15fa0p9ivstn1f9mhbkylfo1nu", "actionByDate": "2024-03-16", "description": "Weekly Gym Membership to Powerhouse Gym Southside.", "purpose": "OTHR" } }
XML Not Supported
XML Not Supported
{
    "payer": {
        "identificationType": "abn",
        "abn": "13132951172",
        "name": "Tony Stark",
        "principalName": "Stark Enterprises",
        "type": "PERS",
        "reference": "PHUID9876578"
    },
    "notifyType": "PTA",
    "trigger": "MCRC",
    "action": {
        "id": "7lbwxqm8irtru0c4azdob0uc09qfbu3g",
        "type": "CREA",
        "status": "DECL"
    },
    "agreement": {
        "payment": {
            "maximum": 100,
            "pointInTime": 1,
            "firstPaymentDate": "2024-03-12",
            "lastPaymentAmount": null,
            "firstPaymentAmount": 99,
            "countPerPeriod": null,
            "amount": 10,
            "type": "VARI",
            "frequency": "WEEK",
            "lastPaymentDate": "2024-04-11"
        },
        "summary": "Weekly Gym Membership",
        "endDate": "2025-03-12",
        "arrangement": "Powerhouse Gym will deduct $10.00 every Monday until cancelled, with a one-time signup fee of $99.00 and a cancellation fee of $299.00",
        "reference": "PHAID123456789",
        "startDate": "2024-03-12",
        "status": "CNCD",
        "version": 1,
        "id": "yj56ya15fa0p9ivstn1f9mhbkylfo1nu",
        "actionByDate": "2024-03-16",
        "description": "Weekly Gym Membership to Powerhouse Gym Southside.",
        "purpose": "OTHR"
    }
}
{ "payer": { "identificationType": "abn", "abn": "13132951172", "name": "Tony Stark", "principalName": "Stark Enterprises", "type": "PERS", "reference": "PHUID9876578" }, "notifyType": "PTA", "trigger": "MCRC", "action": { "id": "7lbwxqm8irtru0c4azdob0uc09qfbu3g", "type": "CREA", "status": "DECL" }, "agreement": { "payment": { "maximum": 100, "pointInTime": 1, "firstPaymentDate": "2024-03-12", "lastPaymentAmount": null, "firstPaymentAmount": 99, "countPerPeriod": null, "amount": 10, "type": "VARI", "frequency": "WEEK", "lastPaymentDate": "2024-04-11" }, "summary": "Weekly Gym Membership", "endDate": "2025-03-12", "arrangement": "Powerhouse Gym will deduct $10.00 every Monday until cancelled, with a one-time signup fee of $99.00 and a cancellation fee of $299.00", "reference": "PHAID123456789", "startDate": "2024-03-12", "status": "CNCD", "version": 1, "id": "yj56ya15fa0p9ivstn1f9mhbkylfo1nu", "actionByDate": "2024-03-16", "description": "Weekly Gym Membership to Powerhouse Gym Southside.", "purpose": "OTHR" } }
XML Not Supported
XML Not Supported
{
    "notifyType": "PTP",
    "payer": {
        "name": "D OCONNOR",
        "address": "345 Ann Street",
        "city": "Brisbane",
        "state": "Queensland",
        "postcode": "4127",
        "country": "Australia",
        "phone": "0411111111",
        "email": "[email protected]"
    },
    "transaction": {
        "id": "1600-80a226fd-1d52-11ef-9422-005056a5521a",
        "status": "approved",
        "reference": "4892ad806e454097827ec520d7bc332f",
        "product": "PRODUCT NAME",
        "amount": 99,
        "created": "2024-05-29 10:29",
        "updated": "2024-05-29 10:29",
        "customData": {
            "custom1": "H1",
            "custom2": "H2",
            "custom3": "H3"
        }
    }
}
{ "notifyType": "PTP", "payer": { "name": "D OCONNOR", "address": "345 Ann Street", "city": "Brisbane", "state": "Queensland", "postcode": "4127", "country": "Australia", "phone": "0411111111", "email": "[email protected]" }, "transaction": { "id": "1600-80a226fd-1d52-11ef-9422-005056a5521a", "status": "approved", "reference": "4892ad806e454097827ec520d7bc332f", "product": "PRODUCT NAME", "amount": 99, "created": "2024-05-29 10:29", "updated": "2024-05-29 10:29", "customData": { "custom1": "H1", "custom2": "H2", "custom3": "H3" } } }