ValidateAgreementRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/assembly-payments/main/json-schema/assembly-payments-validate-agreement-request-schema.json",
  "title": "ValidateAgreementRequest",
  "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",
  "x-generated": "2026-10-22",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/assembly-payments-payto-api-openapi.yml#/components/schemas/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\n\nUnique id of the user (created via Create User API) with whom the agreement should be associated with."
    },
    "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.\n\nThis 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'"
    },
    "agreement_info": {
      "$ref": "#/$defs/AgreementInformation"
    }
  },
  "$defs": {
    "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.\n\nDescribes 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."
        },
        "short_description": {
          "maxLength": 35,
          "minLength": 1,
          "type": "string",
          "description": "Specifies a character string with a maximum length of 35 characters.\n\nDescribes 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."
        },
        "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.\n\nAutomatic 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.\n\nValidity 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"
        },
        "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.\n\nValidity 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"
        },
        "transfer_arrangement": {
          "maxLength": 140,
          "minLength": 1,
          "type": "string",
          "description": "Specifies a character string with a maximum length of 140 characters.\n\nAdditional 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": {
          "$ref": "#/$defs/DebtorInformation"
        },
        "creditor_info": {
          "$ref": "#/$defs/CreditorInformation"
        },
        "payment_initiator_info": {
          "$ref": "#/$defs/PaymentInitiatorInformation"
        },
        "payment_terms": {
          "$ref": "#/$defs/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. "
    },
    "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.\n\nThis 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."
        },
        "creditor_reference": {
          "maxLength": 35,
          "minLength": 1,
          "type": "string",
          "description": "Specifies a character string with a maximum length of 35 ASCII printable characters.\n\nReference relevant to the Creditor. Example - Invoice number."
        }
      },
      "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. "
    },
    "DebtorAccountInformation": {
      "required": [
        "account_id_type"
      ],
      "type": "object",
      "properties": {
        "account_id_type": {
          "title": "AccountIdentificationTypeCodeEnum",
          "type": "string",
          "description": "<p>Specifies the type of account identification.\n\nDebtor'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>",
          "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.\n\nDebtor's actual bank account number (BSB + Account Number)."
        },
        "payid_details": {
          "$ref": "#/$defs/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."
    },
    "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 "
        }
      },
      "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. "
    },
    "DebtorInformation": {
      "required": [
        "debtor_account_details",
        "debtor_details"
      ],
      "type": "object",
      "properties": {
        "debtor_account_details": {
          "$ref": "#/$defs/DebtorAccountInformation"
        },
        "debtor_details": {
          "$ref": "#/$defs/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 "
    },
    "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.\n\nSpecifies the name by which the debtor is known and which is usually used to identify that debtor."
        },
        "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.\n\nThis 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."
        },
        "debtor_id": {
          "maxLength": 35,
          "minLength": 1,
          "type": "string",
          "description": "Specifies a character string with a maximum length of 35 ASCII printable characters.\n\nUnique and unambiguous ID of the debtor."
        },
        "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.\n\nReference 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."
        }
      },
      "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."
    },
    "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."
        },
        "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\".\n\nCurrency of the payment to debit the account.",
          "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.\n\nIf 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."
        }
      },
      "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."
    },
    "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."
        },
        "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\".\n\nCurrency of the payment to debit the account.",
          "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.\n\nIf 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."
        }
      },
      "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

# --- truncated at 32 KB (56 KB total) ---
# Full source: https://artifacts.apis.io/assembly-payments/json-schema/assembly-payments-validate-agreement-request-schema.json