openapi: 3.2.0
info:
  title: PayTo Agreements 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. \n\n<u>**Changes in 1.4 version**</u>\n\n\n\nEnriching timestamp fields to include microseconds information - ”created_at” and ”updated_at” fields returned via our API & web hook notifications (agreement and payto payments payloads) will include microseconds in the timestamp. \n\nRevised timestamp format example - 2023-08-10 09:03:16.045622 \n\nError code updates - \n\n **Validate PayTo Agreement API:** \n- Added new error codes - PAYT-ERR-2029, PAYT-ERR-2030, PAYT-ERR-2031 \n- Removed error codes - PAYT-ERR-2026, PAYT-ERR-2024 \n\n **Amend PayTo Agreement Details API:** \n- Added new error codes - PAYT-ERR-2321, PAYT-ERR-2322 \n- Removed error codes - PAYT-ERR-2310, PAYT-ERR-2312 \n\n **Initiate PayTo Payment API:** \n- Added new error code - PAYT-ERR-2526\n\n\n<u>**Changes in 1.3 version**</u>\n\n\n**Payment Amount Validations:** \n\nZai will perform additional payment request compliance checks. This is to help minimise non-compliant payment requests. It is essential to continue to ensure PayTo payment requests are made according to the specified amounts, day/time, frequency, and with all other terms specified in the PayTo Agreement. \n\nPayment amount-related verifications will be performed for: \n- Usage and Variable Agreements: the payment requested must be within the maximum amount field and the amount field (which acts as the minimum amount field) i.e., if the agreement amount is between $50 and $75, the payment instruction amount must be within this range. \n\n Note - Consider specifying a maximum and minimum value amount, as the payment amount can differ each time. These limits may provide clarity for the end-customer and may minimise the probability of them receiving a warning message from their bank. \n- Fixed Agreements: payments initiated must match the agreed amount; i.e., if the agreement amount is $50, the payment instruction amount must also be $50 \n- Balloon Agreements: the fixed and final payment amounts will be checked. The final amount must be equal to or greater than the fixed amount. If it’s not, the payment request will be rejected. i.e., the agreement amount is $1,200 over 10 payments (9 fixed and 1 final payments) the fixed amount could be $100, and the final amount $300. \n\nRelevant error messages have also been added as part of this release around rejecting payments that are not compliant as per amount specified in the agreement.\n\n\n<u>**Changes in 1.2 version**</u>\n\n\n **New APIs:** \n- Get all PayTo Agreements for a user - This API lists all PayTo agreements associated with a particular user. If needed, the results can be filtered to list agreements for a particular status or for a particular type (AUPM/MGCR). \n- Get all PayTo Payment Initiation Requests for an agreement - This API lists all payment requests initiated for an agreement. If needed, the results can be filtered to list requests for a particular status. \n- Recall PayTo Agreement - If a custom expiry duration (anything less than 5 days) has been specified for an agreement creation/amendment request and if the debtor has not responded within the specified timeframe, this API should be used to recall such pending authorisation requests. Post successful recall, the request is considered cancelled and hence cannot be actioned by the debtor. \n\n Note - Agreement creation or Bilateral agreement amendments trigger authorisation requests waiting approval from debtor, which can be recalled via this API, if needed.\n\n **Validate PayTo Agreement API:** \n- New Optional Field: response_requested_by -> This field should be used to specify a custom expiry duration i.e. if the debtor authorisation request needs to be limited to any short duration which is less than the default duration of 5 days. \n- Updated Field Description: agreement_info.debtor_info.debtor_details.debtor_reference -> If end to end Id is not provided in the payment initiation request, then the debtor reference (if provided) in the agreement will be used as end to end identifier for the payments initiated via the agreement.\n\n **Initiate PayTo Payment API:** \n- Updated Field Description: payment_info.end_to_end_id -> If end to end Id is not provided in the payment initiation request, then the debtor reference (if provided) in the agreement will be used as end to end identifier for the payments initiated via the agreement. If debtor reference is also not available, default value “NOTPROVIDED” will set as end to end id for the payment initiation request.\n\n\n<u>**Changes in 1.1 version**</u>\n\n\n **Validate PayTo Agreement API:** \n- Support open ended agreements - For Adhoc frequency, providing point_in_time or count_per_period info is optional. \n- Reformatting debtor account number - During the agreement validation step, Zai may reformat the debtor account number as per the format expected by the payer institutions. Reformatted debtor account number can be accessed either via GET PayTo Agreement Details API after the validation step or via WAPI notification sent by Zai after successful agreement creation step.\n\n **Amend PayTo Agreement Details API:** \n- Ability to clear optional fields if needed using hyphen (-) character.\n\n **Amend PayTo Agreement Status API:** \n- Allow agreement status amendments even if a bilateral amendment is in progress. Example - If agreement details amendment is in progress, it should be possible to pause/suspend the agreement if needed.\n\n **Get PayTo Agreement Details API:** \n- New fields - Status reason code and Status reason description have been added in response. These fields will provide more details for suspended or cancelled agreements.\n\n **Get PayTo Payment Details API:** \n- New fields - Status reason code and Status reason description have been added in response. These fields will provide more details for rejected payments.\n\n **Misc:** \n- Agreement purpose codes have been elaborated to clarify the usage for each type. \n- Status descriptions returned in the GET APIs have been improved to provide more details about the current agreement status. \n- PAYT-ERR-2201, PAYT-ERR-2301 - error descriptions have been updated. \n- PAYT-ERR-2318 - added new error code along with description.\n"
  contact:
    name: Zai
    url: https://developer.hellozai.com/reference/overview
    email: support@hellozai.com
  version: 1.4-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/1.4-external
  description: SwaggerHub API Auto Mocking
tags:
- name: PayTo Agreements
  description: Agreement Management APIs
paths:
  /agreements/{agreement_uuid}/create:
    post:
      tags:
      - PayTo Agreements
      summary: Create PayTo Agreement
      description: "This operation creates the agreement with NPPA and hence must be invoked only after validating the agreement via the “Validate PayTo Agreement” operation.\n\n It should be invoked immediately once the agreement has been validated successfully and resolved PayID details are confirmed with the user.\n\n Agreement Creation will be successful only if it is performed within 5 minutes post successful validation.\n\n Post successful creation, agreement id (generated by NPPA) which uniquely identifies the agreement will be notified. \n\n Note - AUPM agreements will be ACTIVE only post debtor authorization. By default (if custom expiry duration is not provided via response_requested_by field), debtor will have 5 days to authorise the agreement, post which the authorization request will expire automatically and the agreement will be marked as CANCELLED.\n MGCR agreements will be ACTIVE immediately post creation however, payments can be initiated only after 5 calendar days."
      operationId: createAgreement
      parameters:
      - name: agreement_uuid
        in: path
        required: true
        schema:
          type: string
          example: d0c40d95-95b7-449b-9835-3c97c0386585
      responses:
        '401':
          description: "Unauthorised \n<table><tr><td><b>Error Code</b></td><td><b>Error Message</b></td></tr><tr><td>PAYT-ERR-1000</td><td>Invalid or missing authorisation token.</td></tr></table>"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayToErrorResponse'
              example:
                errors:
                - error_code: PAYT-ERR-1000
                  error_message: Invalid or missing authorisation token.
        '403':
          description: "Forbidden \n<table><tr><td><b>Error Code</b></td><td><b>Error Message</b></td></tr><tr><td>PAYT-ERR-1001</td><td>PayTo feature not available.</td></tr><tr><td>PAYT-ERR-1002</td><td>Request rejected: User associated with the agreement is not active.</td></tr></table>"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayToErrorResponse'
              example:
                errors:
                - error_code: PAYT-ERR-1001
                  error_message: PayTo feature not available.
        '404':
          description: "Not Found \n<table><tr><td><b>Error Code</b></td><td><b>Error Message</b></td></tr><tr><td>PAYT-ERR-2100</td><td>Agreement should be in VALIDATED state for creation.</td></tr></table>"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayToErrorResponse'
              example:
                errors:
                - error_code: PAYT-ERR-2100
                  error_message: Agreement should be in VALIDATED state for creation.
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateAgreementResponse'
        '400':
          description: "Bad Request \n \n <table><tr><td><b>Error Code</b></td><td><b>Error Message</b></td></tr><tr><td>PAYT-ERR-2102</td><td>Invalid format for url param: agreement_uuid.</td></tr></table>"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayToErrorResponse'
              example:
                errors:
                - error_code: PAYT-ERR-2102
                  error_message: 'Invalid format for url param: agreement_uuid.'
        '410':
          description: "Resource Unavailable \n<table><tr><td><b>Error Code</b></td><td><b>Error Message</b></td></tr><tr><td>PAYT-ERR-2101</td><td>Agreement creation is allowed only within a limited time period post validation. Please validate the agreement details again.</td></tr></table>"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayToErrorResponse'
              example:
                errors:
                - error_code: PAYT-ERR-2101
                  error_message: Agreement creation is allowed only within a limited time period post validation. Please validate the agreement details again.
        '500':
          description: "Internal Server Error \n<table><tr><td><b>Error Code</b></td><td><b>Error Message</b></td></tr><tr><td>PAYT-ERR-1003</td><td>An error occurred processing your request. Please try again.</td></tr></table>"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayToErrorResponse'
              example:
                errors:
                - error_code: PAYT-ERR-1003
                  error_message: An error occurred processing your request. Please try again.
      security:
      - bearerAuth: []
  /agreements/validate:
    post:
      tags:
      - PayTo Agreements
      summary: Validate PayTo Agreement
      description: "Validate PayTo agreement details before creation. This operation must be invoked first, followed by the “Create PayTo Agreement” operation.\n\n This operation validates the details of the agreements along with ensuring the debtor and creditor are NPP and PayTo reachable before the actual agreement creation with NPPA.\n\n PayID details provided for the debtor are also resolved as part of this operation. Customers should share the resolved PayID details with their users for confirmation before the actual agreement creation.\n\n Post successful validation, agreement UUID is returned in the response which uniquely identifies the agreement. This UUID should be used in subsequent API calls for that particular agreement.\n\n Note - Zai may reformat the debtor account number if it is not as per the format expected by payer institutions. Reformatted debtor account number can be accessed either via GET PayTo Agreement Details API after the validation step or via WAPI notification sent by Zai after successful agreement creation step."
      operationId: validateAgreement
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValidateAgreementRequest'
        required: true
      responses:
        '401':
          description: "Unauthorised \n<table><tr><td><b>Error Code</b></td><td><b>Error Message</b></td></tr><tr><td>PAYT-ERR-1000</td><td>Invalid or missing authorisation token.</td></tr></table>"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayToErrorResponse'
              example:
                errors:
                - error_code: PAYT-ERR-1000
                  error_message: Invalid or missing authorisation token.
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateAgreementResponse'
        '500':
          description: "Internal Server Error \n<table><tr><td><b>Error Code</b></td><td><b>Error Message</b></td></tr><tr><td>PAYT-ERR-1003</td><td>An error occurred processing your request. Please try again.</td></tr></table>"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayToErrorResponse'
              example:
                errors:
                - error_code: PAYT-ERR-1003
                  error_message: An error occurred processing your request. Please try again.
        '400':
          description: "Bad Request \n \n <table><tr><td><b>Error Code</b></td><td><b>Error Message</b></td></tr><tr><td>PAYT-ERR-1050</td><td>Mandatory info missing: [FieldName] cannot be null or empty.</td></tr><tr><td>PAYT-ERR-1051</td><td>Invalid Data: [FieldName] provided is invalid.</td></tr><tr><td>PAYT-ERR-1052</td><td>Invalid Data: [FieldName] provided should contain any of the values [Acceptable values].</td></tr><tr><td>PAYT-ERR-1053</td><td>Invalid Data: [FieldName] provided is invalid. Expected format [DateFormat].</td></tr><tr><td>PAYT-ERR-1054</td><td>Invalid Data: [FieldName] length is invalid. Expected minimum [MinLength] and maximum [MaxLength].</td></tr><tr><td>PAYT-ERR-1057</td><td>Unrecognized Field: [FieldName] is not a valid field.</td></tr><tr><td>PAYT-ERR-1058</td><td>Invalid Request: request provided is not well-formatted.</td></tr><tr><td>PAYT-ERR-2001</td><td>Either description or short_description should be provided.</td></tr><tr><td>PAYT-ERR-2002</td><td>Response_Requested_By date must be a future date and less than 5 days.</td></tr><tr><td>PAYT-ERR-2004</td><td>PayID details are not supported for migrated agreements.</td></tr><tr><td>PAYT-ERR-2005</td><td>validity_start_date should be either current date OR future date.</td></tr><tr><td>PAYT-ERR-2006</td><td>validity_end_date should be greater than OR same as validity_start_date.</td></tr><tr><td>PAYT-ERR-2008</td><td>validity_end_date should not be provided if agreement should be auto-renewed.</td></tr><tr><td>PAYT-ERR-2009</td><td>account_details in the request are invalid as per the account_type provided.</td></tr><tr><td>PAYT-ERR-2010</td><td>Either account (bsb/account number) or PayID details should be provided.</td></tr><tr><td>PAYT-ERR-2011</td><td>Invalid PayID format for the PayID type provided.</td></tr><tr><td>PAYT-ERR-2013</td><td>debtor_id_type is mandatory along with debtor_id.</td></tr><tr><td>PAYT-ERR-2014</td><td>Invalid debtor_id_type for the debtor_type provided.</td></tr><tr><td>PAYT-ERR-2015</td><td>Date provided in first_payment_info should be between validity_start_date and validity_end_date OR can be same as validity_start_date and validity_end_date.</td></tr><tr><td>PAYT-ERR-2016</td><td>Date provided in last_payment_info should be between validity_start_date and validity_end_date OR can be same as validity_start_date and validity_end_date.</td></tr><tr><td>PAYT-ERR-2018</td><td>payment_amount should be less than maximum amount.</td></tr><tr><td>PAYT-ERR-2019</td><td>Amount provided in last_payment_info should be less than or equal to maximum amount.</td></tr><tr><td>PAYT-ERR-2020</td><td>Amount provided in first_payment_info should be less than or equal to maximum amount.</td></tr><tr><td>PAYT-ERR-2021</td><td>Date provided in last_payment_info should be same OR after the date provided in first_payment_info.</td></tr><tr><td>PAYT-ERR-2025</td><td>Incorrect value provided for either of these fields - frequency, point_in_time, count_per_period. The combination provided should be valid.</td></tr><tr><td>PAYT-ERR-2027</td><td>Active direct debit agreement which needs to be migrated does not exist for the user.</td></tr><tr><td>PAYT-ERR-2028</td><td>Response_Requested_By is applicable only for AUPM agreements with 'ATTENDED' priority type.</td></tr><tr><td>PAYT-ERR-2029</td><td>For FIXE/BALN type of agreements, specifying payment amount is mandatory.</td></tr><tr><td>PAYT-ERR-2030</td><td>For FIXE/BALN type of agreements, specifying maximum amount is not applicable.</td></tr><tr><td>PAYT-ERR-2031</td><td>Invalid Data: Please provide info for all parameters under agreement_info.payment_terms.maximum_amount_info</td></tr></table>"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayToErrorResponse'
              example:
                errors:
                - error_code: PAYT-ERR-2001
                  error_message: Either 'description' or 'short_description' should be provided.
                - error_code: PAYT-ERR-2005
                  error_message: validity_start_date must be future dated.
        '403':
          description: "Forbidden \n<table><tr><td><b>Error Code</b></td><td><b>Error Message</b></td></tr><tr><td>PAYT-ERR-1001</td><td>PayTo feature not available.</td></tr><tr><td>PAYT-ERR-1004</td><td>User with provided user_external_id does not exist.</td></tr></table>"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayToErrorResponse'
              example:
                errors:
                - error_code: PAYT-ERR-1001
                  error_message: PayTo feature not available.
        '404':
          description: "Not Found \n<table><tr><td><b>Error Code</b></td><td><b>Error Message</b></td></tr><tr><td>PAYT-ERR-2000</td><td>Active user with provided user_external_id does not exist.</td></tr></table>"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayToErrorResponse'
              example:
                errors:
                - error_code: PAYT-ERR-2000
                  error_message: Active user with provided user_external_id does not exist.
      security:
      - bearerAuth: []
  /agreements/{agreement_uuid}/status:
    patch:
      tags:
      - PayTo Agreements
      summary: Amend PayTo Agreement Status
      description: 'Amend Status of a particular agreement via its UUID. Below status amends are possible via this API:

        - ACTIVE -> SUSPENDED

        - ACTIVE -> CANCELLED

        - SUSPENDED -> ACTIVE (only if suspended via Zai)

        - SUSPENDED -> CANCELLED


        Only one status amendment is allowed at any given point of time. Example - If a request to suspend the agreement is already in progress, another status change request will not be accepted until the first completes.


        Resuming a suspended agreement can only be performed by the party that suspended the agreement.


        Hence, moving the agreement from SUSPENDED to ACTIVE will be accepted only if the Suspension was performed via Zai. CANCELLED is final agreement status and hence is irreversible.'
      operationId: amendAgreementStatus
      parameters:
      - name: agreement_uuid
        in: path
        required: true
        schema:
          type: string
          example: d0c40d95-95b7-449b-9835-3c97c0386585
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AmendAgreementStatusRequest'
        required: true
      responses:
        '401':
          description: "Unauthorised \n<table><tr><td><b>Error Code</b></td><td><b>Error Message</b></td></tr><tr><td>PAYT-ERR-1000</td><td>Invalid or missing authorisation token.</td></tr></table>"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayToErrorResponse'
              example:
                errors:
                - error_code: PAYT-ERR-1000
                  error_message: Invalid or missing authorisation token.
        '409':
          description: "Conflict \n<table><tr><td><b>Error Code</b></td><td><b>Error Message</b></td></tr><tr><td>PAYT-ERR-2201</td><td>A status amendment for this agreement is already in progress. Please try again later.</td></tr></table>"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayToErrorResponse'
              example:
                errors:
                - error_code: PAYT-ERR-2201
                  error_message: An amendment for this agreement is already in progress. Please try again later.
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AmendAgreementStatusResponse'
        '400':
          description: "Bad Request \n \n <table><tr><td><b>Error Code</b></td><td><b>Error Message</b></td></r><tr><td>PAYT-ERR-1050</td><td>Mandatory info missing: [FieldName] cannot be null or empty.</td></tr><tr><td>PAYT-ERR-1051</td><td>Invalid Data: [FieldName] provided is invalid.</td></tr><tr><td>PAYT-ERR-1052</td><td>Invalid Data: [FieldName] provided should contain any of the values [Acceptable values].</td></tr><tr><td>PAYT-ERR-1054</td><td>Invalid Data: [FieldName] length is invalid. Expected minimum [MinLength] and maximum [MaxLength].</td></tr><tr><td>PAYT-ERR-1057</td><td>Unrecognized Field: [FieldName] is not a valid field.</td></tr><tr><td>PAYT-ERR-1058</td><td>Invalid Request: request provided is not well-formatted.</td></tr><tr><td>PAYT-ERR-2202</td><td>Amendment request rejected: Invalid status change requested.</td></tr><tr><td>PAYT-ERR-2203</td><td>Reason code is mandatory while suspending or cancelling an agreement.</td></tr></table>"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayToErrorResponse'
              example:
                errors:
                - error_code: PAYT-ERR-2202
                  error_message: 'Amendment request rejected: Invalid status change requested.'
                - error_code: PAYT-ERR-2203
                  error_message: Reason code is mandatory while suspending or cancelling an agreement.
        '403':
          description: "Forbidden \n<table><tr><td><b>Error Code</b></td><td><b>Error Message</b></td></tr><tr><td>PAYT-ERR-1001</td><td>PayTo feature not available.</td></tr><tr><td>PAYT-ERR-1002</td><td>Request rejected: User associated with the agreement is not active.</td></tr><tr><td>PAYT-ERR-2204</td><td>Agreement can be resumed only by the same party who suspended it.</td></tr></table>"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayToErrorResponse'
              example:
                errors:
                - error_code: PAYT-ERR-1001
                  error_message: PayTo feature not available.
        '500':
          description: "Internal Server Error \n<table><tr><td><b>Error Code</b></td><td><b>Error Message</b></td></tr><tr><td>PAYT-ERR-1003</td><td>An error occurred processing your request. Please try again.</td></tr></table>"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayToErrorResponse'
              example:
                errors:
                - error_code: PAYT-ERR-1003
                  error_message: An error occurred processing your request. Please try again.
        '404':
          description: "Not Found \n<table><tr><td><b>Error Code</b></td><td><b>Error Message</b></td></tr><tr><td>PAYT-ERR-2200</td><td>Agreement with provided uuid does not exist.</td></tr></table>"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayToErrorResponse'
              example:
                errors:
                - error_code: PAYT-ERR-2200
                  error_message: Agreement with provided uuid does not exist.
      security:
      - bearerAuth: []
  /agreements/{agreement_uuid}/recall:
    patch:
      tags:
      - PayTo Agreements
      summary: Recall PayTo Agreement
      description: "This operation is to recall a pending agreement creation/bilateral amendment authorisation request before it is approved by debtor. By default, all debtor authorization requests expire after 5 days post creation. If a custom expiry duration (anything less than 5 days) has been specified in the request via “response_requested_by” field, then this Recall API should be invoke to expire the authorisation request post the custom duration has elapsed.\n\n Example - For a use-case, if the debtor should approve/reject the agreement within 15 mins post creation, and if the debtor does not respond within 15 mins, this API should be invoked to recall the agreement creation action post 15 mins.\n\nRecall Agreement Creation - If a custom expiry duration is specified during agreement validation step, this API should be used to recall the pending agreement creation authorisation request.\n- Allows recalling agreement authorisation request only for AUPM agreement type.\n- After the recall operation is successful, the current agreement would be considered as CANCELLED and a new agreement should be created to seek the debtor’s approval again.\n\nRecall Bilateral Amendment Request - If a custom expiry duration is specified during bilateral agreement amendment, this API should be used to recall the pending amendment authorisation request.\n- Allows recalling amendment authorisation requests for both AUPM and MGCR agreement types.\n- After the recall operation is successful, the bilateral amendments are discarded and the agreement is not updated. If the changes are still needed, a new amendment request should be created to seek the debtor’s approval again.\n"
      operationId: recallAgreementAction
      parameters:
      - name: agreement_uuid
        in: path
        required: true
        schema:
          type: string
          example: d0c40d95-95b7-449b-9835-3c97c0386585
      responses:
        '401':
          description: "Unauthorised \n<table><tr><td><b>Error Code</b></td><td><b>Error Message</b></td></tr><tr><td>PAYT-ERR-1000</td><td>Invalid or missing authorisation token.</td></tr></table>"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayToErrorResponse'
              example:
                errors:
                - error_code: PAYT-ERR-1000
                  error_message: Invalid or missing authorisation token.
        '404':
          description: "Not Found \n<table><tr><td><b>Error Code</b></td><td><b>Error Message</b></td></tr><tr><td>PAYT-ERR-2500</td><td>Agreement with provided uuid does not exist.</td></tr></table>"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayToErrorResponse'
              example:
                errors:
                - error_code: PAYT-ERR-2500
                  error_message: Agreement with provided uuid does not exist.
        '403':
          description: "Forbidden \n<table><tr><td><b>Error Code</b></td><td><b>Error Message</b></td></tr><tr><td>PAYT-ERR-1001</td><td>PayTo feature not available.</td></tr><tr><td>PAYT-ERR-1002</td><td>Request rejected: User associated with the agreement is not active.</td></tr></table>"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayToErrorResponse'
              example:
                errors:
                - error_code: PAYT-ERR-1001
                  error_message: PayTo feature not available.
        '400':
          description: "Bad Request \n \n <table><tr><td><b>Error Code</b></td><td><b>Error Message</b></td></tr><tr><td>PAYT-ERR-2502</td><td>Recall request rejected: Recall action is applicable only for agreements in CREATED/ACTIVE/SUSPENDED statuses.</td></tr><tr><td>PAYT-ERR-2503</td><td>Request to recall agreement creation is already in progress. Please try again later.</td></tr><tr><td>PAYT-ERR-2504</td><td>Recall request rejected: Any bilateral amendment is not in progress for the agreement.</td></tr><tr><td>PAYT-ERR-2505</td><td>Recall request rejected: Request to recall bilateral amendment is already in progress for the agreement. Please try again later.<tr><td>PAYT-ERR-2506</td><td>Recall request rejected: Existing bilateral amendment request cannot be recalled at the moment. Please try again later.</td></tr><tr><td>PAYT-ERR-2508</td><td>Invalid format for url param: agreement_uuid.</td></tr></table>"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayToErrorResponse'
              example:
                errors:
                - error_code: PAYT-ERR-2502
                  error_message: 'Recall request rejected: Recall action is applicable only for agreements in CREATED/ACTIVE/SUSPENDED statuses.'
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecallAgreementActionResponse'
        '500':
          description: "Internal Server Error \n<table><tr><td><b>Error Code</b></td><td><b>Error Message</b></td></tr><tr><td>PAYT-ERR-1003</td><td>An error occurred processing your request. Please try again.</td></tr></table>"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayToErrorResponse'
              example:
                errors:
                - error_code: PAYT-ERR-1003
                  error_message: An error occurred processing your request. Please try again.
      security:
      - bearerAuth: []
  /agreements/{agreement_uuid}/amend:
    patch:
      tags:
      - PayTo Agreements
      summary: Amend PayTo Agreement Details
      description: 'Amend details of a particular agreement via its UUID. There are two types of amendments possible via this operation:

        - Unilateral amendments - which does not need debtor approval and will be effective immediately

        - Bilateral amendments - which does require debtor approval and will be effective post debtor authorisation


        Optional fields can also be cleared via an amend request if needed. Passing an hyphen(-) character for any optional field would indicate its value needs to be cleared.


        Either unilateral or bilateral amendments will be accepted in an amendment request. Both types of amendments cannot be provided in a single request.


        At any given point of time, only a single unilateral or a single bilateral amendment will be allowed. Example - If a bilateral amendment is already in progress, another bilateral amendment request will not be accepted until the first completes.


        Unilateral details that can be amended:

        - description

        - short_description

        - creditor_info

        - payment_initiator_info


        Bilateral details that can be amended:

        - validity_end_date

        - transfer_arrangement

        - automatic_renewal

        - payment_terms - all fields


        Note - Bilateral amendments will be effective only post debtor authorization. Debtor should authorize the amendments within 5 days (default duration) or within the custom expiry duration (response_requested_by) specified in the amendment request.'
      operationId: amendAgreementDetails
      parameters:
      - name: agreement_uuid
        in: path
        required: true
        schema:
          type: string
          example: d0c40d95-95b7-449b-9835-3c97c0386585
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AmendAgreementDetailsRequest'
        required: true
      responses:
        '401':
          description: "Unauthorised \n<table><tr><td><b>Error Code</b></td><td><b>Error Message</b></td></tr><tr><td>PAYT-ERR-1000</td><td>Invalid or missing authorisation token.</td></tr></table>"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayToErrorResponse'
              example:
                errors:
                - error_code: PAYT-ERR-1000
                  error_message: Invalid or missing authorisation token.
        '400':
          description: "Bad Request \n \n <table><tr><td><b>Error Code</b></td><td><b>Error Message</b></td></r><tr><td>PAYT-ERR-1050</td><td>Mandatory info missing: [FieldName] cannot be null or empty.</td></tr><tr><td>PAYT-ERR-1051</td><td>Invalid Data: [FieldName] provided is invalid.</td></tr><tr><td>PAYT-ERR-1052</td><td>Invalid Data: [FieldName] provided should contain any of the values [Acceptable values].</td></tr><tr><td>PAYT-ERR-1053</td><td>Invalid Data: [FieldName] provided is invalid. Expected format [DateFormat].</td></tr><tr><td>PAYT-ERR-1054</td><td>Invalid Data: [FieldName] length is invalid. Expected minimum [MinLength] and maximum [MaxLength].</td></tr><tr><td>PAYT-ERR-1057</td><td>Unrecognized Field: [FieldName] is not a valid field.</td></tr><tr><td>PAYT-ERR-1058</td><td>Invalid Request: request provided is not well-formatted.</td></tr><tr><td>PAYT-ERR-2002</td><td>Response_Requested_By date must be a future date and less than 5 days.</td></tr><tr><td>PAYT-ERR-2019</td><td>Amount provided in last_payment_info should be less than or equal to maximum amount.</td></tr><tr><td>PAYT-ERR-2020</td><td>Amount provided in first_payment_info should be less than or equal to maximum amount.</td></tr><tr><td>PAYT-ERR-2302</td><td>Either unilateral or bilateral amendments can be requested.</td></tr><tr><td>PAYT-ERR-2303</td><td>Details can be amended for 'ACTIVE' or 'SUSPENDED' agreements only.</td></tr><tr><td>PAYT-ERR-2304</td><td>Either description or short_description is mandatory for an agreement.</td></tr><tr><td>PAYT-ERR-2305</td><td>validity_end_date should not be provided if agreement should be auto-renewed.</td></tr><tr><td>PAYT-ERR-2306</td><td>validity_end_date should be greater than OR same as validity_start_date.</td></tr><tr><td>PAYT-ERR-2307</td><td>Date provided in last_payment_info should be same OR after the date provided in first_payment_info.</td></tr><tr><td>PAYT-ERR-2308</td><td>Date provided in first_payment_info should be between validity_start_date and validity_end_date OR can be same as validity_start_date and validity_end_date.</td></tr><tr><td>PAYT-ERR-2309</td><td>Date provided in last_payment_info should be between validity_start_date and validity_end_date OR can be same as validity_start_date and validity_end_date.</td></tr><tr><td>PAYT-ERR-2311</td><td>Incorrect value provided for either of these fields - frequency, point_in_time, count_per_period. The combination provided should be valid.</td></tr><tr><td>PAYT-ERR-2313</td><td>Amount provided in last_payment_info should be less than or equal to maximum amount.</td></tr><tr><td>PAYT-ERR-2314</td><td>Amount provided in first_payment_info should be less than or equal to maximum amount.</td></tr><tr><td>PAYT-ERR-2315</td><td>payment_amount should be less than maximum amount.</td></tr><tr><td>PAYT-ERR-2316</td><td>Invalid Request: At least one field should be provided for amendment.</td></tr><tr><td>PAYT-ERR-2318</td><td>Invalid Request: Values provided for few fields is same as existing. Please provide correct info for amendment.</td></tr><tr><td>PAYT-ERR-2319</td><td>A unilateral amendment for this agreement is already in progress. Please try again later.</td></tr><tr><td>PAYT-ERR-2320</td><td>Response_Requested_By is applicable only for bilateral amendment requests with 'ATTENDED' priority type.</td></tr><tr><td>PAYT-ERR-2321</td><td>For FIXE/BALN type of agreements, specifying payment amount is mandatory.</td></tr><tr><td>PAYT-ERR-2322</td><td>For FIXE/BALN type of agreements, specifying maximum amount is not applicable.</td></tr></table>"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayToErrorResponse'
              example:
                errors:
                - error_code: PAYT-ERR-2302
                  error_message: Either unilateral or bilateral amendments can be requested.
                - error_code: PAYT-ERR-2303
                  error_message: Details can be amended for ACTIVE or SUSPENDED agreements only.
        '403':
          description: "Forbidden \n<table><tr><td><b>Error Code</b></td><td><b>Error Message</b></td></tr><tr><td>PAYT-ERR-1001</td><td>PayTo feature not available.</td></tr><tr><td>PAYT-ERR-1002</td><td>Request rejected: User associated with the agreement is not active.</td></tr></table>"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayToErrorResponse'
              example:
                errors:
                - error_code: PAYT-ERR-1001
                  error_message: PayTo feature not available.
        '409':
          description: "Conflict \n<table><tr><td><b>Error Code</b></td><td><b>Error Message</b></td></tr><tr><td>PAYT-ERR-2301</td><td>A bilateral amendment for this agreement is already in progress. Please try again later.</td></tr><tr><td>PAYT-ERR-2319</td><td>A unilateral amendment for this agreement is already in progress. Please try again later.</td></tr></table>"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayToErrorResponse'
              example:
                errors:
                - error_code: PAYT-ERR-2301
                  error_message: An amendment for this agreement is already in progress. Please try again later.
        '500':
          description: "Internal Server Error \n<table><tr><td><b>Error Code</b></td><td><b>Error Message</b></td></tr><tr><td>PAYT-ERR-1003</td><td>An error occurred processing your request. Please try again.</td></tr></table>"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayToErrorResponse'
              example:
                errors:
                - error_code: PAYT-ERR-1003
                  error_message: An error occurred processing your request. Please try again.
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AmendAgreementDetailsResponse'
        '404':
          description: "Not Found \n<table><tr><td><b>Error Code</b></td><td><b>Error Message</b></td></tr><tr><td>PAYT-ERR-2300</td><td>Agreement with provided uuid does not exist.</td></tr></table>"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayToErrorResponse'
              example:
                errors:
                - error_code: PAYT-ERR-2300
                  error_message: Agreement with provided uuid does not exist.
      security:
      - bearerAuth: []
  /agreements/{agreement_uuid}:
    get:
      tags:
      - PayTo Agreements
      summary: Get PayTo Agreement Details
      description: "Retrieve details of a PayTo agreement by UUID which uniquely identifies the agreement.\n This UUID is returned as part of the “Validate PayTo Agreement” operation.\n\n It provides complete details of a particular agreement irrespective of its current status "
      operationId: getAgreementDetails
      parameters:
      - name: agreement_uuid
        in: path
        required: true
        schema:
          type: string
          example: d0c40d95-95b7-449b-9835-3c97c0386585
      responses:
        '400':
          description: "Bad Request \n \n <table><tr><td><b>Error Code</b></td><td><b>Error Message</b></td></r><tr><td>PAYT-ERR-2401</td><td>Invalid format for url param: agreement_uuid.</td></tr></table>"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayToErrorResponse'
              example:
                errors:
                - error_code: PAYT-ERR-2401
                  error_message: 'Invalid format for url param: agreement_uuid.'
        '401':
          description: "Unauthorised \n<table><tr><td><b>Error Code</b></td><td><b>Error Message</b></td></tr><tr><td>PAYT-ERR-1000</td><td>Invalid or missing authorisation token.</td></tr></table>"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayToErrorResponse'
              example:
                errors:
                - error_code: PAYT-ERR-1000
                  error_message: Invalid or missing authorisation token.
        '500':
          description: "Internal Server Error \n<table><tr><td><b>Error Code</b></td><td><b>Error Message</b></td></tr><tr><td>PAYT-ERR-1003</td><td>An error occurred processing your request. Please try again.</td></tr></table>"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayToErrorResponse'
              example:
                errors:
                - error_code: PAYT-ERR-1003
                  error_message: An error occurred processing your request. Please try again.
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgreementDetailsResponse'
        '403':
          description: "Forbidden \n<table><tr><td><b>Error Code</b></td><td><b>Error Message</b></td></tr><tr><td>PAYT-ERR-1001</td><td>PayTo feature not available.</td></tr></table>"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayToErrorResponse'
              example:
                errors:
                - error_code: PAYT-ERR-1001
                  error_message: PayTo feature not available.
        '404':
          description: "Not Found \n<table><tr><td><b>Error Code</b></td><td><b>Error Message</b></td></tr><tr><td>PAYT-ERR-2400</td><td>Agreement with provided uuid does not exist.</td></tr></table>"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayToErrorResponse'
              example:
                errors:
                - error_code: PAYT-ERR-2400
                  error_message: Agreement with provided uuid does not exist.
      security:
      - bearerAuth: []
  /agreements:
    get:
      tags:
      - PayTo Agreements
      summary: Get All PayTo Agreements for a User
      description: " This operation is to retrieve all PayTo agreements associated with a particular user in the provided period (date range). Agreements can be retrieved for a maximum period of one year or less at a time i.e. the period between start and end date cannot exceed more than one year.\n\n By default, all agreements will be returned irrespective of status and type (AUPM/MGCR).\n\n However, if required, results can be filtered for a particular status or agreement type. Example - Retrieve all suspended and cancelled migrated agreements.\n\nRequest parameter descriptions:\n \n - user_external_id - Unique identifier of the user that is associated with the agreement.\n - status - List of valid agreement statuses. Example - Retrieve active and suspended agreements only.\n   - Valid values - PENDING_VALIDATION, VALIDATED, PENDING_CREATION, CREATED, ACTIVE, SUSPENDED, CANCELLED\n - agreement_type -  List of valid agreement types. Example - Retrieve only migrated agreements.\n   - Valid values - AUPM, MGCR\n - start_date - Date range start, example - fetch all agreements created between June to December 2022.\n - end_date - Date range end, example - fetch all agreements created between June to December 2022.\n - size - Number of agreements per page. Default value is 20.\n - page - Page number. Default value is 0."
      operationId: getAgreementsByUser
      parameters:
      - name: user_external_id
        in: query
        required: true
        schema:
          type: string
          example: buyer-147043828
      - name: status
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
            enum:
            - PENDING_VALIDATION
            - VALIDATED
            - PENDING_CREATION
            - CREATED
            - ACTIVE
            - SUSPENDED
            - CANCELLED
          enum:
          - PENDING_VALIDATION
          - VALIDATED
          - PENDING_CREATION
          - CREATED
          - ACTIVE
          - SUSPENDED
          - CANCELLED
      - name: agreement_type
        in: query
        required: false
        schema:
          type: string
          example: AUPM
      - name: start_date
        in: query
        required: true
        schema:
          type: string
          example: '2022-10-15'
      - name: end_date
        in: query
        required: true
        schema:
          type: string
          example: '2023-10-15'
      - name: size
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 20
      - name: page
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 0
      responses:
        '400':
          description: "Bad Request \n \n <table><tr><td><b>Error Code</b></td><td><b>Error Message</b></td></r><tr><td>PAYT-ERR-1051</td><td>Invalid Data: [FieldName] provided is invalid.</td></tr><tr><td>PAYT-ERR-1052</td><td>Invalid Data: [FieldName] provided should contain any of the values [Acceptable values].</td></tr><tr><td>PAYT-ERR-1053</td><td>Invalid Data: [FieldName] provided is invalid. Expected format [DateFormat].</td></tr><tr><td>PAYT-ERR-1058</td><td>Invalid Request: request provided is not well-formatted.</td></tr><tr><td>PAYT-ERR-4000</td><td>end_date should be greater than start_date.</td></tr><tr><td>PAYT-ERR-4001</td><td>Period between start_date and end_date cannot exceed 1 year.</td></tr></table>"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayToErrorResponse'
              example:
                errors:
                - error_code: PAYT-ERR-1051
                  error_message: 'Invalid Data: user_external_id provided is invalid.'
        '401':
          description: "Unauthorised \n<table><tr><td><b>Error Code</b></td><td><b>Error Message</b></td></tr><tr><td>PAYT-ERR-1000</td><td>Invalid or missing authorisation token.</td></tr></table>"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayToErrorResponse'
              example:
                errors:
                - error_code: PAYT-ERR-1000
                  error_message: Invalid or missing authorisation token.
        '500':
          description: "Internal Server Error \n<table><tr><td><b>Error Code</b></td><td><b>Error Message</b></td></tr><tr><td>PAYT-ERR-1003</td><td>An error occurred processing your request. Please try again.</td></tr></table>"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayToErrorResponse'
              example:
                errors:
                - error_code: PAYT-ERR-1003
                  error_message: An error occurred processing your request. Please try again.
        '403':
          description: "Forbidden \n<table><tr><td><b>Error Code</b></td><td><b>Error Message</b></td></tr><tr><td>PAYT-ERR-1001</td><td>PayTo feature not available.</td></tr></table>"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayToErrorResponse'
              example:
                errors:
                - error_code: PAYT-ERR-1001
                  error_message: PayTo feature not available.
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgreementListResponse'
      security:
      - bearerAuth: []
components:
  schemas:
    FirstPaymentInformation:
      type: object
      properties:
        amount:
          maxLength: 19
          minLength: 1
          pattern: ^(?=.{1,19}$)[1-9]{1}[0-9]{0,18}$
          type: string
          description: "Specifies an amount in cents.\n\n\n   - For FIXE type of agreements, as the amount to be debited is fixed, this indicates the amount to be debited per payment.\n   - For BALN type of agreements, as the amount to be debited is fixed for all payments (except the last/final payment which can be for a larger amount), this field indicates the amount to be debited for all payments except the final/last.\n   - For USGB/VARI type of agreements, this indicates the minimum amount that can be debited from the account per payment."
          example: '1500'
        currency:
          pattern: ^[A-Z]{3,3}$
          type: string
          description: 'A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".


            Currency of the payment to debit the account.'
          example: AUD
          enum:
          - '{AUD}'
        date:
          pattern: ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)$
          type: string
          description: 'A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.


            If the payment arrangement being established specifies the first date (until 23:59:59.999 Australia Sydney time, expressed in the YYYY-MM-DD format) on which payment is expected to be initiated, that date should be specified in this field.'
          example: '2022-04-15'
      description: "If the payment arrangement is such that the initial payment amount differs from the expected \"regular\" or \"recurring\" payment, then the first payment info can be specified in this field. Examples: Establishment fees are part of the first payment only. \n \n **Property descriptions**: \n \n - **amount**\n   - For FIXE type of agreements, as the amount to be debited is fixed, this indicates the amount to be debited per payment.\n   - For BALN type of agreements, as the amount to be debited is fixed for all payments (except the last/final payment which can be for a larger amount), this field indicates the amount to be debited for all payments except the final/last.\n   - For USGB/VARI type of agreements, this indicates the minimum amount that can be debited from the account per payment.\n - **currency** - Currency of the payment to debit the account.\n - **date** - If the payment arrangement being established specifies the first date (until 23:59:59.999 Australia Sydney time, expressed in the YYYY-MM-DD format) on which payment is expected to be initiated, that date should be specified in this field."
    PaymentAmountInformation:
      type: object
      properties:
        amount:
          maxLength: 19
          minLength: 1
          pattern: ^(?=.{1,19}$)[1-9]{1}[0-9]{0,18}$
          type: string
          description: "Specifies an amount in cents.\n\n\n   - For FIXE type of agreements, as the amount to be debited is fixed, this indicates the amount to be debited per payment.\n   - For BALN type of agreements, as the amount to be debited is fixed for all payments (except the last/final payment which can be for a larger amount), this field indicates the amount to be debited for all payments except the final/last.\n   - For USGB/VARI type of agreements, this indicates the minimum amount that can be debited from the account per payment."
          example: '1000'
        currency:
          pattern: ^[A-Z]{3,3}$
          type: string
          description: 'A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".


            Currency of the payment to debit the account.'
          example: AUD
          enum:
          - '{AUD}'
        type:
          title: PaymentAmountType
          type: string
          description: <p>Specific type of payment amount.</p><p>Depending on the use-case for which the payment arrangement is being made, an appropriate amount type should be selected for the agreement as this defines the payments that can be initiated via the agreement.</p> <table><tr><td>Code</td><td>Name</td><td>Description</td></tr><tr><td>FIXE</td><td>Fixed</td><td>Payments should be initiated for fixed amounts i.e. amount specified in the payment instruction must match the “amount” stated in the agreement.</td></tr><tr><td>BALN</td><td>Balloon</td><td>Payments should be initiated for fixed amounts with large final payment amount i.e. for all the payments except the last, amount specified in the payment instruction must match the “amount” stated in the agreement. The last payment can be different and as per terms mentioned in the last payment amount fields (if specified).</td></tr><tr><td>USGB</td><td>UsageBased</td><td>If the amount for the payment varies with usage (example - electricity bill), it is recommended to specify a max amount. If a value is specified in the “amount” field, this would be considered as base/min amount to be paid for each payment. Payments should be initiated as per agreement terms i.e. the amount specified in the payment instruction should be within the “amount” (min) and “maximum amount” stated in the agreement.</td></tr><tr><td>VARI</td><td>Variable</td><td>If the amount for the payment varies each time (example - grocery purchase billing), it is recommended to specify a max amount. If a value is specified in the “amount” field, this would be considered as base/min amount to be paid for each payment. Payments should be initiated as per agreement terms i.e. the amount specified in the payment instruction should be within the “amount” (min) and “maximum amount” stated in the agreement.</td></tr></table>
          enum:
          - BALN
          - FIXE
          - USGB
          - VARI
      description: "Specifies info around the amount type for the agreement (example: Fixed or Usage based amounts etc), amount that can be debited from the account depending on the type, and the currency in which the payments can be initiated. \n \n **Property descriptions**: \n \n - **amount**\n   - For FIXE type of agreements, as the amount to be debited is fixed, this indicates the amount to be debited per payment.\n   - For BALN type of agreements, as the amount to be debited is fixed for all payments (except the last/final payment which can be for a larger amount), this field indicates the amount to be debited for all payments except the final/last.\n   - For USGB/VARI type of agreements, this indicates the minimum amount that can be debited from the account per payment.\n - **currency** - Currency of the payment to debit the account.\n - **type** - Depending on the use-case for which the payment arrangement is being made, an appropriate amount type should be selected for the agreement as this defines the payments that can be initiated via the agreement.\n   Supported values: \n   - FIXE - Payments should be initiated for fixed amounts i.e. amount specified in the payment instruction must match the “amount” stated in the agreement.\n   - BALN - Payments should be initiated for fixed amounts with large final payment amount i.e. for all the payments except the last, amount specified in the payment instruction must match the “amount” stated in the agreement. The last payment can be different and as per terms mentioned in the last payment amount fields (if specified).\n   - USGB - If the amount for the payment varies with usage (example - electricity bill), it is recommended to specify a max amount. If a value is specified in the “amount” field, this would be considered as base/min amount to be paid for each payment. Payments should be initiated as per agreement terms i.e. the amount specified in the payment instruction should be within the “amount” (min) and “maximum amount” stated in the agreement.\n   - VARI - If the amount for the payment varies each time (example - grocery purchase billing), it is recommended to specify a max amount. If a value is specified in the “amount” field, this would be considered as base/min amount to be paid for each payment. Payments should be initiated as per agreement terms i.e. the amount specified in the payment instruction should be within the “amount” (min) and “maximum amount” stated in the agreement."
    ValidateAgreementRequest:
      required:
      - agreement_info
      - priority
      - user_external_id
      type: object
      properties:
        user_external_id:
          maxLength: 254
          minLength: 1
          type: string
          description: 'Specifies a character string


            Unique id of the user (created via Create User API) with whom the agreement should be associated with.'
          example: buyer-147043828
        priority:
          title: Priority
          type: string
          description: "<p>Priority of the agreement creation/amendment authorisation notification to be sent to the user for approval.</p> \n<table><tr><td>Code</td><td>Description</td></tr><tr><td>ATTENDED</td><td>If the marketplace wants the debtor user to be notified about the agreement creation/amendment authorisation action immediately, the priority should be set as Attended.</td></tr><tr><td>UNATTENDED</td><td>If the marketplace wants the debtor user to be notified about the agreement creation/amendment authorisation at an appropriate time (not immediately), the priority should be set as Unattended.</td></tr></table>"
          enum:
          - ATTENDED
          - UNATTENDED
        response_requested_by:
          pattern: ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.[0-9]{1,3})?(?:Z)$
          type: string
          description: 'A date expressed in the YYYY-MM-DD''T''HH:mm:ss[.SSS][.SS][.S]''Z'' format and in Australia timezone.


            This field can be used to specify a custom expiry duration for the authorisation request pending debtor’s approval. Any duration which is less than the default & max duration of 5 days will be accepted. Example - If you want the debtor to approve the agreement within 15 mins post creation, mention the duration in this field accordingly. However, post the duration (after 15 mins), you would need to invoke the Recall API to expire this authorisation request.'
          format: yyyy-MM-dd'T'HH:mm:ss[.SSS][.SS][.S]'Z'
          example: '2022-11-04T06:24:34.214Z'
        agreement_info:
          $ref: '#/components/schemas/AgreementInformation'
      description: "Definition of the agreement validation request data.\n \n **Property descriptions**: \n \n - **user_external_id** - Unique id of the user (created via [Create User](https://developer.hellozai.com/reference/createuser) API) with whom the agreement should be associated with.\n - **priority** - Priority of the agreement creation/amendment authorisation notification to be sent to the user for approval. \n \n   Supported values: \n \n     - Attended - If the marketplace wants the debtor user to be notified about the agreement creation/amendment authorisation action immediately, the priority should be set as Attended. \n \n   - Unattended - If the marketplace wants the debtor user to be notified about the agreement creation/amendment authorisation at an appropriate time (not immediately), the priority should be set as Unattended.\n - **response_requested_by** - This field can be used to specify a custom expiry duration for the authorisation request pending debtor’s approval. Any duration which is less than the default & max duration of 5 days will be accepted. Example - If you want the debtor to approve the agreement within 15 mins post creation, mention the duration in this field accordingly. However, post the duration (after 15 mins), you would need to invoke the Recall API to expire this authorisation request.\n - **agreement_info** - Details (creditor, debtor, payment terms) which should be agreed between debtor and creditor.\n"
    DebtorAccountPayidInformation:
      type: object
      properties:
        payid_type:
          title: DebtorAccountPayidTypeCode
          type: string
          description: ' <p>PayID type associated with Debtor''s bank account:</p><table><tr><td>Code</td><td>Description</td></tr><tr><td>TELI</td><td>Telephone Number (Note that the ISO Code is TELE, but in AU-NPP context, TELI is used)</td></tr><tr><td>EMAL</td><td>Email Address</td></tr><tr><td>AUBN</td><td>Australian Business Number</td></tr><tr><td>ORGN</td><td>Organisation Identifier</td></tr></table>'
          enum:
          - TELI
          - EMAL
          - AUBN
          - ORGN
        payid:
          maxLength: 2048
          minLength: 1
          type: string
          description: "Specifies a character string with a maximum length of 2048 characters. \n \n PayID as provided by the debtor.\n Telephone (TELI): Consists of a \"+\" followed by the country code (from 1 to 3 characters) then a \"-\" then a number between 1-9 and then any combination of numbers between 0-9. Total of up to 35 characters. \n \n Format pattern: ^\\+[0-9]{1,3}-[1-9]{1,1}[0-9]{1,29}$ \n \n Email (EMAL): \n \n Consists of a character string with a maximum length of 256 characters in lower case. This must include the \"@\" symbol with leading and trailing characters and no white spaces. \n \n Format pattern: (MAX256 text): ^(?:\\[a-z0-9!#$%&'\\*+/=?^\\_\\`{|}~-]+(?:\\\\.\\[a-z0-9!#$%&'\\*+/=?^_\\`{|}~-]+)\\*@(?:\\[a-z0-9](?:\\[a-z0-9-]\\*\\[a-z0-9])?\\\\.)+\\[a-z0-9](?:\\[a-z0-9-]*\\[a-z0-9])?)$ \n \n **ABN (AUBN):** Consists of a nine to eleven digit number where the first two digits are a checksum. This is assigned by the Australian Taxation Office to identify an individual Australian Business. \n \n Format pattern: (MIN9 - MAX11 digit): ^((\\d{9})|(\\d{11}))$ \n \n **Organisation (ORGN):** \n \n The Identifier must include the company/organisation name and both/either the description of the business/ trade / product / campaign and/or geographic location. \n \n Format pattern: Maximum of 256 characters in lower case, to be drawn from the NPP Character Set and without leading or trailing whitespace. \n \n ^[!-@[-~][ -@[-~]{0,254}[!-@[-~]$ \n "
          example: payid
      description: "Debtor account PayID Details.\n\n **Property descriptions**: \n \n - **payid_type** - PayID type associated with Debtor's bank account. \n\n   Supported values: \n \n   - EMAL - Email Address\n   - TELE - Telephone Number\n   - AUBN - Australian Business Number\n   - ORGN - Organisational Identifier\n - **payid** - PayID as provided by the debtor. "
    AmendFirstPaymentInformation:
      type: object
      properties:
        amount:
          maxLength: 19
          minLength: 1
          pattern: ^(?=.{1,19}$)[1-9]{1}[0-9]{0,18}$
          type: string
          description: "Specifies an amount in cents.\n\n\n   - For FIXE type of agreements, as the amount to be debited is fixed, this indicates the amount to be debited per payment.\n   - For BALN type of agreements, as the amount to be debited is fixed for all payments (except the last/final payment which can be for a larger amount), this field indicates the amount to be debited for all payments except the final/last.\n   - For USGB/VARI type of agreements, this indicates the minimum amount that can be debited from the account per payment."
          example: '1500'
        currency:
          pattern: ^[A-Z]{3,3}$
          type: string
          description: 'A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".


            Currency of the payment to debit the account.'
          example: AUD
          enum:
          - '{AUD}'
        date:
          pattern: ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)$
          type: string
          description: 'A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.


            If the payment arrangement being established specifies the first date (until 23:59:59.999 Australia Sydney time, expressed in the YYYY-MM-DD format) on which payment is expected to be initiated, that date should be specified in this field. Setting this property to "-" indicates that the date is to be cleared on the agreement.'
          format: yyyy-MM-dd
          example: '2022-04-15'
      description: "If the payment arrangement is such that the initial payment amount differs from the expected \"regular\" or \"recurring\" payment, then the first payment info can be specified in this field. Examples: Establishment fees are part of the first payment only. \n \n **Property descriptions**: \n \n - **amount**\n   - For FIXE type of agreements, as the amount to be debited is fixed, this indicates the amount to be debited per payment.\n   - For BALN type of agreements, as the amount to be debited is fixed for all payments (except the last/final payment which can be for a larger amount), this field indicates the amount to be debited for all payments except the final/last.\n   - For USGB/VARI type of agreements, this indicates the minimum amount that can be debited from the account per payment.\n - **currency** - Currency of the payment to debit the account.\n - **date** - If the payment arrangement being established specifies the first date (until 23:59:59.999 Australia Sydney time, expressed in the YYYY-MM-DD format) on which payment is expected to be initiated, that date should be specified in this field. Setting this property to \"-\" indicates that the date is to be cleared on the agreement."
    DebtorAccountDetails:
      type: object
      properties:
        account_id:
          type: string
          description: Specifies a character string with a maximum length of 34 ASCII printable characters.
          example: '123456789'
        account_id_type:
          title: DebtorAccountIdTypeCode
          type: string
          description: <p>Specifies the type of account identification:</p><table><tr><td>Code</td><td>Description</td></tr><tr><td>BBAN</td><td>Basic Bank Account Number</td></tr><tr><td>PAYID</td><td>Payid Identification</td></tr></table>
          example: PAYID
          enum:
          - BBAN
          - PAYID
        payid_details:
          $ref: '#/components/schemas/DebtorAccountPayidDetails'
      description: "Debtor Account Details.\n\n **Property descriptions**: \n\n - **account_id** - Debtor's actual bank account number (BSB + Account Number).\n - **account_id_type** - Debtor's bank account type.\n   Supported values: \n\n   - BBAN (bsb/account)\n   - PAYID\n - **payid_details** - Debtor account PayID Details. \n"
    MaximumAmountInfo:
      type: object
      properties:
        amount:
          type: string
          description: Specifies an amount in cents.
          example: '1000'
        currency:
          pattern: ^[A-Z]{3,3}$
          type: string
          description: A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
          example: AUD
      description: "Represents the maximum amount that may be debited in any single payment initiation. \n\n **Property descriptions**: \n\n - **amount**\n   - For FIXE type of agreements, as the amount to be debited is fixed, this indicates the amount to be debited per payment.\n   - For BALN type of agreements, as the amount to be debited is fixed for all payments (except the last/final payment which can be for a larger amount), this field indicates the amount to be debited for all payments except the final/last.\n   - For USGB/VARI type of agreements, this indicates the minimum amount that can be debited from the account per payment.\n - **currency** - Currency of the payment to debit the account."
    BilateralAmendments:
      type: object
      properties:
        automatic_renewal:
          type: boolean
          description: 'Indicates a "Yes" or "No" type of automatic renewal.


            Automatic renewal of an agreement at the end of the defined period. An example of an automatically renewing agreement might be a gym membership that automatically rolls over, or a phone contract. If this property is omitted then the automatic renewal will not be modified as part of the amendment.'
        validity_end_date:
          pattern: ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)$
          type: string
          description: 'A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.


            Validity end date of the agreement. If specified, the agreement is valid until 23:59:59.999 Australia Sydney time on this date. If this property is omitted then the validity end date will not be modified as part of the amendment. Set this property to "-" to indicate that the validity end date is to be cleared on the agreement. Note - Clearing validity end date requires to provide the auto-renewal property (automatic_renewal=true)'
          format: yyyy-MM-dd
          example: '2022-03-18'
        transfer_arrangement:
          maxLength: 140
          minLength: 1
          type: string
          description: 'Specifies a character string with a maximum length of 140 characters.


            Additional details about the agreement terms with consideration to the transfer of items/goods/services. Examples might include payment of shares, transfer of property, or fulfilment of a purchase order. If this property is omitted then the transfer arrangement will not be modified as part of the amendment. Set this property to "-" to indicate that the transfer arrangement is to be cleared on the agreement.'
          example: transfer arrangement
        payment_terms:
          $ref: '#/components/schemas/AmendPaymentTermsDetails'
      description: "Specific characteristics about the bilateral fields.\n\nSpecifies fields for which amendments are effective only post debtor authorisation.\n\n **Property descriptions**: \n \n - **automatic_renewal** - Automatic renewal of an agreement at the end of the defined period. An example of an automatically renewing agreement might be a gym membership that automatically rolls over, or a phone contract. If this property is omitted then the automatic renewal will not be modified as part of the amendment.\n- **validity_end_date** - Validity end date of the agreement. If specified, the agreement is valid until 23:59:59.999 Australia Sydney time on this date. If this property is omitted then the validity end date will not be modified as part of the amendment. Set this property to \"-\" to indicate that the validity end date is to be cleared on the agreement. Note - Clearing validity end date requires to provide the auto-renewal property (automatic_renewal=true)\n- **transfer_arrangement** - Additional details about the agreement terms with consideration to the transfer of items/goods/services. Examples might include payment of shares, transfer of property, or fulfilment of a purchase order. If this property is omitted then the transfer arrangement will not be modified as part of the amendment. Set this property to \"-\" to indicate that the transfer arrangement is to be cleared on the agreement.\n- **payment_terms** - Set of characteristics detailing agreement payment information. If this property is omitted then the payment information will not be modified as part of the amendment.\n\n The following rules apply to this structure: \n- **ValidityEndDateRule:** validity_end_date should be greater than OR same as validity_start_date. \n\n - **AutomaticExtensionRule:** validity_end_date should not be provided if agreement should be auto-renewed."
    CreditorInfo:
      type: object
      properties:
        creditor_account_details:
          $ref: '#/components/schemas/CreditorAccountDetails'
        creditor_details:
          $ref: '#/components/schemas/CreditorDetails'
      description: "Information concerning the creditor party identified in the agreement. \n\n**Property descriptions**: \n - **creditor_account_details** - Information containing creditor account details.\n - **creditor_details** - Information containing debtor details."
    CreditorDetails:
      type: object
      properties:
        creditor_id:
          type: string
          description: Specifies a character string with a maximum length of 35 ASCII printable characters.
          example: creditor identification
        creditor_id_type:
          title: CreditorIdTypeCode
          type: string
          description: <p>Specifies an alphanumeric string with a length of 4 characters. Specifies the code indicating the identification type of the creditor.</p><table><tr><td>Code</td><td>Description</td></tr><tr><td>ARNU</td><td>Alien Registration Number</td></tr><tr><td>CCPT</td><td>Passport Number</td></tr><tr><td>CUST</td><td>Customer Identification Number</td></tr><tr><td>DRLC</td><td>Drivers License Number</td></tr><tr><td>EMPL</td><td>Employee Identification Number</td></tr><tr><td>NIDN</td><td>National Identity Number</td></tr><tr><td>SOSE</td><td>Social Security Number</td></tr><tr><td>TXID</td><td>Tax Identification Number</td></tr><tr><td>BANK</td><td>Bank Party Identification</td></tr><tr><td>CBID</td><td>Central Bank Identification Number</td></tr><tr><td>CHID</td><td>Clearing Identification Number</td></tr><tr><td>CINC</td><td>Certificate Of Incorporation Number</td></tr><tr><td>COID</td><td>Country Identification Code</td></tr><tr><td>DUNS</td><td>Data Universal Numbering System</td></tr><tr><td>GS1G</td><td>GS1GLN Identifier</td></tr><tr><td>SREN</td><td>SIREN</td></tr><tr><td>SRET</td><td>SIRET</td></tr><tr><td>AUBN</td><td>Australian Business Number (ABN)</td></tr><tr><td>AUCN</td><td>Australian Company Number (ACN)</td></tr><tr><td>LEIN</td><td>Legal Entity Identification (LEI)</td></tr></table>
          enum:
          - ARNU
          - CCPT
          - CUST
          - DRLC
          - EMPL
          - NIDN
          - SOSE
          - TXID
          - BANK
          - CBID
          - CHID
          - CINC
          - COID
          - DUNS
          - GS1G
          - SREN
          - SRET
          - AUBN
          - AUCN
          - LEIN
        creditor_name:
          type: string
          description: Specifies a character string with a maximum length of 140 ASCII printable characters.
          example: creditor name
        creditor_type:
          title: PartyType
          type: string
          description: 'Specifies the type of creditor involved in the transaction.

            <table><tr><td>Code</td><td>Name</td><td>Description</td></tr><tr><td>ORGN</td><td>Organisation</td><td>Debtor is an organisation.</td></tr><tr><td>PERS</td><td>Person</td><td>Debtor is a private individual.</td></tr></table>'
          enum:
          - ORGN
          - PERS
        ultimate_creditor_name:
          type: string
          description: Specifies a character string with a maximum length of 140 ASCII printable characters.
          example: ultimate creditor name
        creditor_reference:
          type: string
          description: Specifies a character string with a maximum length of 35 ASCII printable characters.
          example: creditor reference
      description: "Information concerning the creditor party identified in the agreement. \n\n**Property descriptions**: \n - **creditor_id** - Unique and unambiguous identification of the creditor.\n - **creditor_id_type** - Code indicating the identification type of the creditor, for example in the case of a private individual; passport, driver licence, or 100-point check, or in the case of an organisation; LEI, ACN, ABN.\n - **creditor_name** - Name by which the creditor is known and which is usually used to identify that creditor.\n - **creditor_type** - Identifies the type of a creditor.\n   Supported values based on creditor type field: \n\n   If Creditor Type is PERS: \n\n   - CCPT = Passport Number \n   - CUST = Customer Identification Number\n   - DRLC = Driver’s License Number\n   - EMPL = Employee Identification Number\n   - TXID = Tax Identification Number \n\n   If Creditor Type is ORGN: \n\n     - BANK = Bank Party Identification\n     - CHID = Clearing Identification Number\n     - CINC = Certificate Of Incorporation Number\n     - EMPL = Employer Identification Number\n     - TXID = Tax Identification Number\n - **ultimate_creditor_name** - This field can indicate trading the name or common name of the marketplace/platform which is receives the funds via Zai OR  could be the actual seller user's name to which the funds will be transferred eventually.\n - **creditor_reference** - Reference relevant to the Creditor. Example - Invoice number."
    AgreementInformation:
      required:
      - agreement_type
      - creditor_info
      - debtor_info
      - payment_initiator_info
      - payment_terms
      - purpose_code
      - validity_start_date
      type: object
      properties:
        description:
          maxLength: 140
          minLength: 1
          type: string
          description: 'Specifies a character string with a maximum length of 140 characters.


            Describes what the agreement is being established for. Examples include a product, particular service offering, etc. If the description is less than 35 characters, then the Short Description should be used instead of the Description field.'
          example: agreement desc
        short_description:
          maxLength: 35
          minLength: 1
          type: string
          description: 'Specifies a character string with a maximum length of 35 characters.


            Describes what the agreement is being established for. Examples include a product, particular service offering, etc. If the description is less than 35 characters, then the Short Description should be used instead of the Description field.'
          example: short desc
        purpose_code:
          title: PurposeCode
          type: string
          description: "<p>Specifies the high-level purpose of the mandate based on a set of pre-defined categories.\nMost appropriate code that represents the purpose for which this agreement is being established.</p> \n<table> <tr><td>Code</td><td>Description</td></tr> <tr><td>MORT</td><td>Mortgage payments, including payments for a home/business loan</td></tr> <tr><td>UTIL</td><td>Utility payments such as gas, electricity, water etc</td></tr> <tr><td>LOAN</td><td>Loan payments, other than mortgage payments</td></tr> <tr><td>DEPD</td><td>Dependant support payments (e.g. child support)</td></tr> <tr><td>RETL</td><td>Retail payments, including e-commerce and online shopping (payments are for provision of goods or services)</td></tr> <tr><td>SALA</td><td>Salary payments</td></tr> <tr><td>PERS</td><td>Personal payments (payments to an individual which excludes any payments for salary and superannuation purposes)</td></tr> <tr><td>GOVT</td><td>Government payments</td></tr> <tr><td>PENS</td><td>Pension payments (superannuation payments)</td></tr> <tr><td>TAXS</td><td>Tax payments (tax payments to Australian Taxation Office (ATO) and Australian Commonwealth, State, Territory, or other local government body)</td></tr> <tr><td>OTHR</td><td>Other service related payments (when there is no other appropriate purpose code)</td></tr> </table>"
          enum:
          - MORT
          - UTIL
          - LOAN
          - DEPD
          - RETL
          - SALA
          - PERS
          - GOVT
          - PENS
          - TAXS
          - OTHR
        agreement_type:
          title: AgreementType
          type: string
          description: "<p>Agreement type to be created.</p> \n<table><tr><td>Code</td><td>Name</td><td>Description</td></tr><tr><td>AUPM</td><td>AuthorisedPaymentMandate</td><td>Established bilaterally as Authorised Payment Mandate.</td><td>This type of agreement must be authorised by the payer/debtor i.e. agreement will be Active only post debtor/payer authorisation. Payment requests can be initiated immediately once the agreement is \"Active\".</td></tr><tr><td>MGCR</td><td>MigratedByCreditor</td><td>Established by migration from legacy service by Creditor.</td><td>This type of agreement is created in order to migrate existing Direct Debit arrangement to be processed via the NPP using the PayTo rails. The agreement will be Active immediately (does not need debtor/payer authorisation as it was already pre-authorised in the existing BECS systems) post migration however payment requests can be initiated after 5 calendar days of creating the agreement.</td></tr></table>"
          enum:
          - AUPM
          - MGCR
        automatic_renewal:
          type: boolean
          description: 'Indicates a "Yes" or "No" type of answer for an element.


            Automatic renewal of an agreement at the end of the defined period. An example of an automatically renewing agreement might be a gym membership that automatically rolls over, or a phone contract.'
        validity_start_date:
          pattern: ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)$
          type: string
          description: 'A date expressed in the YYYY-MM-DD format.


            Validity start date of the agreement. The agreement is valid as of 00:00:00.000 Australia Sydney time on this date.'
          format: yyyy-MM-dd
          example: '2022-04-05'
        validity_end_date:
          pattern: ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)$
          type: string
          description: 'A date expressed in the YYYY-MM-DD format.


            Validity end date of the agreement. If specified, the agreement is valid until 23:59:59.999 Australia Sydney time on this date.'
          format: yyyy-MM-dd
          example: '2022-04-25'
        transfer_arrangement:
          maxLength: 140
          minLength: 1
          type: string
          description: 'Specifies a character string with a maximum length of 140 characters.


            Additional details about the agreement terms with consideration to the transfer of items/goods/services. Examples might include payment of shares,transfer of property, or fulfilment of a purchase order.

            '
          example: transfer arrangement
        debtor_info:
          $ref: '#/components/schemas/DebtorInformation'
        creditor_info:
          $ref: '#/components/schemas/CreditorInformation'
        payment_initiator_info:
          $ref: '#/components/schemas/PaymentInitiatorInformation'
        payment_terms:
          $ref: '#/components/schemas/PaymentTermsDetails'
      description: "Details (creditor, debtor, payment terms) which should be agreed between debtor and creditor.\n \n **Property descriptions**: \n \n - **description** - Describes what the agreement is being established for. Examples include a product, particular service offering, etc. \n If the description is less than 35 characters, then the Short Description should be used instead of the Description field.\n - **short_description** - Describes what the agreement is being established for. Examples include a product, particular service offering, etc. \n If the description is less than 35 characters, then the Short Description should be used instead of the Description field. \n- **purpose_code** - Most appropriate code that represents the purpose for which this agreement is being established. \n \n   Supported values: \n \n   - MORT - Mortgage payments, including payments for a home/business loan\n   - UTIL - Utility payments such as gas, electricity, water etc\n   - LOAN - Loan payments, other than mortgage payments\n   - DEPD - Dependant support payments (e.g. child support)\n   - RETL - Retail payments, including e-commerce and online shopping (payments are for provision of goods or services)\n   - SALA - Salary payments\n   - PERS - Personal payments (payments to an individual which excludes any payments for salary and superannuation purposes)\n   - GOVT - Government payments\n   - PENS - Pension payments (superannuation payments)\n   - TAXS - Tax payments (tax payments to Australian Taxation Office (ATO) and Australian Commonwealth, State, Territory, or other local government body)\n   - OTHR - Other service related payments (when there is no other appropriate purpose code)\n - **agreement_type** - Agreement type to be created. \n \n   Supported values: \n \n   - AUPM (Authorised Payment Mandate) - This type of agreement must be authorised by the payer/debtor i.e. agreement will be Active only post debtor/payer authorisation. Payment requests can be initiated immediately once the agreement is \"Active\".\n   - MGCR (Migrated by Creditor/Migrated DDR) - This type of agreement is created in order to migrate existing Direct Debit arrangement to be processed via the NPP using the PayTo rails. The agreement will be Active immediately (does not need debtor/payer authorisation as it was already pre-authorised in the existing BECS systems) post migration however payment requests can be initiated after 5 calendar days of creating the agreement. \n - **automatic_renewal** - Automatic renewal of an agreement at the end of the defined period. An example of an automatically renewing agreement might be a gym membership that automatically rolls over, or a phone contract. \n- **validity_start_date** - Validity start date of the agreement. The agreement is valid as of 00:00:00.000 Australia Sydney time on this date. \n- **validity_end_date** - Validity end date of the agreement. If specified, the agreement is valid until 23:59:59.999 Australia Sydney time on this date. \n- **transfer_arrangement** - Additional details about the agreement terms with consideration to the transfer of items/goods/services. Examples might include payment of shares,transfer of property, or fulfilment of a purchase order. \n- **debtor_info** - Debtor and Debtor Account Details. \n- **creditor_info** - Creditor Details. \n- **payment_initiator_info** - Initiating party details. \n- **payment_terms** - Set of characteristics detailing agreement payment information. \n\n The following rules apply to this structure: \n\n - **DescriptionAndShortDescriptionRule:** Either 'description' or 'short_description' must be present. \n\n - **AgreementTypeRule:** If 'agreement_type' is equal to 'MGCR' then payid details must be absent. \n\n - **ValidityStartDateRule:** validity_start_date should be either current date OR future date. \n\n - **ValidityStartAndEndDateRule:** validity_end_date should be either current date OR future date. \n\n - **AutomaticExtensionRule:** validity_end_date must be present only if 'automatic_renewal' is false. "
    DebtorInformation:
      required:
      - debtor_account_details
      - debtor_details
      type: object
      properties:
        debtor_account_details:
          $ref: '#/components/schemas/DebtorAccountInformation'
        debtor_details:
          $ref: '#/components/schemas/DebtorInformationDetails'
      description: "Debtor and Debtor Account Details.\n \n **Property descriptions**: \n \n - **debtor_account_details** - Debtor Account Details. \n - **debtor_details** - Debtor Details. \n "
    PaymentInitiatorInfo:
      type: object
      properties:
        initiator_id:
          type: string
          description: Specifies a character string with a maximum length of 35 ASCII printable characters.
          example: initiator identification
        initiator_id_type_code:
          title: PaymentInitiatorIdTypeCodeEnum
          type: string
          description: <p>Specifies an alphanumeric string with a length of 4 characters:</p><table><tr><td>Code</td><td>Description</td></tr><tr><td>ARNU</td><td>Alien Registration Number</td></tr><tr><td>CCPT</td><td>Passport Number</td></tr><tr><td>CUST</td><td>Customer Identification Number</td></tr><tr><td>DRLC</td><td>Drivers License Number</td></tr><tr><td>EMPL</td><td>Employee Identification Number</td></tr><tr><td>NIDN</td><td>National Identity Number</td></tr><tr><td>SOSE</td><td>Social Security Number</td></tr><tr><td>TXID</td><td>Tax Identification Number</td></tr><tr><td>BANK</td><td>Bank Party Identification</td></tr><tr><td>CBID</td><td>Central Bank Identification Number</td></tr><tr><td>CHID</td><td>Clearing Identification Number</td></tr><tr><td>CINC</td><td>Certificate Of Incorporation Number</td></tr><tr><td>COID</td><td>Country Identification Code</td></tr><tr><td>DUNS</td><td>Data Universal Numbering System</td></tr><tr><td>GS1G</td><td>GS1GLN Identifier</td></tr><tr><td>SREN</td><td>SIREN</td></tr><tr><td>SRET</td><td>SIRET</td></tr><tr><td>AUBN</td><td>Australian Business Number (ABN)</td></tr><tr><td>AUCN</td><td>Australian Company Number (ACN)</td></tr><tr><td>LEIN</td><td>Legal Entity Identification (LEI)</td></tr></table>
          enum:
          - AUBN
          - CCPT
          - CUST
          - DRLC
          - EMPL
          - NIDN
          - SOSE
          - TXID
          - BANK
          - CBID
          - CHID
          - CINC
          - COID
          - DUNS
          - GS1G
          - SREN
          - SRET
          - AUBN
          - AUCN
          - LEIN
        initiator_legal_name:
          type: string
          description: Specifies a character string with a maximum length of 140 ASCII printable characters.
          example: initiator legal name
        initiator_name:
          type: string
          description: Specifies a character string with a maximum length of 140 ASCII printable characters.
          example: initiator name
      description: "Initiating party details. \n\n**Property descriptions**: \n - **initiator_id** - Unique and unambiguous identification of the initiator.\n - **initiator_id_type_code** - Code indicating the identification type of the initiator. For example in the case of a private individual; passport, driver licence, or 100 point check, or in the case of an organisation; LEI, ACN, ABN.\n - **initiator_legal_name** - Name by which the initiator is legally known.\n - **initiator_name** - Name by which the initiator is known and which is usually used to identify them."
    MaximumAmountInformation:
      type: object
      properties:
        amount:
          maxLength: 19
          minLength: 1
          pattern: ^(?=.{1,19}$)[1-9]{1}[0-9]{0,18}$
          type: string
          description: "Specifies an amount in cents.\n\n\n   - For FIXE type of agreements, as the amount to be debited is fixed, this indicates the amount to be debited per payment.\n   - For BALN type of agreements, as the amount to be debited is fixed for all payments (except the last/final payment which can be for a larger amount), this field indicates the amount to be debited for all payments except the final/last.\n   - For USGB/VARI type of agreements, this indicates the minimum amount that can be debited from the account per payment."
          example: '5000'
        currency:
          pattern: ^[A-Z]{3,3}$
          type: string
          description: 'A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".


            Currency of the payment to debit the account.'
          example: AUD
          enum:
          - '{AUD}'
      description: "Represents the maximum amount that may be debited in any single payment initiation. \n\n **Property descriptions**: \n \n - **amount**\n   - For FIXE type of agreements, as the amount to be debited is fixed, this indicates the amount to be debited per payment.\n   - For BALN type of agreements, as the amount to be debited is fixed for all payments (except the last/final payment which can be for a larger amount), this field indicates the amount to be debited for all payments except the final/last.\n   - For USGB/VARI type of agreements, this indicates the minimum amount that can be debited from the account per payment.\n - **currency** - Currency of the payment to debit the account."
    AmendAgreementDetailsResponse:
      type: object
      properties:
        agreement_uuid:
          type: string
          description: Unique agreement identifier.
          example: ae07556e-22ef-11eb-adc1-0242ac12000
        agreement_id:
          type: string
          description: Unique agreement identifier generated by NPPA.
          example: ef0fcd9799431ef783204966f010603c
        status:
          title: Status
          type: string
          description: "<p>Current status of the agreement before amendment.</p> \n<table><tr><td>Code</td><td>Description</td></tr><tr><td>SUSPENDED</td><td>The agreement is suspended.</td></tr><tr><td>ACTIVE</td><td>The agreement is active.</td></tr></table>"
          example: ACTIVE
          enum:
          - SUSPENDED
          - ACTIVE
        created_at:
          type: string
          description: creation date.
          example: '2022-03-21 16:25:00.190831'
        updated_at:
          type: string
          description: modification date.
          example: '2022-03-22 16:25:00.190831'
      description: Specific characteristics of an agreement details amendment response.
    AgreementInfo:
      type: object
      properties:
        agreement_id:
          type: string
          description: Unique agreement identifier generated by NPPA.
          example: 00000000000010008000000000000000
        description:
          type: string
          description: Specifies a character string with a maximum length of 140 characters.
          example: agreement desc
        short_description:
          type: string
          description: Specifies a character string with a maximum length of 35 characters.
          example: short desc
        purpose_code:
          title: PurposeCode
          type: string
          description: "<p>Specifies the high-level purpose of the mandate based on a set of pre-defined categories.</p> \n<table> <tr><td>Code</td><td>Description</td></tr> <tr><td>MORT</td><td>Mortgage payments, including payments for a home/business loan</td></tr> <tr><td>UTIL</td><td>Utility payments such as gas, electricity, water etc</td></tr> <tr><td>LOAN</td><td>Loan payments, other than mortgage payments</td></tr> <tr><td>DEPD</td><td>Dependant support payments (e.g. child support)</td></tr> <tr><td>RETL</td><td>Retail payments, including e-commerce and online shopping (payments are for provision of goods or services)</td></tr> <tr><td>SALA</td><td>Salary payments</td></tr> <tr><td>PERS</td><td>Personal payments (payments to an individual which excludes any payments for salary and superannuation purposes)</td></tr> <tr><td>GOVT</td><td>Government payments</td></tr> <tr><td>PENS</td><td>Pension payments (superannuation payments)</td></tr> <tr><td>TAXS</td><td>Tax payments (tax payments to Australian Taxation Office (ATO) and Australian Commonwealth, State, Territory, or other local government body)</td></tr> <tr><td>OTHR</td><td>Other service related payments (when there is no other appropriate purpose code)</td></tr> </table>"
          enum:
          - MORT
          - UTIL
          - LOAN
          - DEPD
          - RETL
          - SALA
          - PERS
          - GOVT
          - PENS
          - TAXS
          - OTHR
        agreement_type:
          title: AgreementType
          type: string
          description: "<p></p> \n<table><tr><td>Code</td><td>Name</td><td>Description</td></tr><tr><td>AUPM</td><td>AuthorisedPaymentMandate</td><td>Established bilaterally as Authorised Payment Mandate.</td></tr><tr><td>MGCR</td><td>MigratedByCreditor</td><td>Established by migration from legacy service by Creditor.</td></tr></table>"
          enum:
          - AUPM
          - MGCR
        automatic_renewal:
          type: boolean
          description: Indicates a "Yes" or "No" type of answer for an element.
        validity_start_date:
          pattern: ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)$
          type: string
          description: 'A date expressed in the YYYY-MM-DD format. '
          format: yyyy-MM-dd
          example: '2022-04-05'
        validity_end_date:
          pattern: ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)$
          type: string
          description: 'A date expressed in the YYYY-MM-DD format. '
          format: yyyy-MM-dd
          example: '2022-04-25'
        transfer_arrangement:
          type: string
          description: Specifies a character string with a maximum length of 140 characters.
          example: transfer arrangement
        debtor_info:
          $ref: '#/components/schemas/DebtorInfo'
        creditor_info:
          $ref: '#/components/schemas/CreditorInfo'
        payment_initiator_info:
          $ref: '#/components/schemas/PaymentInitiatorInfo'
        payment_terms:
          $ref: '#/components/schemas/PaymentTerms'
      description: "Details (creditor, debtor, payment terms) which should be agreed between debtor and creditor.\n \n **Property descriptions**: \n \n - **agreement_id** - Unique agreement identifier generated by NPPA.\n \n - **description** - Describes what the agreement is being established for. Examples include a product, particular service offering, etc. \n If the description is less than 35 characters, then the Short Description should be used instead of the Description field.\n - **short_description** - Describes what the agreement is being established for. Examples include a product, particular service offering, etc. \n If the description is less than 35 characters, then the Short Description should be used instead of the Description field. \n- **purpose_code** - Most appropriate code that represents the purpose for which this agreement is being established. \n\n   Supported values: \n \n   - MORT - Mortgage payments, including payments for a home/business loan\n   - UTIL - Utility payments such as gas, electricity, water etc\n   - LOAN - Loan payments, other than mortgage payments\n   - DEPD - Dependant support payments (e.g. child support)\n   - RETL - Retail payments, including e-commerce and online shopping (payments are for provision of goods or services)\n   - SALA - Salary payments\n   - PERS - Personal payments (payments to an individual which excludes any payments for salary and superannuation purposes)\n   - GOVT - Government payments\n   - PENS - Pension payments (superannuation payments)\n   - TAXS - Tax payments (tax payments to Australian Taxation Office (ATO) and Australian Commonwealth, State, Territory, or other local government body)\n   - OTHR - Other service related payments (when there is no other appropriate purpose code)\n - **agreement_type** - Agreement type to be created. \n\n   Supported values: \n \n     - AUPM (Authorised Payment Mandate)  - This type of agreement must be authorised by the payer/debtor i.e. agreement will be Active only post debtor/payer authorisation. Payment requests can be initiated immediately once the agreement is \"Active\". \n \n   - MGCR (Migrated by Creditor/Migrated DDR) - This type of agreement is created in order to migrate existing Direct Debit arrangement to be processed via the NPP using the PayTo rails. The agreement will be Active immediately (does not need debtor/payer authorisation as it was already pre-authorised in the existing BECS systems) post migration however payment requests can be initiated after 5 calendar days of creating the agreement. \n- **automatic_renewal** - Automatic renewal of an agreement at the end of the defined period. An example of an automatically renewing agreement might be a gym membership that automatically rolls over, or a phone contract. \n- **validity_start_date** - Validity start date of the agreement. The agreement is valid as of 00:00:00.000 Australia Sydney time on this date. \n- **validity_end_date** - Validity end date of the agreement. If specified, the agreement is valid until 23:59:59.999 Australia Sydney time on this date. \n- **transfer_arrangement** - Additional details about the agreement terms with consideration to the transfer of items/goods/services. Examples might include payment of shares,transfer of property, or fulfilment of a purchase order. \n- **debtor_info** - Debtor and Debtor Account Details. \n- **creditor_info** - Creditor and Creditor Account Details. \n- **payment_initiator_info** - Initiating party details. \n- **payment_terms** - Set of characteristics detailing agreement payment information. \n"
    LastPaymentInformation:
      type: object
      properties:
        amount:
          maxLength: 19
          minLength: 1
          pattern: ^(?=.{1,19}$)[1-9]{1}[0-9]{0,18}$
          type: string
          description: "Specifies an amount in cents.\n\n\n   - For FIXE type of agreements, as the amount to be debited is fixed, this indicates the amount to be debited per payment.\n   - For BALN type of agreements, as the amount to be debited is fixed for all payments (except the last/final payment which can be for a larger amount), this field indicates the amount to be debited for all payments except the final/last.\n   - For USGB/VARI type of agreements, this indicates the minimum amount that can be debited from the account per payment."
          example: '2000'
        currency:
          pattern: ^[A-Z]{3,3}$
          type: string
          description: 'A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".


            Currency of the payment to debit the account.'
          example: AUD
          enum:
          - '{AUD}'
        date:
          pattern: ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)$
          type: string
          description: 'A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.


            If the payment arrangement being established specifies the date (until 23:59:59.999 Australia Sydney time, expressed in the YYYY-MM-DD format) on which payment is expected to be initiated, that date should be specified in this field.'
          example: '2022-04-15'
      description: "If the payment arrangement is such that there is a known final payment amount that differs from the expected \"regular\" or \"recurring\" payment, then the last payment info can be specified in this field. \n\n **Property descriptions**: \n \n - **amount**\n   - For FIXE type of agreements, as the amount to be debited is fixed, this indicates the amount to be debited per payment.\n   - For BALN type of agreements, as the amount to be debited is fixed for all payments (except the last/final payment which can be for a larger amount), this field indicates the amount to be debited for all payments except the final/last.\n   - For USGB/VARI type of agreements, this indicates the minimum amount that can be debited from the account per payment.\n - **currency** - Currency of the payment to debit the account.\n - **date** - If the payment arrangement being established specifies the date (until 23:59:59.999 Australia Sydney time, expressed in the YYYY-MM-DD format) on which payment is expected to be initiated, that date should be specified in this field."
    DebtorDetails:
      type: object
      properties:
        debtor_name:
          type: string
          description: Specifies a character string with a maximum length of 140 ASCII printable characters.
          example: debtor name
        debtor_type:
          title: DebtorType
          type: string
          description: 'Specifies the type of debtor involved in the transaction:

            <table><tr><td>Code</td><td>Name</td><td>Description</td></tr><tr><td>ORGN</td><td>Organisation</td><td>Debtor is an organisation.</td></tr><tr><td>PERS</td><td>Person</td><td>Debtor is a private individual.</td></tr></table>'
          enum:
          - ORGN
          - PERS
        ultimate_debtor_name:
          type: string
          description: Specifies a character string with a maximum length of 140 ASCII printable characters.
          example: ultimate name
        debtor_id:
          type: string
          description: Specifies a character string with a maximum length of 35 ASCII printable characters.
          example: debtor identification
        debtor_id_type:
          title: DebtorIdTypeCode
          type: string
          description: <p>Specifies an alphanumeric string with a length of 4 characters. Specifies the code indicating the identification type of the debtor:</p><table><tr><td>Code</td><td>Description</td></tr><tr><td>ARNU</td><td>Alien Registration Number</td></tr><tr><td>CCPT</td><td>Passport Number</td></tr><tr><td>CUST</td><td>Customer Identification Number</td></tr><tr><td>DRLC</td><td>Drivers License Number</td></tr><tr><td>EMPL</td><td>Employee Identification Number</td></tr><tr><td>NIDN</td><td>National Identity Number</td></tr><tr><td>SOSE</td><td>Social Security Number</td></tr><tr><td>TXID</td><td>Tax Identification Number</td></tr><tr><td>BANK</td><td>Bank Party Identification</td></tr><tr><td>CBID</td><td>Central Bank Identification Number</td></tr><tr><td>CHID</td><td>Clearing Identification Number</td></tr><tr><td>CINC</td><td>Certificate Of Incorporation Number</td></tr><tr><td>COID</td><td>Country Identification Code</td></tr><tr><td>DUNS</td><td>Data Universal Numbering System</td></tr><tr><td>GS1G</td><td>GS1GLN Identifier</td></tr><tr><td>SREN</td><td>SIREN</td></tr><tr><td>SRET</td><td>SRET</td></tr><tr><td>AUBN</td><td>Australian Business Number (ABN)</td></tr><tr><td>AUCN</td><td>Australian Company Number (ACN)</td></tr><tr><td>LEIN</td><td>Legal Entity Identification (LEI)</td></tr></table>
          enum:
          - ARNU
          - CCPT
          - CUST
          - DRLC
          - EMPL
          - NIDN
          - SOSE
          - TXID
          - BANK
          - CBID
          - CHID
          - CINC
          - COID
          - DUNS
          - GS1G
          - SREN
          - SRET
          - AUBN
          - AUCN
          - LEIN
        debtor_reference:
          type: string
          description: Specifies a character string with a maximum length of 35 ASCII printable characters.
          example: debtor reference
      description: "Debtor Details. \n\n **Property descriptions**: \n\n - **debtor_name** - Specifies the name by which the debtor is known and which is usually used to identify that debtor.\n - **debtor_type** - Identifies debtor type. \n \n - **ultimate_debtor_name** - This field should be populated with the trading name of an organisation as would be identifiable to the creditor, or with the name of the receiver of goods or services as specified in the agreement for which this agreement is being established.\n - **debtor_id** - Unique and unambiguous ID of the debtor.\n - **debtor_id_type** - Indicates Debtor Id types. \n\n - **debtor_reference** - Reference relevant to the Payer/Debtor user. This reference could indicate information that may be useful to the creditor. Example - a purchase order. \nIf end to end Id is not provided in the payment initiation request, then the debtor reference (if available) will be populated as end to end id in the payment initiation request."
    RecallAgreementActionResponse:
      type: object
      properties:
        message:
          type: string
    DebtorInformationDetails:
      required:
      - debtor_name
      - debtor_type
      - ultimate_debtor_name
      type: object
      properties:
        debtor_name:
          maxLength: 140
          minLength: 1
          type: string
          description: 'Specifies a character string with a maximum length of 140 ASCII printable characters.


            Specifies the name by which the debtor is known and which is usually used to identify that debtor.'
          example: debtor name
        debtor_type:
          title: DebtorType
          type: string
          description: "Specifies the type of debtor involved in the transaction. \n\n Identifies debtor type.\n<table><tr><td>Code</td><td>Name</td><td>Description</td></tr><tr><td>ORGN</td><td>Organisation</td><td>Debtor is an organisation.</td></tr><tr><td>PERS</td><td>Person</td><td>Debtor is a private individual.</td></tr></table>"
          enum:
          - ORGN
          - PERS
        ultimate_debtor_name:
          maxLength: 140
          minLength: 1
          type: string
          description: 'Specifies a character string with a maximum length of 140 ASCII printable characters.


            This field should be populated with the trading name of an organisation as would be identifiable to the creditor, or with the name of the receiver of goods or services as specified in the agreement for which this agreement is being established.'
          example: ultimate name
        debtor_id:
          maxLength: 35
          minLength: 1
          type: string
          description: 'Specifies a character string with a maximum length of 35 ASCII printable characters.


            Unique and unambiguous ID of the debtor.'
          example: debtor identification
        debtor_id_type:
          title: DebtorIdTypeCode
          type: string
          description: <p>Specifies an alphanumeric string with a length of 4 characters. Specifies the code indicating the identification type of the debtor </p><table><tr><td>Code</td><td>Description</td></tr><tr><td>ARNU</td><td>Alien Registration Number</td></tr><tr><td>CCPT</td><td>Passport Number</td></tr><tr><td>CUST</td><td>Customer Identification Number</td></tr><tr><td>DRLC</td><td>Drivers License Number</td></tr><tr><td>EMPL</td><td>Employee Identification Number</td></tr><tr><td>NIDN</td><td>National Identity Number</td></tr><tr><td>SOSE</td><td>Social Security Number</td></tr><tr><td>TXID</td><td>Tax Identification Number</td></tr><tr><td>BANK</td><td>Bank Party Identification</td></tr><tr><td>CBID</td><td>Central Bank Identification Number</td></tr><tr><td>CHID</td><td>Clearing Identification Number</td></tr><tr><td>CINC</td><td>Certificate Of Incorporation Number</td></tr><tr><td>COID</td><td>Country Identification Code</td></tr><tr><td>DUNS</td><td>Data Universal Numbering System</td></tr><tr><td>GS1G</td><td>GS1GLN Identifier</td></tr><tr><td>SREN</td><td>SIREN</td></tr><tr><td>SRET</td><td>SRET</td></tr><tr><td>AUBN</td><td>Australian Business Number (ABN)</td></tr><tr><td>AUCN</td><td>Australian Company Number (ACN)</td></tr><tr><td>LEIN</td><td>Legal Entity Identification (LEI)</td></tr></table>
          enum:
          - ARNU
          - CCPT
          - CUST
          - DRLC
          - EMPL
          - NIDN
          - SOSE
          - TXID
          - BANK
          - CBID
          - CHID
          - CINC
          - COID
          - DUNS
          - GS1G
          - SREN
          - SRET
          - AUBN
          - AUCN
          - LEIN
        debtor_reference:
          maxLength: 35
          minLength: 1
          type: string
          description: 'Specifies a character string with a maximum length of 35 ASCII printable characters.


            Reference relevant to the Payer/Debtor user. This reference could indicate information that may be useful to the creditor. Example - a purchase order. If end to end Id is not provided in the payment initiation request, then the debtor reference (if provided) in the agreement will be used as end to end identifier for the payments initiated via the agreement.'
          example: debtor reference
      description: "Debtor Details. \n  \n **Property descriptions**: \n\n - **debtor_name** - Specifies the name by which the debtor is known and which is usually used to identify that debtor. \n - **debtor_type** - Identifies debtor type. \n \n   Supported values: \n \n   - ORGN = an organisation\n   - PERS = a private individual\n - **ultimate_debtor_name** - This field should be populated with the trading name of an organisation as would be identifiable to the creditor, or with the name of the receiver of goods or services as specified in the agreement for which this agreement is being established. \n - **debtor_id** - Unique and unambiguous ID of the debtor. \n - **debtor_id_type** - Indicates Debtor Id types. \n \n - **debtor_reference** - Reference relevant to the Payer/Debtor user. This reference could indicate information that may be useful to the creditor. Example - a purchase order. If end to end Id is not provided in the payment initiation request, then the debtor reference (if provided) in the agreement will be used as end to end identifier for the payments initiated via the agreement.\n\n \n The following rules apply to this structure: \n - <strong>DebtorIdentificationAndTypeRule1:</strong> If debtor_id is present then debtor_id_type must be present.\n - <strong>DebtorIdentificationAndTypeRule2:</strong> If debtor_id is absent then debtor_id_type must be absent."
    CreditorInformation:
      required:
      - ultimate_creditor_name
      type: object
      properties:
        ultimate_creditor_name:
          maxLength: 140
          minLength: 1
          type: string
          description: 'Specifies a character string with a maximum length of 140 ASCII printable characters.


            This field can indicate trading the name or common name of the marketplace/platform which is receives the funds via Zai OR could be the actual seller user''s name to which the funds will be transferred eventually.'
          example: ultimate creditor name
        creditor_reference:
          maxLength: 35
          minLength: 1
          type: string
          description: 'Specifies a character string with a maximum length of 35 ASCII printable characters.


            Reference relevant to the Creditor. Example - Invoice number.'
          example: creditor reference
      description: "Creditor Details. \n  \n**Property descriptions**: \n - **ultimate_creditor_name** - This field can indicate trading the name or common name of the marketplace/platform which is receives the funds via Zai OR could be the actual seller user's name to which the funds will be transferred eventually.\n - **creditor_reference** - Reference relevant to the Creditor. Example - Invoice number. "
    AgreementDetailsResponse:
      type: object
      properties:
        agreement_uuid:
          type: string
          description: Zai generated Universally Unique Identifier (UUID).
          example: d0c40d95-95b7-449b-9835-3c97c0386700
        user_external_id:
          type: string
          description: Specifies a character string.
          example: buyer-147043828
        status:
          type: string
          description: "<p>Current status of the agreement:</p> \n<table><tr><td>Status</td><td>Description</td></tr><tr><td>PENDING_VALIDATION</td><td>Agreement validation is pending.</td></tr><tr><td>VALIDATED</td><td>Agreement is validated.</td></tr><tr><td>VALIDATION_FAILED</td><td>Agreement validation failed.</td></tr><tr><td>PENDING_CREATION</td><td>Agreement creation is pending.</td></tr><tr><td>CREATED</td><td>Agreement is created.</td></tr><tr><td>CREATION_FAILED</td><td>Agreement creation failed.</td></tr><tr><td>ACTIVE</td><td>Agreement is active.</td></tr><tr><td>SUSPENDED</td><td>Agreement is suspended.</td></tr><tr><td>CANCELLED</td><td>Agreement is cancelled.</td></tr></table>"
          example: ACTIVE
        status_description:
          type: string
          description: Description of the associated status.
        status_reason_code:
          type: string
          description: '<p>Reason code of the associated status:

            <table><tr><td>Reason Code</td><td>Description</td></tr><tr><td>PayerAccountNumberInvalid</td><td>Payer account details or PayID provided is invalid or does not exist within NPP.</td></tr><tr><td>ClosedAccount<td>Account provided is closed.</td></tr><tr><td>PayerAccountClosed</td><td>Payer account provided is closed.</td></tr><tr><td>BlockedAccount</td><td>Account provided is temporarily blocked.</td></tr><tr><td>PayerAccountTypeInvalid</td><td>Payer account type is invalid - unable to debit funds within NPP.</td></tr><tr><td>TransactionForbiddenOnPayerAccount</td><td>Transaction forbidden on the provided Payer account - either agreement to debit this account does not exist/inactive or the account does not support debits within NPP.</td></tr><tr><td>NPPTransactionNotSupported</td><td>Transaction not supported on the provided Payer account - does not support NPP payments.</td></tr><tr><td>UnsupportedCurrency</td><td>Unable to debit funds in AUD from the provided Payer account.</td></tr><tr><td>AmountInvalidOrMissing</td><td>Amount and/or maximum amount are either invalid or not specified in the agreement.</td></tr><tr><td>AmountExceedsAgreedLimitsForPayerAccount</td><td>Amount specified in the agreement exceeds the allowed transaction amount for the Payer account.</td></tr><tr><td>PayerDeceased</td><td>Payer is deceased.</td></tr><tr><td>PayToServiceNotSupportedByPayerBank</td><td>PayTo service is not supported by the Payer institution.</td></tr><tr><td>PayToServiceNotPermittedForPayer</td><td>This agreement type is not supported for the provided Payer customer/account OR the Payer customer account no longer supports PayTo services.</td></tr><tr><td>RequestedByPayer</td><td>Suspension/Cancellation is requested by Payer.</td></tr><tr><td>RequestedByInitiatingParty</td><td>Suspension/Cancellation is requested by Creditor or by the Initiating Party.</td></tr><tr><td>ActiveAgreementValidityExpired</td><td>Validity of the agreement has expired & is no longer active.</td></tr><tr><td>UndisclosedReason</td><td>Suspended/Cancelled due to undisclosed reasons.</td></tr><tr><td>RequestedByPayer-UnspecifiedReason</td><td>Suspended/Cancelled without any reason specified by the Payer.</td></tr><tr><td>RequestedByPayerBank-UnspecifiedReason</td><td>Suspended/Cancelled without any reason specified by the Payer institution.</td></tr><tr><td>UnspecifiedReason</td><td>Suspended/Cancelled without any specified reason.</td></tr><tr><td>Prohibited</td><td>Suspended/Cancelled as it is considered prohibited.</td></tr><tr><td>PayeeNotOnAllowlistOfPayer</td><td>Payee not on the allowlist/trusted list of the Payer.</td></tr><tr><td>PayeeOnBlocklistOfPayer</td><td>Payee is blocked/blacklisted by the Payer.</td></tr><tr><td>ContractAmended</td><td>External arrangement (or contract) between the Payer and the Initiating Party has been amended.</td></tr><tr><td>ContractCancellationInitiatedByDebtor</td><td>External arrangement (or contract) cancellation has been initiated by Payer.</td></tr><tr><td>ContractExpired</td><td>External arrangement (or contract) between the Payer and the Initiating Party has expired.</td></tr><tr><td>FinalPaymentCompleted</td><td>Suspended/Cancelled as final payment has been completed successfully.</td></tr><tr><td>OneOffPaymentCompleted</td><td>Suspended/Cancelled as one-off payment has been completed successfully</td></tr><tr><td>TooManyConsecutiveUnsuccessfulPayments</td><td>Suspended/Cancelled due to multiple consecutive unsuccessful payment attempts.</td></tr><tr><td>NoResponseFromPayer</td><td>Payer did not respond within the expected timeframe.</td></tr><tr><td>UnapprovedAgreementValidityExpired</td><td>Validity of the agreement has expired before Payer authorisation.</td></tr><tr><td>UnknownReason</td><td>Suspended/Cancelled due to unknown reason.</td></tr></table>'
          example: RequestedByPayer
        status_reason_description:
          type: string
          description: Description of the reason code of the associated status.
        created_at:
          type: string
          description: creation date.
          example: '2022-03-21 16:25:00.190831'
        updated_at:
          type: string
          description: modification date.
          example: '2022-03-22 16:25:00.190831'
        agreement_info:
          $ref: '#/components/schemas/AgreementInfo'
      description: "Definition of the agreement details response. \n\n **Property descriptions**: \n\n - **agreement_uuid** - Unique ID, used to unambiguously identify the agreement.\n - **user_external_id** - User External Id is the unique identifier of the user with whom the agreement should be associated.\n - **status** - Current status of the agreement.\n - **status_description** - Detailed description of the associated status.\n - **status_reason_code** - Reason code for the current status.\n - **status_reason_description** - Reason description if any, provided by the debtor while suspending or cancelling the agreement via banking portal.\n - **created_at** - Date representation of the initial creation of the agreement.\n - **updated_at** - Date representation of the last update of the agreement.\n - **agreement_info** - Details (creditor, debtor, payment terms) which should be agreed between debtor and creditor."
    DebtorInfo:
      type: object
      properties:
        debtor_account_details:
          $ref: '#/components/schemas/DebtorAccountDetails'
        debtor_details:
          $ref: '#/components/schemas/DebtorDetails'
      description: "Debtor and Debtor Account Details.\n\n **Property descriptions**: \n\n - **debtor_account_details** - Debtor Account Details.\n - **debtor_details** - Debtor Details."
    AmendMaximumAmountInformation:
      type: object
      properties:
        amount:
          maxLength: 19
          minLength: 1
          pattern: ^(?=.{1,19}$)[1-9]{1}[0-9]{0,18}$
          type: string
          description: "Specifies an amount in cents.\n\n\n   - For FIXE type of agreements, as the amount to be debited is fixed, this indicates the amount to be debited per payment.\n   - For BALN type of agreements, as the amount to be debited is fixed for all payments (except the last/final payment which can be for a larger amount), this field indicates the amount to be debited for all payments except the final/last.\n   - For USGB/VARI type of agreements, this indicates the minimum amount that can be debited from the account per payment."
          example: '5000'
        currency:
          pattern: ^[A-Z]{3,3}$
          type: string
          description: 'A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".


            Currency of the payment to debit the account.'
          example: AUD
          enum:
          - '{AUD}'
      description: "Represents the maximum amount that may be debited in any single payment initiation. \n\n **Property descriptions**: \n \n - **amount**\n   - For FIXE type of agreements, as the amount to be debited is fixed, this indicates the amount to be debited per payment.\n   - For BALN type of agreements, as the amount to be debited is fixed for all payments (except the last/final payment which can be for a larger amount), this field indicates the amount to be debited for all payments except the final/last.\n   - For USGB/VARI type of agreements, this indicates the minimum amount that can be debited from the account per payment.\n - **currency** - Currency of the payment to debit the account."
    AgreementListResponse:
      type: object
      properties:
        totalCount:
          type: integer
          description: Total number of agreements available
          format: int64
          example: 1
        agreements:
          type: array
          description: List of agreements.
          items:
            $ref: '#/components/schemas/AgreementDetailsResponse'
      description: "List of agreement details. \n"
    LastPaymentInfo:
      type: object
      properties:
        amount:
          type: string
          description: Specifies an amount in cents.
          example: '1000'
        currency:
          pattern: ^[A-Z]{3,3}$
          type: string
          description: A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
          example: AUD
        date:
          pattern: ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)$
          type: string
          description: 'A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. '
          format: yyyy-MM-dd
          example: '2022-04-15'
      description: "If the payment arrangement is such that there is a known final payment amount that differs from the expected \"regular\" or \"recurring\" payment, then the last payment info can be specified in this field. \n\n **Property descriptions**: \n\n - **amount**\n   - For FIXE type of agreements, as the amount to be debited is fixed, this indicates the amount to be debited per payment.\n   - For BALN type of agreements, as the amount to be debited is fixed for all payments (except the last/final payment which can be for a larger amount), this field indicates the amount to be debited for all payments except the final/last.\n   - For USGB/VARI type of agreements, this indicates the minimum amount that can be debited from the account per payment.\n - **currency** - Currency of the payment to debit the account.\n - **date** - If the payment arrangement being established specifies the date (until 23:59:59.999 Australia Sydney time, expressed in the YYYY-MM-DD format) on which payment is expected to be initiated, that date should be specified in this field."
    PaymentAmountInfo:
      type: object
      properties:
        amount:
          type: string
          description: Specifies an amount in cents.
          example: '1000'
        currency:
          pattern: ^[A-Z]{3,3}$
          type: string
          description: A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
          example: AUD
        type:
          title: PaymentAmountType
          type: string
          description: <p>Specific type of payment amount.</p><p>Depending on the use-case for which the payment arrangement is being made, an appropriate amount type should be selected for the agreement as this defines the payments that can be initiated via the agreement.</p> <table><tr><td>Code</td><td>Name</td><td>Description</td></tr><tr><td>FIXE</td><td>Fixed</td><td>Payments should be initiated for fixed amounts i.e. amount specified in the payment instruction must match the “amount” stated in the agreement.</td></tr><tr><td>BALN</td><td>Balloon</td><td>Payments should be initiated for fixed amounts with large final payment amount i.e. for all the payments except the last, amount specified in the payment instruction must match the “amount” stated in the agreement. The last payment can be different and as per terms mentioned in the last payment amount fields (if specified).</td></tr><tr><td>USGB</td><td>UsageBased</td><td>If the amount for the payment varies with usage (example - electricity bill), it is recommended to specify a max amount. If a value is specified in the “amount” field, this would be considered as base/min amount to be paid for each payment. Payments should be initiated as per agreement terms i.e. the amount specified in the payment instruction should be within the “amount” (min) and “maximum amount” stated in the agreement.</td></tr><tr><td>VARI</td><td>Variable</td><td>If the amount for the payment varies each time (example - grocery purchase billing), it is recommended to specify a max amount. If a value is specified in the “amount” field, this would be considered as base/min amount to be paid for each payment. Payments should be initiated as per agreement terms i.e. the amount specified in the payment instruction should be within the “amount” (min) and “maximum amount” stated in the agreement.</td></tr></table>
          enum:
          - BALN
          - FIXE
          - USGB
          - VARI
      description: "Specifies info around the amount type for the agreement (example: Fixed or Usage based amounts etc), amount that can be debited from the account depending on the type, and the currency in which the payments can be initiated. \n \n **Property descriptions**: \n \n - **amount**\n   - For FIXE type of agreements, as the amount to be debited is fixed, this indicates the amount to be debited per payment.\n   - For BALN type of agreements, as the amount to be debited is fixed for all payments (except the last/final payment which can be for a larger amount), this field indicates the amount to be debited for all payments except the final/last.\n   - For USGB/VARI type of agreements, this indicates the minimum amount that can be debited from the account per payment.\n - **currency** - Currency of the payment to debit the account. \n - **type** - Depending on the use-case for which the payment arrangement is being made, an appropriate amount type should be selected for the agreement as this defines the payments that can be initiated via the agreement.\n \n   Supported values: \n   - FIXE - Payments should be initiated for fixed amounts i.e. amount specified in the payment instruction must match the “amount” stated in the agreement.\n   - BALN - Payments should be initiated for fixed amounts with large final payment amount i.e. for all the payments except the last, amount specified in the payment instruction must match the “amount” stated in the agreement. The last payment can be different and as per terms mentioned in the last payment amount fields (if specified).\n   - USGB - If the amount for the payment varies with usage (example - electricity bill), it is recommended to specify a max amount. If a value is specified in the “amount” field, this would be considered as base/min amount to be paid for each payment. Payments should be initiated as per agreement terms i.e. the amount specified in the payment instruction should be within the “amount” (min) and “maximum amount” stated in the agreement.\n   - VARI - If the amount for the payment varies each time (example - grocery purchase billing), it is recommended to specify a max amount. If a value is specified in the “amount” field, this would be considered as base/min amount to be paid for each payment. Payments should be initiated as per agreement terms i.e. the amount specified in the payment instruction should be within the “amount” (min) and “maximum amount” stated in the agreement."
    FirstPaymentInfo:
      type: object
      properties:
        amount:
          type: string
          description: Specifies an amount in cents.
          example: '1000'
        currency:
          pattern: ^[A-Z]{3,3}$
          type: string
          description: A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
          example: AUD
        date:
          pattern: ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)$
          type: string
          description: A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.
          format: yyyy-MM-dd
          example: '2022-04-15'
      description: "If the payment arrangement is such that the initial payment amount differs from the expected \"regular\" or \"recurring\" payment, then the first payment info can be specified in this field. Examples: Establishment fees are part of the first payment only. \n\n **Property descriptions**: \n \n - **amount**\n   - For FIXE type of agreements, as the amount to be debited is fixed, this indicates the amount to be debited per payment.\n   - For BALN type of agreements, as the amount to be debited is fixed for all payments (except the last/final payment which can be for a larger amount), this field indicates the amount to be debited for all payments except the final/last.\n   - For USGB/VARI type of agreements, this indicates the minimum amount that can be debited from the account per payment.\n - **currency** - Currency of the payment to debit the account.\n - **date** - If the payment arrangement being established specifies the first date (until 23:59:59.999 Australia Sydney time, expressed in the YYYY-MM-DD format) on which payment is expected to be initiated, that date should be specified in this field."
    CreateAgreementResponse:
      type: object
      properties:
        agreement_uuid:
          type: string
          description: Agreement uuid
          example: b2dd5934-478c-45ce-9528-b63c869e6f28
        status:
          type: string
          description: Status of the create agreement request.
          example: PENDING_CREATION
        created_at:
          type: string
          description: creation date.
          example: '2022-03-21 16:25:00.190831'
        updated_at:
          type: string
          description: modification date.
          example: '2022-03-22 16:25:00.190831'
    CreditorAccountDetails:
      type: object
      properties:
        account_id:
          type: string
          description: Specifies a character string with a maximum length of 34 ASCII printable characters.
          example: '123456789'
        account_id_type:
          title: AccountIdType
          type: string
          description: <p>Specifies the type of account identification:</p><table><tr><td>Code</td><td>Description</td></tr><tr><td>BBAN</td><td>Basic Bank Account Number</td></tr><tr><td>PAYID</td><td>Payid Identification</td></tr></table>
          enum:
          - BBAN
          - PAYID
      description: "Creditor Account Details. \n\n**Property descriptions**: \n - **account_id** - Creditor's actual bank account number (BSB + Account Number).\n - **account_id_type** - Specifies the account id type.\n   Supported values: \n\n   - BBAN (bsb/account)\n   - PAYID"
    PaymentInitiatorInformation:
      required:
      - initiator_id
      - initiator_id_type_code
      - initiator_legal_name
      - initiator_name
      type: object
      properties:
        initiator_id:
          maxLength: 35
          minLength: 1
          type: string
          description: 'Specifies a character string with a maximum length of 35 ASCII printable characters.


            Unique and unambiguous identification of the initiator of the PayTo payment i.e. either platform or any third party details.'
          example: initiator identification
        initiator_id_type_code:
          title: PaymentInitiatorIdTypeCodeEnum
          type: string
          description: "<p>Specifies an alphanumeric string with a length of 4 characters.</p>\n\n Code indicating the identification type of the initiator. For example in the case of a private individual; passport, driver licence, or 100 point check, or in the case of an organisation; LEI, ACN, ABN<table><tr><td>Code</td><td>Description</td></tr><tr><td>ARNU</td><td>Alien Registration Number</td></tr><tr><td>CCPT</td><td>Passport Number</td></tr><tr><td>CUST</td><td>Customer Identification Number</td></tr><tr><td>DRLC</td><td>Drivers License Number</td></tr><tr><td>EMPL</td><td>Employee Identification Number</td></tr><tr><td>NIDN</td><td>National Identity Number</td></tr><tr><td>SOSE</td><td>Social Security Number</td></tr><tr><td>TXID</td><td>Tax Identification Number</td></tr><tr><td>BANK</td><td>Bank Party Identification</td></tr><tr><td>CBID</td><td>Central Bank Identification Number</td></tr><tr><td>CHID</td><td>Clearing Identification Number</td></tr><tr><td>CINC</td><td>Certificate Of Incorporation Number</td></tr><tr><td>COID</td><td>Country Identification Code</td></tr><tr><td>DUNS</td><td>Data Universal Numbering System</td></tr><tr><td>GS1G</td><td>GS1GLN Identifier</td></tr><tr><td>SREN</td><td>SIREN</td></tr><tr><td>SRET</td><td>SIRET</td></tr><tr><td>AUBN</td><td>Australian Business Number (ABN)</td></tr><tr><td>AUCN</td><td>Australian Company Number (ACN)</td></tr><tr><td>LEIN</td><td>Legal Entity Identification (LEI)</td></tr></table>"
          enum:
          - AUBN
          - CCPT
          - CUST
          - DRLC
          - EMPL
          - NIDN
          - SOSE
          - TXID
          - BANK
          - CBID
          - CHID
          - CINC
          - COID
          - DUNS
          - GS1G
          - SREN
          - SRET
          - AUBN
          - AUCN
          - LEIN
        initiator_legal_name:
          maxLength: 140
          minLength: 1
          type: string
          description: 'Specifies a character string with a maximum length of 140 ASCII printable characters.


            Name by which the initiator is known and which is usually used to identify them i.e. either platform’s name or any third party details.'
          example: initiator legal name
        initiator_name:
          maxLength: 140
          minLength: 1
          type: string
          description: 'Specifies a character string with a maximum length of 140 ASCII printable characters.


            Name by which the initiator is known and which is usually used to identify them i.e. either platform’s name or any third party details.'
          example: initiator name
      description: "Initiating party details. \n  \nYour platform name or any third party name that you prefer to be shown to the debtor as initiator of the payments. Example - If it’s a proptech platform, either your platform’s details should be provided or the property management agency details to convey that the platform or the agency is collecting the rent from the tenant/debtor’s bank account via PayTo payment option.\n\nPlease Note - It is essential to provide correct and appropriate details in these fields as they would be visible to the debtor in their banking portal.\n\nPlease refrain from providing “Zai” or any random text as initiator. This can lead to claims being raised by the debtor if they do not recognise the party provided as initiator.\n\n**Property descriptions:** \n - **initiator_id** - Unique and unambiguous identification of the initiator of the PayTo payment i.e. either platform or any third party details.\n - **initiator_id_type_code** - Code indicating the identification type of the initiator. For example in the case of a private individual; passport, driver licence, or 100 point check, or in the case of an organisation; LEI, ACN, ABN\n - **initiator_legal_name** - Name by which the initiator is known and which is usually used to identify them i.e. either platform’s name or any third party details.\n - **initiator_name** - Name by which the initiator is known and which is usually used to identify them i.e. either platform’s name or any third party details.\n   - Please Note - The debtor will be able to see this information in the agreement. Hence it is essential to provide appropriate information in this field which is easily identifiable by the debtor to avoid claims."
    ErrorDetails:
      type: object
      properties:
        error_code:
          type: string
        error_message:
          type: string
    AmendAgreementDetailsRequest:
      required:
      - priority
      type: object
      properties:
        priority:
          title: Priority
          type: string
          description: "<p>Identifies the arrangement (attended or unattended).</p> \n\nPriority of the agreement amendment authorisation notification to be sent to the user for approval.<table><tr><td>Code</td><td>Description</td></tr><tr><td>ATTENDED</td><td>If the marketplace wants the debtor user to be notified about the agreement amendment authorisation action immediately, the priority should be set as Attended.</td></tr><tr><td>UNATTENDED</td><td>If the marketplace wants the debtor user to be notified about the agreement amendment authorisation at an appropriate time (not immediately), the priority should be set as Unattended.</td></tr></table>"
          enum:
          - ATTENDED
          - UNATTENDED
        response_requested_by:
          pattern: ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.[0-9]{1,3})?(?:Z)$
          type: string
          description: 'A date expressed in the YYYY-MM-DD''T''HH:mm:ss[.SSS][.SS][.S]''Z'' format and in Australia timezone.


            This field can be used to specify a custom expiry duration for the authorisation request pending debtor’s approval. Any duration which is less than the default & max duration of 5 days will be accepted. Example - If you want the debtor to approve the changes proposed on the agreement within 15 mins post creation, mention the duration in this field accordingly. However, post the duration (after 15 mins), you would need to invoke the Recall API to expire this authorisation request.'
          format: yyyy-MM-dd'T'HH:mm:ss[.SSS][.SS][.S]'Z'
          example: '2022-11-04T06:24:34.214Z'
        unilateral_amendments:
          $ref: '#/components/schemas/UnilateralAmendments'
        bilateral_amendments:
          $ref: '#/components/schemas/BilateralAmendments'
      description: "Request to amend the details of an agreement.\n\n **Property descriptions**: \n - **priority** - Priority of the agreement amendment authorisation notification to be sent to the user for approval. Supported values:\n    - **Attended** - If the marketplace wants the debtor user to be notified about the agreement amendment authorisation action immediately, the priority should be set as Attended.\n    - **Unattended** - If the marketplace wants the debtor user to be notified about the agreement amendment authorisation at an appropriate time (not immediately), the priority should be set as Unattended.\n- **response_requested_by** - This field can be used to specify a custom expiry duration for the authorisation request pending debtor’s approval. Any duration which is less than the default & max duration of 5 days will be accepted. Example - If you want the debtor to approve the changes proposed on the agreement within 15 mins post creation, mention the duration in this field accordingly. However, post the duration (after 15 mins), you would need to invoke the Recall API to expire this authorisation request.\n\n- **unilateral_amendments** - Specifies fields for which amendments are effective immediately and do not require debtor authorisation.\n- **bilateral_amendments** - Specifies fields for which amendments are effective only post debtor authorisation."
    AmendLastPaymentInformation:
      type: object
      properties:
        amount:
          maxLength: 19
          minLength: 1
          pattern: ^(?=.{1,19}$)[1-9]{1}[0-9]{0,18}$
          type: string
          description: "Specifies an amount in cents.\n\n\n   - For FIXE type of agreements, as the amount to be debited is fixed, this indicates the amount to be debited per payment.\n   - For BALN type of agreements, as the amount to be debited is fixed for all payments (except the last/final payment which can be for a larger amount), this field indicates the amount to be debited for all payments except the final/last.\n   - For USGB/VARI type of agreements, this indicates the minimum amount that can be debited from the account per payment."
          example: '2000'
        currency:
          pattern: ^[A-Z]{3,3}$
          type: string
          description: 'A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".


            Currency of the payment to debit the account.'
          example: AUD
          enum:
          - '{AUD}'
        date:
          pattern: ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)$
          type: string
          description: 'A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.


            If the payment arrangement being established specifies the date (until 23:59:59.999 Australia Sydney time, expressed in the YYYY-MM-DD format) on which payment is expected to be initiated, that date should be specified in this field. Setting this property to "-" indicates that the date is to be cleared on the agreement.'
          format: yyyy-MM-dd
          example: '2022-04-15'
      description: "If the payment arrangement is such that there is a known final payment amount that differs from the expected \"regular\" or \"recurring\" payment, then the last payment info can be specified in this field. \n\n **Property descriptions**: \n \n - **amount**\n   - For FIXE type of agreements, as the amount to be debited is fixed, this indicates the amount to be debited per payment.\n   - For BALN type of agreements, as the amount to be debited is fixed for all payments (except the last/final payment which can be for a larger amount), this field indicates the amount to be debited for all payments except the final/last.\n   - For USGB/VARI type of agreements, this indicates the minimum amount that can be debited from the account per payment.\n - **currency** - Currency of the payment to debit the account.\n - **date** - If the payment arrangement being established specifies the date (until 23:59:59.999 Australia Sydney time, expressed in the YYYY-MM-DD format) on which payment is expected to be initiated, that date should be specified in this field. Setting this property to \"-\" indicates that the date is to be cleared on the agreement."
    DebtorAccountInformation:
      required:
      - account_id_type
      type: object
      properties:
        account_id_type:
          title: AccountIdentificationTypeCodeEnum
          type: string
          description: '<p>Specifies the type of account identification.


            Debtor''s bank account type</p><table><tr><td>Code</td><td>Description</td></tr><tr><td>BBAN</td><td>Basic Bank Account Number</td></tr><tr><td>PAYID</td><td>Pay Id</td></tr>'
          example: PAYID
          enum:
          - BBAN
          - PAYID
        account_id:
          maxLength: 34
          minLength: 10
          type: string
          description: 'Specifies a character string with a maximum length of 34 ASCII printable characters.


            Debtor''s actual bank account number (BSB + Account Number).'
          example: 033547123456789
        payid_details:
          $ref: '#/components/schemas/DebtorAccountPayidInformation'
      description: "Debtor Account Details.\n \n **Property descriptions**: \n \n - **account_id_type** - Debtor's bank account type.\n   Supported values: \n \n   - BBAN (bsb/account)\n   - PAYID (PayID)\n - **account_id** - Debtor's actual bank account number (BSB + Account Number).\n - **debtor_account_payid_details** - Debtor account PayID Details. \n\n \n The following rules apply to this structure: \n - <strong>AccountIdentificationRule1:</strong> If account_id_type is not equal to value 'PAYID' then account_id must be present, and payid_type and payid must be absent. \n - <strong>AccountIdentificationRule2:</strong> If account_id_type is equal to value 'PAYID' then payid_type and payid must be present, and account_id must be absent.  \n - <strong>AccountIdentificationRule3:</strong> When account_id_type is 'BBAN', the account_id field should contain BSB in the first 6 positions followed by the account number. \n   String with minimum length of 13 characters should be provided."
    PaymentTerms:
      type: object
      properties:
        payment_amount_info:
          $ref: '#/components/schemas/PaymentAmountInfo'
        first_payment_info:
          $ref: '#/components/schemas/FirstPaymentInfo'
        last_payment_info:
          $ref: '#/components/schemas/LastPaymentInfo'
        maximum_amount_info:
          $ref: '#/components/schemas/MaximumAmountInfo'
        payment_executed_not_before_time:
          type: string
          description: Specifies a time in the format HH:mm:ssZ.
          example: 02:30:19Z
        point_in_time:
          type: string
          description: Specifies a number in string format upto two digit.
          example: '24'
        count_per_period:
          type: string
          description: Specifies a valid non decimal numeric value.
          example: '10'
        frequency:
          title: PaymentFrequency
          type: string
          description: '<p>Represents the typical expected frequency with which payments will be initiated against the debtor for this arrangement:</p>

            <table><tr><td>Code</td><td>Name</td><td>Description</td></tr><tr><td>ADHOC</td><td>Adhoc</td><td>Event takes place on request or as necessary.</td></tr><tr><td>INTRDY</td><td>IntraDay</td><td>Event takes place several times a day.</td></tr><tr><td>DAILY</td><td>Daily</td><td>Event takes place every day.</td></tr><tr><td>WEEKLY</td><td>Weekly</td><td>Event takes place once a week.</td></tr><tr><td>FRTNLY</td><td>Fortnightly</td><td>Event takes place every two weeks.</td></tr><tr><td>MNTHLY</td><td>Monthly</td><td>Event takes place every month or once a month.</td></tr><tr><td>QURTLY</td><td>Quarterly</td><td>Event takes place every three months or four times a year.</td></tr><tr><td>HFYRLY</td><td>HalfYearly</td><td>Event takes place every six months or two times a year.</td></tr><tr><td>YEARLY</td><td>Annual</td><td>Event takes place every year or once a year.</td></tr></table>'
          example: INTRDY
          enum:
          - ADHOC
          - INTRDY
          - DAILY
          - WEEKLY
          - FRTNLY
          - MNTHLY
          - QURTLY
          - HFYRLY
          - YEARLY
      description: "Specifies payment terms for the agreement i.e. amount that can be debited per payment, min/max amounts, first and last payment terms etc.\nAll the payments initiated should be as per agreement terms.\n\nIt is very important to ensure the payments initiated **DO NOT BREACH** the agreement terms and conditions - this could lead to:\n\n- Agreement claims by debtor/payer for an amount greater than the actual payment amount\n\n **Property descriptions**: \n\n - **payment_amount_info** - Specifies info around the amount type for the agreement (example: Fixed or Usage based amounts etc), amount that can be debited from the account depending on the type, and the currency in which the payments can be initiated.\n - **first_payment_info** - If the payment arrangement is such that the initial payment amount differs from the expected \"regular\" or \"recurring\" payment, then the first payment info can be specified in this field. Examples: Establishment fees are part of the first payment only.\n - **last_payment_info** - If the payment arrangement is such that there is a known final payment amount that differs from the expected \"regular\" or \"recurring\" payment, then the last payment info can be specified in this field. \n - **maximum_amount** - Represents the maximum amount that may be debited in any single payment initiation.\n - **payment_executed_not_before_time** - Specifies the Australia Sydney time after which payments may be initiated on the execution day (according to the frequency and other payment terms).\n Example - Payroll scenario, where the employer requests to not initiate payrolls until a particular time to ensure funds are available for the payment to occur.\n - **point_in_time** - Qualifies the frequency in terms of an exact point in time or moment within the specified period. The granularity of point in time is a subdivision of frequency. \n   - Frequency=Adhoc -> point in time is not applicable\n   - Frequency=IntraDay -> Point In Time = hour within day (1-24)\n   - Frequency=Daily -> Point In Time = hour within day (1-24))\n   - Frequency=Weekly -> Point In Time = day of week (1-7)\n   - Frequency=Fortnightly -> Point In Time = day within fortnight (1-14)\n   - Frequency=Monthly -> Point In Time = day of month (1- last day of month)\n   - Frequency=Quarterly -> Point In Time = which month within the quarter of year (1-4)\n   - Frequency=HalfYearly -> Point In Time = which month within the half of the year (1-6)\n   - Frequency=Yearly -> Point In Time = month within the year (1-12)\n - **count_per_period** - Defines the number of authorised expected payments that are to be initiated according to the frequency.\n Example - With Frequency = Adhoc, Count Per Period can be used to specify a total number of allowed initiations.\n - **frequency** - Represents the typical expected frequency with which payments will be initiated against the debtor for this arrangement. \n\n   Must be one of following: \n \n   - Adhoc (Event takes place on request or as necessary)\n   - Intraday (Event takes place several times a day)\n   - Daily (Event takes place every day)\n   - Weekly (Event takes place once a week)\n   - Fortnightly (Event takes place every two weeks)\n   - Monthly (Event takes place every month)\n   - Quarterly (Event takes place every three months)\n   - HalfYearly (Event takes place every six months or two times a year)\n   - Yearly (Event takes place every year or once a year)"
    PayToErrorResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ErrorDetails'
    AmendPaymentInitiatorInformation:
      type: object
      properties:
        initiator_id:
          maxLength: 35
          minLength: 1
          type: string
          description: 'Specifies a character string with a maximum length of 35 ASCII printable characters.


            Unique and unambiguous identification of the initiator.'
          example: initiator identification
        initiator_id_type_code:
          title: PaymentInitiatorIdTypeCodeEnum
          type: string
          description: '<p>Specifies an alphanumeric string with a length of 4 characters.</p>


            Code indicating the identification type of the initiator.For example in the case of a private individual; passport, driver licence, or 100 point check, or in the case of an organisation; LEI, ACN, ABN<table><tr><td>Code</td><td>Description</td></tr><tr><td>ARNU</td><td>Alien Registration Number</td></tr><tr><td>CCPT</td><td>Passport Number</td></tr><tr><td>CUST</td><td>Customer Identification Number</td></tr><tr><td>DRLC</td><td>Drivers License Number</td></tr><tr><td>EMPL</td><td>Employee Identification Number</td></tr><tr><td>NIDN</td><td>National Identity Number</td></tr><tr><td>SOSE</td><td>Social Security Number</td></tr><tr><td>TXID</td><td>Tax Identification Number</td></tr><tr><td>BANK</td><td>Bank Party Identification</td></tr><tr><td>CBID</td><td>Central Bank Identification Number</td></tr><tr><td>CHID</td><td>Clearing Identification Number</td></tr><tr><td>CINC</td><td>Certificate Of Incorporation Number</td></tr><tr><td>COID</td><td>Country Identification Code</td></tr><tr><td>DUNS</td><td>Data Universal Numbering System</td></tr><tr><td>GS1G</td><td>GS1GLN Identifier</td></tr><tr><td>SREN</td><td>SIREN</td></tr><tr><td>SRET</td><td>SIRET</td></tr><tr><td>AUBN</td><td>Australian Business Number (ABN)</td></tr><tr><td>AUCN</td><td>Australian Company Number (ACN)</td></tr><tr><td>LEIN</td><td>Legal Entity Identification (LEI)</td></tr></table>'
          enum:
          - AUBN
          - CCPT
          - CUST
          - DRLC
          - EMPL
          - NIDN
          - SOSE
          - TXID
          - BANK
          - CBID
          - CHID
          - CINC
          - COID
          - DUNS
          - GS1G
          - SREN
          - SRET
          - AUBN
          - AUCN
          - LEIN
        initiator_legal_name:
          maxLength: 140
          minLength: 1
          type: string
          description: 'Specifies a character string with a maximum length of 140 ASCII printable characters.


            Name by which the initiator is legally known.'
          example: initiator legal name
        initiator_name:
          maxLength: 140
          minLength: 1
          type: string
          description: 'Specifies a character string with a maximum length of 140 ASCII printable characters.


            Name by which the initiator is known and which is usually used to identify them.'
          example: initiator name
      description: "Initiating party details. \n  \n**Property descriptions**: \n - **initiator_id** - Unique and unambiguous identification of the initiator.\n - **initiator_id_type_code** - Code indicating the identification type of the initiator.For example in the case of a private individual; passport, driver licence, or 100 point check, or in the case of an organisation; LEI, ACN, ABN\n - **initiator_legal_name** - Name by which the initiator is legally known.\n - **initiator_name** - Name by which the initiator is known and which is usually used to identify them."
    AmendAgreementStatusRequest:
      required:
      - status
      type: object
      properties:
        status:
          title: Status
          type: string
          description: "<p>Identifies the agreement status.</p> \n<table><tr><td>Code</td><td>Description</td></tr><tr><td>CANCELLED</td><td>Cancel the agreement</td></tr><tr><td>SUSPENDED</td><td>Suspend the agreement</td></tr><tr><td>ACTIVE</td><td>Activate the agreement</td></tr></table><p>Expected status of the agreement post amendment.</p>"
          example: SUSPENDED
          enum:
          - CANCELLED
          - SUSPENDED
          - ACTIVE
        reason_code:
          title: ReasonCode
          type: string
          description: "<p>Reason for status amendment. Supported values:</p> \n<table><tr><td>Code</td><td>Description</td></tr><tr><td>REQCUST</td><td>Requested by Debtor</td></tr><tr><td>REQINTPRTY</td><td>Requested by Initiating Party</td></tr></table>"
          enum:
          - REQCUST
          - REQINTPRTY
        reason_description:
          maxLength: 256
          minLength: 1
          type: string
          description: 'Specifies a character string with a maximum length of 256 characters.


            Amendment reason description'
          example: Reason description
      description: 'Request to change the status of an agreement.


        **Property descriptions**:

        - status - Expected status of the agreement post amendment.

        - reason_code - Reason for status amendment.

        - reason_description - Amendment reason description.


        **The following rules apply to this structure**:

        - ReasonCodeRule: reason_code is mandatory if agreement needs to be ''CANCELLED'' or ''SUSPENDED''.'
    PaymentTermsDetails:
      required:
      - frequency
      - payment_amount_info
      type: object
      properties:
        payment_amount_info:
          $ref: '#/components/schemas/PaymentAmountInformation'
        first_payment_info:
          $ref: '#/components/schemas/FirstPaymentInformation'
        last_payment_info:
          $ref: '#/components/schemas/LastPaymentInformation'
        maximum_amount_info:
          $ref: '#/components/schemas/MaximumAmountInformation'
        payment_executed_not_before_time:
          pattern: ^(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.[0-9]{1,3})?Z$
          type: string
          description: 'Specifies a time in the format HH:mm:ssZ.


            Specifies the Australia Sydney time after which payments may be initiated on the execution day (according to the frequency and other payment terms). Example - Payroll scenario, where the employer requests to not initiate payrolls until a particular time to ensure funds are available for the payment to occur.'
          example: 02:30:19Z
        point_in_time:
          pattern: ^[0-9]\d?$
          type: string
          description: 'Specifies a number in string format up to two digit.


            Qualifies the frequency in terms of an exact point in time or moment within the specified period. The granularity of point in time is a subdivision of frequency.'
          example: '24'
        count_per_period:
          pattern: ^(?=.{1,19}$)[1-9]{1}[0-9]{0,18}$
          type: string
          description: 'Specifies a valid non decimal numeric value.


            Defines the number of authorised expected payments that are to be initiated according to the frequency. Example - With Frequency = Adhoc, Count Per Period can be used to specify a total number of allowed initiations.'
          example: '10'
        frequency:
          title: PaymentFrequency
          type: string
          description: '<p>Represents the typical expected frequency with which payments will be initiated against the debtor for this arrangement.</p>

            <table><tr><td>Code</td><td>Name</td><td>Description</td></tr><tr><td>ADHOC</td><td>Adhoc</td><td>Event takes place on request or as necessary.</td></tr><tr><td>INTRDY</td><td>IntraDay</td><td>Event takes place several times a day.</td></tr><tr><td>DAILY</td><td>Daily</td><td>Event takes place every day.</td></tr><tr><td>WEEKLY</td><td>Weekly</td><td>Event takes place once a week.</td></tr><tr><td>FRTNLY</td><td>Fortnightly</td><td>Event takes place every two weeks.</td></tr><tr><td>MNTHLY</td><td>Monthly</td><td>Event takes place every month or once a month.</td></tr><tr><td>QURTLY</td><td>Quarterly</td><td>Event takes place every three months or four times a year.</td></tr><tr><td>HFYRLY</td><td>HalfYearly</td><td>Event takes place every six months or two times a year.</td></tr><tr><td>YEARLY</td><td>Yearly</td><td>Event takes place every year or once a year.</td></tr></table>'
          example: INTRDY
          enum:
          - ADHOC
          - INTRDY
          - DAILY
          - WEEKLY
          - FRTNLY
          - MNTHLY
          - QURTLY
          - HFYRLY
          - YEARLY
      description: "Specifies payment terms for the agreement i.e. amount that can be debited per payment, min/max amounts, first and last payment terms etc.\nAll the payments initiated should be as per agreement terms.\n\nIt is very important to ensure the payments initiated **DO NOT BREACH** the agreement terms and conditions - this could lead to:\n\n- Agreement claims by debtor/payer for an amount greater than the actual payment amount\n\n **Property descriptions**: \n \n - **payment_amount_info** - Specifies info around the amount type for the agreement (example: Fixed or Usage based amounts etc), amount that can be debited from the account depending on the type, and the currency in which the payments can be initiated.\n - **first_payment_info** - If the payment arrangement is such that the initial payment amount differs from the expected \"regular\" or \"recurring\" payment, then the first payment info can be specified in this field. Examples: Establishment fees are part of the first payment only.\n - **last_payment_info** - If the payment arrangement is such that there is a known final payment amount that differs from the expected \"regular\" or \"recurring\" payment, then the last payment info can be specified in this field.\n - **maximum_amount** - Represents the maximum amount that may be debited in any single payment initiation.\n - **payment_executed_not_before_time** - Specifies the Australia Sydney time after which payments may be initiated on the execution day (according to the frequency and other payment terms).\n Example - Payroll scenario, where the employer requests to not initiate payrolls until a particular time to ensure funds are available for the payment to occur.\n - **point_in_time** - Qualifies the frequency in terms of an exact point in time or moment within the specified period. The granularity of point in time is a subdivision of frequency.\n   - Frequency = Adhoc -> point in time is not applicable\n   - Frequency = IntraDay -> Point In Time = hour within day (1-24)\n   - Frequency = Daily -> Point In Time = hour within day (1-24))\n   - Frequency = Weekly -> Point In Time = day of week (1-7)\n   - Frequency = Fortnightly -> Point In Time = day within fortnight (1-14)\n   - Frequency = Monthly -> Point In Time = day of month (1- last day of month)\n   - Frequency = Quarterly -> Point In Time = which month within the quarter of year (1-4)\n   - Frequency = HalfYearly -> Point In Time = which month within the half of the year (1-6)\n   - Frequency = Yearly -> Point In Time = month within the year (1-12)\n - **count_per_period** - Defines the number of authorised expected payments that are to be initiated according to the frequency.\n Example - With Frequency = Adhoc, Count Per Period can be used to specify a total number of allowed initiations.\n - **frequency** - Represents the typical expected frequency with which payments will be initiated against the debtor for this arrangement. \n \n   Must be one of following: \n \n   - Adhoc (Event takes place on request or as necessary)\n   - Intraday (Event takes place several times a day)\n   - Daily (Event takes place every day)\n   - Weekly (Event takes place once a week)\n   - Fortnightly (Event takes place every two weeks)\n   - Monthly (Event takes place every month)\n   - Quarterly (Event takes place every three months)\n   - Half Yearly (Event takes place every six months or two times a year)\n   - Yearly (Event takes place every year or once a year)\n The following rules apply to this structure: \n \n - **AgreementFirstPaymentRule1:** first_payment_date should be between validity_start_date and validity_end_date OR can be same as validity_start_date and validity_end_date.\n - **AgreementLastPaymentRule2:** last_payment_date should be between validity_start_date and validity_end_date OR can be same as validity_start_date and validity_end_date.\n - **CurrencyAUD:** All currencies must be in AUD only.\n - **AmountRule:** All amounts should be less than or equal to Maximum amount.\n - **LastAndFirstPaymentDate:** last_payment_date cannot be less than first_payment_date.\n - **PaymentAmountTypeRule:** If payment_amount_type code is equal to value 'FIXE' then amount must be present.\n - **FrequencyCombinationRule:** The frequency, point_in_time and count_per_period combination must be valid.\n Refer frequency rules table below for valid combinations.\n - **PaymentAmountTypeCombinationRule:** The payment_amount_type, amount and maximum_amount combination must be valid.\n Refer payment amount type rules table below for valid combination. \n \n **Rules for frequency:** \n \n Valid values for frequency, point_in_time and count_per_period are given below.\n <table><tr><td><b>frequency</b></td><td><b>point_in_time</b></td><td><b>count_per_period</b></td></tr><tr><td>ADHOC</td><td>Must not be present</td><td>Valid non decimal numeric value, greater than zero</td></tr><tr><td>INTRDY</td><td>01 to 24</td><td>Not present</td></tr><tr><td>INTRDY</td><td>Not present</td><td>Valid non decimal numeric value, greater than zero</td></tr><tr><td>DAILY</td><td>01 to 24</td><td>Not present</td></tr><tr><td>DAILY</td><td>Not present</td><td>Valid non decimal numeric value, greater than zero</td></tr><tr><td>WEEKLY</td><td>01 to 07</td><td>Not present</td></tr><tr><td>WEEKLY</td><td>Not present</td><td>Valid non decimal numeric value, greater than zero</td></tr><tr><td>FRTNLY</td><td>01 to 14</td><td>Not present</td></tr><tr><td>FRTNLY</td><td>Not present</td><td>Valid non decimal numeric value, greater than zero</td></tr><tr><td>MNTHLY</td><td>01 to 31</td><td>Not present</td></tr><tr><td>MNTHLY</td><td>Not present</td><td>Valid non decimal numeric value, greater than zero</td></tr><tr><td>QURTLY</td><td>01 to 03</td><td>Not present</td></tr><tr><td>QURTLY</td><td>Not present</td><td>Valid non decimal numeric value, greater than zero</td></tr><tr><td>HFYRLY</td><td>01 to 06</td><td>Not present</td></tr><tr><td>HFYRLY</td><td>Not present</td><td>Valid non decimal numeric value, greater than zero</td></tr><tr><td>YEARLY</td><td>01 to 12</td><td>Not present</td></tr><tr><td>YEARLY</td><td>Not present</td><td>Valid non decimal numeric value, greater than zero</td></tr></table>\n \n **Payment amount types rules:** \n <table><tr><td><b>Payment_amount_type</b></td><td><b>amount</b></td><td><b>max_ Amount</b></td><td><b>Remarks</b></td></tr><tr><td>BALN</td><td>Valid numeric value</td><td>NA</td><td>If Balloon, only amount should have values. Max amount should not be present</td></tr><tr><td>FIXE</td><td>Valid numeric value</td><td>NA</td><td>If Fixed, only amount should have values. Max amount should not be present</td></tr><tr><td>USGB</td><td>Valid numeric value</td><td>Valid numeric value</td><td>If Usage based, max amount is recommended.However, amount and max amount are optional and if present, amount should be less than max amount</td></tr><tr><td>VARI</td><td>Valid numeric value</td><td>Valid numeric value</td><td>If Variable, max amount is recommended.However, amount and max amount are optional and if present, amount should be less than max amount</td></tr></table>"
    DebtorAccountPayidDetails:
      type: object
      properties:
        payid_type:
          title: DebtorAccountPayidTypeCode
          type: string
          description: ' <p>PayID type associated with Debtor''s bank account:</p><table><tr><td>Code</td><td>Description</td></tr><tr><td>TELI</td><td>Telephone Number (Note that the ISO Code is TELE, but in AU-NPP context, TELI is used)</td></tr><tr><td>EMAL</td><td>Email Address</td></tr><tr><td>AUBN</td><td>Australian Business Number</td></tr><tr><td>ORGN</td><td>Organisation Identifier</td></tr></table>'
          enum:
          - TELI
          - EMAL
          - AUBN
          - ORGN
        payid:
          type: string
          description: Specifies a character string with a maximum length of 2048 characters.
          example: payid
        payid_name:
          type: string
          description: Specifies a character string with a maximum length of 140 ASCII printable characters.
          example: payidname
      description: "Debtor account PayID Details.\n \n **Property descriptions**: \n\n - **payid_type** - PayID type associated with Debtor's bank account. \n\n   Supported values: \n\n   - EMAL - Email Address\n   - TELE - Telephone Number\n   - AUBN - Australian Business Number\n   - ORGN - Organisational Identifier\n - **payid** - PayID as provided by the debtor.\n - **payid_name** - Debtor user's name registered with the PayID."
    ValidateAgreementResponse:
      type: object
      properties:
        agreement_uuid:
          type: string
          description: Agreement uuid.
          example: b2dd5934-478c-45ce-9528-b63c869e6f28
        status:
          type: string
          description: Status of the validate agreement request.
          example: PENDING_VALIDATION
        created_at:
          type: string
          description: creation date.
          example: '2022-03-21 16:25:00.190831'
        updated_at:
          type: string
          description: modification date.
          example: '2022-03-22 16:25:00.190831'
    AmendAgreementStatusResponse:
      type: object
      properties:
        agreement_uuid:
          type: string
          description: Unique agreement identifier.
          example: ae07556e-22ef-11eb-adc1-0242ac12000
        agreement_id:
          type: string
          description: Unique agreement identifier generated by NPPA.
          example: ef0fcd9799431ef783204966f010603c
        status:
          title: Status
          type: string
          description: "<p>Current status of the agreement before amendment.</p> \n<table><tr><td>Code</td><td>Description</td></tr><tr><td>SUSPENDED</td><td>The agreement is suspended.</td></tr><tr><td>ACTIVE</td><td>The agreement is active.</td></tr></table>"
          example: ACTIVE
          enum:
          - CANCELLED
          - SUSPENDED
          - ACTIVE
        created_at:
          type: string
          description: creation date.
          example: '2022-03-21 16:25:00.190831'
        updated_at:
          type: string
          description: modification date.
          example: '2022-03-22 16:25:00.190831'
      description: Specific characteristics of an agreement status amendment response.
    UnilateralAmendments:
      type: object
      properties:
        description:
          maxLength: 140
          minLength: 1
          type: string
          description: 'Specifies a character string with a maximum length of 140 characters.


            Describes what the agreement is being established for. Examples include a product, particular service offering, etc. If the description is less than 35 characters, then the Short Description should be used instead of the Description field. If this property is omitted then the description will not be modified as part of the amendment. Set this property to "-" to indicate that the description is to be cleared on the agreement.'
          example: Description
        short_description:
          maxLength: 35
          minLength: 1
          type: string
          description: 'Specifies a character string with a maximum length of 35 characters.


            Describes what the agreement is being established for. Examples include a product, particular service offering, etc. If the description is less than 35 characters, then the Short Description should be used instead of the Description field. If this property is omitted then the short description will not be modified as part of the amendment. Set this property to "-" to indicate that the short description is to be cleared on the agreement.'
          example: Short description
        creditor_info:
          $ref: '#/components/schemas/AmendCreditorInformation'
        payment_initiator_info:
          $ref: '#/components/schemas/AmendPaymentInitiatorInformation'
      description: "Specific characteristics about the unilateral fields.\nSpecifies fields for which amendments are effective immediately and do not require debtor authorisation.\n\n **Property descriptions**: \n \n - **description** - Describes what the agreement is being established for. Examples include a product, particular service offering, etc. \n If the description is less than 35 characters, then the Short Description should be used instead of the Description field. If this property is omitted then the description will not be modified as part of the amendment. Set this property to \"-\" to indicate that the description is to be cleared on the agreement. \n - **short_description** - Describes what the agreement is being established for. Examples include a product, particular service offering, etc. If the description is less than 35 characters, then the Short Description should be used instead of the Description field. If this property is omitted then the short description will not be modified as part of the amendment. Set this property to \"-\" to indicate that the short description is to be cleared on the agreement.\n- **creditor_info** - Creditor Details. If this property is omitted then the creditor information will not be modified as part of the amendment.\n- **payment_initiator_info** - Initiating party details. If this property is omitted then the payment initiator information will not be modified as part of the amendment."
    AmendPaymentAmountInformation:
      type: object
      properties:
        amount:
          maxLength: 19
          minLength: 1
          pattern: ^(?=.{1,19}$)[1-9]{1}[0-9]{0,18}$
          type: string
          description: "Specifies an amount in cents.\n\n\n   - For FIXE type of agreements, as the amount to be debited is fixed, this indicates the amount to be debited per payment.\n   - For BALN type of agreements, as the amount to be debited is fixed for all payments (except the last/final payment which can be for a larger amount), this field indicates the amount to be debited for all payments except the final/last.\n   - For USGB/VARI type of agreements, this indicates the minimum amount that can be debited from the account per payment."
          example: '1000'
        currency:
          pattern: ^[A-Z]{3,3}$
          type: string
          description: 'A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".


            Currency of the payment to debit the account.'
          example: AUD
          enum:
          - '{AUD}'
        type:
          title: PaymentAmountType
          type: string
          description: <p>Specific type of payment amount.</p><p>Depending on the use-case for which the payment arrangement is being made, an appropriate amount type should be selected for the agreement as this defines the payments that can be initiated via the agreement.</p> <table><tr><td>Code</td><td>Name</td><td>Description</td></tr><tr><td>FIXE</td><td>Fixed</td><td>Payments should be initiated for fixed amounts i.e. amount specified in the payment instruction must match the “amount” stated in the agreement.</td></tr><tr><td>BALN</td><td>Balloon</td><td>Payments should be initiated for fixed amounts with large final payment amount i.e. for all the payments except the last, amount specified in the payment instruction must match the “amount” stated in the agreement. The last payment can be different and as per terms mentioned in the last payment amount fields (if specified).</td></tr><tr><td>USGB</td><td>UsageBased</td><td>If the amount for the payment varies with usage (example - electricity bill), it is recommended to specify a max amount. If a value is specified in the “amount” field, this would be considered as base/min amount to be paid for each payment. Payments should be initiated as per agreement terms i.e. the amount specified in the payment instruction should be within the “amount” (min) and “maximum amount” stated in the agreement.</td></tr><tr><td>VARI</td><td>Variable</td><td>If the amount for the payment varies each time (example - grocery purchase billing), it is recommended to specify a max amount. If a value is specified in the “amount” field, this would be considered as base/min amount to be paid for each payment. Payments should be initiated as per agreement terms i.e. the amount specified in the payment instruction should be within the “amount” (min) and “maximum amount” stated in the agreement.</td></tr></table>
          enum:
          - BALN
          - FIXE
          - USGB
          - VARI
      description: "Specifies info around the amount type for the agreement (example: Fixed or Usage based amounts etc), amount that can be debited from the account depending on the type, and the currency in which the payments can be initiated. \n \n **Property descriptions**: \n \n - **amount**\n   - For FIXE type of agreements, as the amount to be debited is fixed, this indicates the amount to be debited per payment.\n   - For BALN type of agreements, as the amount to be debited is fixed for all payments (except the last/final payment which can be for a larger amount), this field indicates the amount to be debited for all payments except the final/last.\n   - For USGB/VARI type of agreements, this indicates the minimum amount that can be debited from the account per payment.\n - **currency** - Currency of the payment to debit the account.\n - **type** - Depending on the use-case for which the payment arrangement is being made, an appropriate amount type should be selected for the agreement as this defines the payments that can be initiated via the agreement.\n   Supported values: \n   - FIXE - Payments should be initiated for fixed amounts i.e. amount specified in the payment instruction must match the “amount” stated in the agreement.\n   - BALN - Payments should be initiated for fixed amounts with large final payment amount i.e. for all the payments except the last, amount specified in the payment instruction must match the “amount” stated in the agreement. The last payment can be different and as per terms mentioned in the last payment amount fields (if specified).\n   - USGB - If the amount for the payment varies with usage (example - electricity bill), it is recommended to specify a max amount. If a value is specified in the “amount” field, this would be considered as base/min amount to be paid for each payment. Payments should be initiated as per agreement terms i.e. the amount specified in the payment instruction should be within the “amount” (min) and “maximum amount” stated in the agreement.\n   - VARI - If the amount for the payment varies each time (example - grocery purchase billing), it is recommended to specify a max amount. If a value is specified in the “amount” field, this would be considered as base/min amount to be paid for each payment. Payments should be initiated as per agreement terms i.e. the amount specified in the payment instruction should be within the “amount” (min) and “maximum amount” stated in the agreement."
    AmendPaymentTermsDetails:
      type: object
      properties:
        payment_amount_info:
          $ref: '#/components/schemas/AmendPaymentAmountInformation'
        first_payment_info:
          $ref: '#/components/schemas/AmendFirstPaymentInformation'
        last_payment_info:
          $ref: '#/components/schemas/AmendLastPaymentInformation'
        maximum_amount_info:
          $ref: '#/components/schemas/AmendMaximumAmountInformation'
        payment_executed_not_before_time:
          pattern: ^(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.[0-9]{1,3})?Z$
          type: string
          description: 'Specifies a time in the format HH:mm:ssZ.


            Specifies the Australia Sydney time after which payments may be initiated on the execution day (according to the frequency and other payment terms). Example - Payroll scenario, where the employer requests to not initiate payrolls until a particular time to ensure funds are available for the payment to occur. Setting this property to "-" indicates that the time is to be cleared on the agreement.'
          example: 02:30:19Z
        point_in_time:
          pattern: ^[0-9]\d?$
          type: string
          description: 'Specifies a number in string format up to two digit.


            Qualifies the frequency in terms of an exact point in time or moment within the specified period. The granularity of point in time is a subdivision of frequency. Setting this property to "-" indicates that the point in time is to be cleared on the agreement.<table><tr><td>Frequency</td><td>Description</td></tr><tr><td>Adhoc</td><td>Point in time is not applicable</td></tr><tr><td>IntraDay</td><td>Point In Time = hour within day (1-24))</td></tr><tr><td>Daily</td><td>Point In Time = hour within day (1-24)</td></tr><tr><td>Weekly</td><td>Point In Time = day of week (1-7)</td></tr><tr><td>Fortnightly</td><td>Point In Time = day within fortnight (1-14)</td></tr><tr><td>Monthly</td><td>Point In Time = day of month (1- last day of month)</td></tr><tr><td>Quarterly</td><td>Point In Time = day of month within the quarter of year (1-4)</td></tr><tr><td>HalfYearly</td><td>Point In Time = day of month within the half of the year (1-6)</td></tr><tr><td>Yearly</td><td>Point In Time = month within the year (1-12)</td></tr></table>'
          example: '24'
        count_per_period:
          pattern: ^(?=.{1,19}$)[1-9]{1}[0-9]{0,18}$
          type: string
          description: 'Specifies a valid non decimal numeric value.


            Defines the number of authorised expected payments that are to be initiated according to the frequency. Example - With Frequency = Adhoc, Count Per Period can be used to specify a total number of allowed initiations. Setting this property to "-" indicates that the count per period is to be cleared on the agreement.'
          example: '10'
        frequency:
          title: PaymentFrequency
          type: string
          description: '<p>Represents the typical expected frequency with which payments will be initiated against the debtor for this arrangement.</p>

            <table><tr><td>Code</td><td>Name</td><td>Description</td></tr><tr><td>ADHOC</td><td>Adhoc</td><td>Event takes place on request or as necessary.</td></tr><tr><td>INTRDY</td><td>IntraDay</td><td>Event takes place several times a day.</td></tr><tr><td>DAILY</td><td>Daily</td><td>Event takes place every day.</td></tr><tr><td>WEEKLY</td><td>Weekly</td><td>Event takes place once a week.</td></tr><tr><td>FRTNLY</td><td>Fortnightly</td><td>Event takes place every two weeks.</td></tr><tr><td>MNTHLY</td><td>Monthly</td><td>Event takes place every month or once a month.</td></tr><tr><td>QURTLY</td><td>Quarterly</td><td>Event takes place every three months or four times a year.</td></tr><tr><td>HFYRLY</td><td>HalfYearly</td><td>Event takes place every six months or two times a year.</td></tr><tr><td>YEARLY</td><td>Yearly</td><td>Event takes place every year or once a year.</td></tr></table>'
          example: INTRDY
          enum:
          - ADHOC
          - INTRDY
          - DAILY
          - WEEKLY
          - FRTNLY
          - MNTHLY
          - QURTLY
          - HFYRLY
          - YEARLY
      description: "Specifies payment terms for the agreement i.e. amount that can be debited per payment, min/max amounts, first and last payment terms etc.\nAll the payments initiated should be as per agreement terms.\n\nIt is very important to ensure the payments initiated **DO NOT BREACH** the agreement terms and conditions - this could lead to:\n\n- Agreement claims by debtor/payer for an amount greater than the actual payment amount\n\n **Property descriptions**: \n \n - **payment_amount_info** - Specifies info around the amount type for the agreement (example: Fixed or Usage based amounts etc), amount that can be debited from the account depending on the type, and the currency in which the payments can be initiated.\n - **first_payment_info** - If the payment arrangement is such that the initial payment amount differs from the expected \"regular\" or \"recurring\" payment, then the first payment info can be specified in this field. Examples: Establishment fees are part of the first payment only.\n - **last_payment_info** - If the payment arrangement is such that there is a known final payment amount that differs from the expected \"regular\" or \"recurring\" payment, then the last payment info can be specified in this field.\n - **maximum_amount** - Represents the maximum amount that may be debited in any single payment initiation.\n - **payment_executed_not_before_time** - Specifies the Australia Sydney time after which payments may be initiated on the execution day (according to the frequency and other payment terms).\n Example - Payroll scenario, where the employer requests to not initiate payrolls until a particular time to ensure funds are available for the payment to occur.\n Setting this property to \"-\" indicates that the time is to be cleared on the agreement.\n - **point_in_time** - Qualifies the frequency in terms of an exact point in time or moment within the specified period. The granularity of point in time is a subdivision of frequency. Setting this property to \"-\" indicates that the point in time is to be cleared on the agreement.\n   - Frequency = Adhoc -> point in time is not applicable\n   - Frequency = IntraDay -> Point In Time = hour within day (1-24)\n   - Frequency = Daily -> Point In Time = hour within day (1-24))\n   - Frequency = Weekly -> Point In Time = day of week (1-7)\n   - Frequency = Fortnightly -> Point In Time = day within fortnight (1-14)\n   - Frequency = Monthly -> Point In Time = day of month (1- last day of month)\n   - Frequency = Quarterly -> Point In Time = which month within the quarter of year (1-4)\n   - Frequency = HalfYearly -> Point In Time = which month within the half of the year (1-6)\n   - Frequency = Yearly -> Point In Time = month within the year (1-12)\n - **count_per_period** - Defines the number of authorised expected payments that are to be initiated according to the frequency.\n Example - With Frequency = Adhoc, Count Per Period can be used to specify a total number of allowed initiations.\n Setting this property to \"-\" indicates that the count per period is to be cleared on the agreement.\n - **frequency** - Represents the typical expected frequency with which payments will be initiated against the debtor for this arrangement. \n \n   Must be one of following: \n \n   - Adhoc (Event takes place on request or as necessary)\n   - Intraday (Event takes place several times a day)\n   - Daily (Event takes place every day)\n   - Weekly (Event takes place once a week)\n   - Fortnightly (Event takes place every two weeks)\n   - Half Yearly (Event takes place every six months or two times a year)\n   - Monthly (Event takes place every month)\n   - Quarterly (Event takes place every three months)\n   - Yearly (Event takes place every year or once a year)\n **The following rules apply to this structure:** \n \n - **AgreementFirstPaymentRule1:** Date provided in first_payment_info should be between validity_start_date and validity_end_date OR can be same as validity_start_date and validity_end_date.\n - **AgreementLastPaymentRule2:** Date provided in last_payment_info should be between validity_start_date and validity_end_date OR can be same as validity_start_date and validity_end_date.\n - **LastAndFirstPaymentDate:** Date provided in last_payment_info should be same OR after the date provided in first_payment_info.\n - **CurrencyAUD:** All currencies must be in AUD only.\n - **AmountRule:** All amounts should be less than or equal to Maximum amount.\n - **PaymentAmountTypeRule:** If payment_amount_type code is equal to value 'FIXE' then amount must be present.\n - **FrequencyCombinationRule:** The frequency, point_in_time and count_per_period combination must be valid.\n Refer frequency rules table below for valid combinations.\n - **PaymentAmountTypeCombinationRule:** The payment_amount_type, amount and maximum_amount combination must be valid.\n Refer payment amount type rules table below for valid combination. \n\n **Rules for frequency:** \n\n Valid values for frequency, point_in_time and count_per_period are given below.\n <table><tr><td><b>frequency</b></td><td><b>point_in_time</b></td><td><b>count_per_period</b></td></tr><tr><td>ADHOC</td><td>Must not be present</td><td>Valid non decimal numeric value, greater than zero</td></tr><tr><td>INTRDY</td><td>01 to 24</td><td>Not present</td></tr><tr><td>INTRDY</td><td>Not present</td><td>Valid non decimal numeric value, greater than zero</td></tr><tr><td>DAILY</td><td>01 to 24</td><td>Not present</td></tr><tr><td>DAILY</td><td>Not present</td><td>Valid non decimal numeric value, greater than zero</td></tr><tr><td>WEEKLY</td><td>01 to 07</td><td>Not present</td></tr><tr><td>WEEKLY</td><td>Not present</td><td>Valid non decimal numeric value, greater than zero</td></tr><tr><td>FRTNLY</td><td>01 to 14</td><td>Not present</td></tr><tr><td>FRTNLY</td><td>Not present</td><td>Valid non decimal numeric value, greater than zero</td></tr><tr><td>MNTHLY</td><td>01 to 31</td><td>Not present</td></tr><tr><td>MNTHLY</td><td>Not present</td><td>Valid non decimal numeric value, greater than zero</td></tr><tr><td>QURTLY</td><td>01 to 03</td><td>Not present</td></tr><tr><td>QURTLY</td><td>Not present</td><td>Valid non decimal numeric value, greater than zero</td></tr><tr><td>HFYRLY</td><td>01 to 06</td><td>Not present</td></tr><tr><td>HFYRLY</td><td>Not present</td><td>Valid non decimal numeric value, greater than zero</td></tr><tr><td>YEARLY</td><td>01 to 12</td><td>Not present</td></tr><tr><td>YEARLY</td><td>Not present</td><td>Valid non decimal numeric value, greater than zero</td></tr></table>\n \n **Payment amount types rules:** \n <table><tr><td><b>Payment_amount_type</b></td><td><b>amount</b></td><td><b>max_ Amount</b></td><td><b>Remarks</b></td></tr><tr><td>BALN</td><td>Valid numeric value</td><td>NA</td><td>If Balloon, only amount should have values. Max amount should not be present</td></tr><tr><td>FIXE</td><td>Valid numeric value</td><td>NA</td><td>If Fixed, only amount should have values. Max amount should not be present</td></tr><tr><td>USGB</td><td>Valid numeric value</td><td>Valid numeric value</td><td>If Usage based, max amount is recommended.However, amount and max amount are optional and if present, amount should be less than max amount</td></tr><tr><td>VARI</td><td>Valid numeric value</td><td>Valid numeric value</td><td>If Variable, max amount is recommended.However, amount and max amount are optional and if present, amount should be less than max amount</td></tr></table>"
    AmendCreditorInformation:
      type: object
      properties:
        ultimate_creditor_name:
          maxLength: 140
          minLength: 1
          type: string
          description: 'Specifies a character string with a maximum length of 140 ASCII printable characters.


            This field can indicate trading the name or common name of the marketplace/platform which is receives the funds via Zai OR could be the actual seller user''s name to which the funds will be transferred eventually.'
          example: ultimate creditor name
        creditor_reference:
          maxLength: 35
          minLength: 1
          type: string
          description: 'Specifies a character string with a maximum length of 35 ASCII printable characters.


            Reference relevant to the Creditor. Example - Invoice number.'
          example: creditor reference
      description: "Information concerning the creditor party identified in the agreement. \n  \n**Property descriptions**: \n - **ultimate_creditor_name** - This field can indicate trading the name or common name of the marketplace/platform which is receives the funds via Zai OR could be the actual seller user's name to which the funds will be transferred eventually.\n - **creditor_reference** - Reference relevant to the Creditor. Example - Invoice number."
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT