The PayTo Details service in ANZ Fileactive’s PayTo API allows businesses to retrieve comprehensive information about existing mandates. This service provides key details about mandates, enabling effective management and monitoring of payment agreements between billers and payers.

Where mandate details fits in the PayTo process flow:

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

PayTo Bilateral End to End Flow

Capabilities

  • Retrieve mandate information: Access detailed information about individual mandates, including status, parties involved, and mandate terms.
  • Comprehensive data: Fetches all relevant mandate data, ensuring that businesses have the necessary insights to manage mandates effectively.
  • Support for multiple mandates: Allows querying of multiple mandates by various parameters, supporting robust mandate management strategies.

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: Requests are made in JSON format, specifying mandate identifiers or query parameters.
  • Security: All requests are authenticated using OAuth 2.0 bearer tokens, and responses are securely transmitted.

Key features for developers

  • Detailed mandate insights: Retrieve detailed mandate information, including payer details, payment schedules, and status history.
  • Flexible querying: Supports querying by mandate ID, status, date range, and other relevant parameters.
  • Error handling: Provides detailed error codes and messages to assist in troubleshooting request issues.

Example workflow

sequenceDiagram participant Client participant ANZ API Client->>ANZ API: POST /v1.0/auth (OAuth 2.0 Client Credentials) ANZ API-->>Client: 200 OK (Bearer Token) Client->>ANZ API: GET /v1.0/payto/mandate/details (Fetch Mandate Details) ANZ API-->>Client: 200 OK (Mandate Details JSON) Note right of ANZ API: Provides detailed information
about the requested mandate

Usage notes

  • Mandate identification: Ensure that requests specify accurate mandate IDs or appropriate query parameters to retrieve the desired details.
  • Data utilization: The returned data can be used for mandate management, customer service inquiries, or integrating with other systems.
  • Response handling: Be prepared to handle various response statuses, including 200 OK for successful retrievals and error codes for failed requests.