The PayTo Status Change service in ANZ Fileactive’s PayTo API allows businesses to update the status of existing mandates. This feature is critical for managing the lifecycle of payment mandates, including activating, pausing, or canceling mandates as per business requirements or customer requests.

Where status change fits in the PayTo process flow:

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

PayTo Bilateral End to End Flow

Capabilities

  • Update mandate status: Change the status of a mandate to active, paused, or canceled, providing flexibility in mandate management.
  • Lifecycle management: Supports all key mandate status transitions, ensuring mandates reflect the current business needs or customer preferences.
  • Real-time updates: Status changes are processed and reflected immediately, allowing for quick adjustments to mandates.

Technical Requirements

  • API Endpoint: /v1.0/payto/mandates/{mandateId}/status
  • Authentication: OAuth 2.0 with Client Credential Grant flow for secure access to the API.
  • Request format: JSON format specifying the mandate ID and the desired new status.
  • Security: Status change requests are protected with OAuth 2.0 bearer tokens, and payloads are encrypted to maintain data security.

Key features for developers

  • Immediate status application: Status changes are applied in real-time, enabling immediate control over mandate behavior.
  • Error handling: The API ensures robust error handling for invalid status transitions or unauthorised requests.
  • Notifications: Optional notifications can be configured to inform stakeholders about status changes.

Example workflow

sequenceDiagram participant Client participant ANZ API participant Customer Client->>ANZ API: POST /v1.0/auth (OAuth 2.0 Client Credentials) ANZ API-->>Client: 200 OK (Bearer Token) Client->>ANZ API: POST /v1.0/payto/mandate/status/change (Status Change Request) ANZ API-->>Customer: Notify Customer (if required) Customer->>ANZ API: Acknowledge Status Change (if required) ANZ API-->>Client: 200 OK (Status Changed) Note right of ANZ API: Status changes are immediate
or require acknowledgment Client->>ANZ API: GET /v1.0/payto/mandate/{mandateId} (Check Mandate Status) alt Status Changed ANZ API-->>Client: 200 OK (Status Updated Successfully) else Status Pending ANZ API-->>Client: 202 Accepted (Status Change Pending) end

Usage notes

  • Status transitions: Common status transitions include activation, pausing, and cancellation. Each transition must comply with predefined rules to ensure mandate integrity.
  • Notifications: Depending on configuration, status changes can trigger notifications to customers or stakeholders.
  • Version control: Changes to the status do not affect the mandate version number but are recorded in the mandate’s history for audit purposes.

General Rules

  • ChangeAndReasonCodeRule1:
    • When change is equal to 'CNCL' (Cancel) or 'SUSP' (Suspend), then reason_code must be present.