Amend Mandate

The Mandate Amendment service in ANZ Fileactive’s PayTo API allows businesses to modify existing payment mandates. This operation is essential for maintaining accurate and up-to-date mandate agreements, ensuring that any necessary changes are correctly applied according to the roles and requirements of the parties involved.

Where amend fits in the PayTo process flow:

The diagram below illustrates the steps involved in the PayTo process and highlights where Amend plays a critical role:

Capabilities

• Amend existing mandates: Modify existing mandates to update payment terms, amounts, or other mandate details as required.
• Unilateral and bilateral amendments: The system determines if an amendment should be applied unilaterally (immediate effect) or bilaterally (requires payer approval), based on the party role of the caller and the specific fields being amended.
• Pending amendments management: For bilateral amendments, the amendment remains pending until it is either completed, declined by the payer, recalled by the biller, or expires. Only one bilateral amendment can be pending per mandate at any time.

Technical requirements

• API Endpoint: /payto/v1/mandates/{mandateId}
• Authentication: OAuth 2.0 with Client Credential Grant flow is required to securely access the API.
• Request Format: JSON format for mandate amendment details, including updated terms and authorisation settings.
• Security: All amendment requests are protected with OAuth 2.0 bearer tokens, and payloads are encrypted to ensure data integrity and confidentiality.

Key features for developers

• Integrity verification: For unilateral amendments, changes are applied only if they do not compromise the mandate’s integrity. For bilateral amendments, integrity checks are performed both when the request is received and upon confirmation of the action.
• Error handling: Attempts to amend a mandate requiring bilateral action will fail if there is already a pending amendment. However, unilateral amendments may still proceed under these conditions.
• Expiration of pending amendments: Bilateral amendments automatically expire after a set period if not completed, declined, or recalled.
• Version control: The mandate version number is incremented only when a bilateral amendment is successfully completed.

Example workflow

Usage notes

• Amendment types: Unilateral amendments apply immediately; bilateral amendments require payer approval and are subject to expiration if not completed in time.
• Integrity checks: Changes must maintain mandate integrity, as defined in the PayTo API - Create Mandate documentation.
• Versioning: Bilateral amendments will increment the mandate version number only upon successful completion.