Assembly Payments PayTo Payments API

openapi: 3.2.0
info:
  title: PayTo Payments API
  description: '“PayTo” is a new digital payments service that allows NPP-enabled account holders to digitally pre-authorise one-off or recurring real-time payments from their bank account. This swagger document lists APIs for PayTo agreement creation, management and payment initiation.


    **Changes in 2.0 version**


    **Validate PayTo Agreement API/Amend PayTo Agreement Details API:**


    Depending on the business use-case for your platform, Zai will setup and enable the applicable payment parameters, frequencies, amount types and agreement types. If any particular frequency, parameter, amount type or agreement type is not enabled and is required for your business use-case, kindly contact Zai support to get it enabled.


    Payment frequency based validations:

    - Adhoc frequency: Adhoc agreements provides you the flexibility to debit your user’s account any time you see fit, however, in order to increase the chances of authorisation by your user, we recommend defining “count_per_period” parameter along with it. This would indicate the maximum number of payments that you intend to make. An adhoc frequency agreement without any additional payment parameters like “count_per_period” would be considered as an “Open” agreement.

    - Daily frequency: A day would indicate a period of 24 hours during which payments can be requested in consideration with other payment parameters like count per period.

    - Weekly frequency: A week would indicate a period of 7 days beginning with the agreement validity start date during which payments can be requested in consideration with other payment parameters like count per period.

    - Fortnightly frequency: A fortnight would indicate a period of 14 days beginning with the agreement validity start date during which payments can be requested in consideration with other payment parameters like count per period.

    - Monthly frequency: A month would start from the agreement validity start date and would end a day before the same date in the next month. Payments can be requested within these days in consideration with other payment parameters like count per period or point in time. Example - If agreement validity starts from 15th Jan 2024, the monthly period would be calculated as 15th Jan 2024 to 14th Feb 2024, 15th Feb 2024 to 14th Mar 2024 and so on.


    Payment parameter "point_in_time":

    - This parameter can be specified with frequency "Monthly" only.


    Bilateral amendments:

    - Payment terms like payment_amount_info, first_payment_info, last_payment_info, maximum_amount_info and point_in_time can be amended at any point; however, frequency and count_per_period can be amended only if no payments have been requested for the agreement yet.


    New error codes:

    - Added new error codes: PAYT-ERR-2032, PAYT-ERR-2033, PAYT-ERR-2034, PAYT-ERR-2035, PAYT-ERR-2323, PAYT-ERR-2324, PAYT-ERR-2325, PAYT-ERR-2328, PAYT-ERR-2329, PAYT-ERR-2330


    **Initiate PayTo Payment API:**


    New error codes:

    - Added new error codes: PAYT-ERR-2528, PAYT-ERR-2529, PAYT-ERR-2530'
  contact:
    name: Zai
    url: https://developer.hellozai.com/reference/overview
    email: support@hellozai.com
  version: 2.0-external
servers:
- url: ' https://au-0000.api.assemblypay.com/payto/'
  description: Production server and API
- url: https://sandbox.au-0000.api.assemblypay.com/payto/
  description: Sandbox (Pre-live) server and API
- url: https://virtserver.swaggerhub.com/AssemblyPlatforms/PayTo/2.0-external
  description: SwaggerHub API Auto Mocking
tags:


# --- truncated at 32 KB (58 KB total) ---
# Full source: https://artifacts.apis.io/assembly-payments/openapi/assembly-payments-payto-payments-api-openapi.yml