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

Notifications

Email based agreement acceptance#

{
    "payer": {
        "identificationType": "email",
        "email": "tony@starkenterprises.com",
        "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"
    }
}

Email based agreement rejection#

{
    "payer": {
        "identificationType": "email",
        "email": "tony@starkenterprises.com",
        "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"
    }
}

Account based agreement acceptance#

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

Account based agreement rejection#

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

Phone based agreement acceptance#

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

Phone based agreement rejection#

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

ABN based agreement acceptance#

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

ABN based agreement rejection#

{
    "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"
    }
}
Modified at 2026-07-10 06:59:59
Previous
Agreements
Next
Create Agreement
Built with