The Payment Initiation service in ANZ Fileactive APIs enables businesses to create and manage payments efficiently. This service allows the initiation of various types of payments, supporting a seamless and automated payment workflow directly integrated into business processes.

Where Payment initiation fits in the PayTo process flow:

The diagram below illustrates the steps involved in the PayTo process and highlights where Mandate Payment Initiation Request play a critical role:

PayTo Bilateral End to End Flow

Capabilities

  • Create payments: Initiate new payments, including domestic and international transactions, directly from your systems.
  • Flexible payment types: Supports a range of payment methods, including ACH, RTGS, and FAST payments, tailored to regional requirements.
  • Automated workflows: Streamlines payment processing through automated initiation and tracking of payment statuses.

Technical requirements

  • API Endpoint: /payto/v1/mpirs
  • Authentication: Requires OAuth 2.0 with Client Credential Grant flow for secure access.
  • Request Format: Payments are initiated using JSON-formatted requests, specifying payment details like beneficiary information, amount, and payment type.
  • Security: Utilizes OAuth 2.0 bearer tokens for authentication and secure communication.

Key features for developers

  • Robust payment creation: Easily create and submit payment requests with required details, including beneficiary information and payment amount.
  • Status tracking: Retrieve real-time status updates on initiated payments to ensure visibility and control over the payment lifecycle.
  • Error handling: Comprehensive error responses and messages help in identifying and resolving issues promptly.

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: POST /v1.0/payment/initiate (Initiate Payment, JSON Payload) ANZ API-->>Client: 202 Accepted (Payment Request Received) Note right of ANZ API: Processes payment and provides
status updates upon completion.

Usage notes

  • Payment details: Ensure all required payment details are accurately provided in the request payload to avoid processing delays.
  • Monitoring payments: Utilize the status tracking feature to monitor payment progress and handle any exceptions or rejections promptly.
  • Compliance and security: Always ensure that the payment information complies with relevant regulations and security standards, using encrypted communication and verified tokens.

General Rules

  • MPSUserSchemeRule1:
    • mps_user_id must be the owner of the provided mandate_identification.
  • InstructedAmountSchemeRule1:
    • instructed_amount must not exceed the maximum amount specified in the associated mandate (mandate_identification).
  • CreditorDetailsSchemeRule1:
    • creditor_information must be present if it is not provided in the mandate.
  • CreditorDetailsSchemeRule2:
    • creditor_information should not be present if already provided on the mandate.
  • CreditorDetailsSchemeRule3:
    • If creditor_information is provided and also available on the mandate, then the details must be exactly the same.