---
title: Get Payment Agreement by Id
slug: r10-integration/get-payment-agreement-by-id
createdAt: 2026-10-29T06:44:31.903Z
---

{
  "id": "8VnhsajP3ImeekN_Bi4TQ",
  "type": "api-oas-v2",
  "data": {
    "method": "GET",
    "url": "https://api-beta.monoova.com/au/payto/pam-v1/PaymentAgreement/{paymentAgreementUID}",
    "servers": [
      {
        "url": "https://api-beta.monoova.com/au/payto/pam-v1/PaymentAgreement/{paymentAgreementUID}",
        "description": "Beta Sandbox URL"
      }
    ],
    "name": "Get Payment Agreement by Id",
    "description": "Previously created Payment Agreements can be retrieved individually via uniqueId.",
    "contentType": "application/json",
    "request": {
      "pathParameters": [
        {
          "kind": "required",
          "name": "paymentAgreementUID",
          "type": "string",
          "example": "MONPAG12345",
          "description": "<p>ID that uniquely identifies the payment agreement. This is the <code>paymentAgreementUID</code> supplied when the agreement was created.</p>",
          "default": "MONPAG12345",
          "pattern": "^[a-zA-Z0-9_-]{1,35}$"
        }
      ],
      "headerParameters": [
        {
          "name": "accept",
          "type": "string",
          "kind": "optional",
          "description": "Generated from available response content types",
          "enum": [
            "application/json"
          ],
          "default": "application/json"
        }
      ],
      "queryParameters": [],
      "bodyDataParameters": [],
      "formDataParameters": [],
      "oAuthParameters": [
        {
          "id": "BearerAuth",
          "name": "BearerAuth",
          "kind": "optional",
          "type": "http",
          "description": "<p>Bearer token (JWT) used to authenticate PayTo API requests. Generate it with the Monoova security token endpoint (<code>/au/security/oauth-v1/Token</code>) using your mAccount number and API key, then send it in the <code>Authorization: Bearer &#x3C;token></code> header. Tokens are valid for 24 hours.</p>",
          "scheme": "bearer"
        }
      ],
      "cookieParameters": []
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "OK. Returns the payment agreement.",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "Payment agreement returned by ID.",
            "customType": "MandateManager.Application.Common.Dtos.GetPaymentAgreementByIdResponse",
            "schema": [
              {
                "name": "traceId",
                "kind": "optional",
                "type": "string",
                "nullable": true,
                "description": "Unique ID for logging and tracing this request.",
                "example": "1dabfaa9-abe8-4d2d-a69a-b723079d84ed",
                "default": "1dabfaa9-abe8-4d2d-a69a-b723079d84ed",
                "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
              },
              {
                "name": "paymentAgreementDetails",
                "kind": "optional",
                "type": "object",
                "description": "Details of the payment agreement.",
                "modelRef": "#/components/schemas/MandateManager.Application.Common.Dtos.PaymentAgreementDto",
                "customType": "MandateManager.Application.Common.Dtos.PaymentAgreementDto",
                "schema": [
                  {
                    "name": "createdDateTime",
                    "kind": "optional",
                    "type": "string",
                    "nullable": true,
                    "description": "<p>Date and time the payment agreement was created, in ISO 8601 date-time format.</p>",
                    "example": "2026-10-16T04:25:46.183Z",
                    "default": "2026-10-16T04:25:46.183Z",
                    "pattern": "^\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])T([01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(\\.\\d{1,7})?(Z|[+-]([01]\\d|2[0-3])(:?[0-5]\\d)?)?$"
                  },
                  {
                    "name": "lastModifiedDateTime",
                    "kind": "optional",
                    "type": "string",
                    "nullable": true,
                    "description": "<p>Date and time the payment agreement was last modified, in ISO 8601 date-time format.</p>",
                    "example": "2026-11-02T01:14:09.457Z",
                    "default": "2026-11-02T01:14:09.457Z",
                    "pattern": "^\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])T([01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(\\.\\d{1,7})?(Z|[+-]([01]\\d|2[0-3])(:?[0-5]\\d)?)?$"
                  },
                  {
                    "name": "paymentAgreementUID",
                    "kind": "optional",
                    "type": "string",
                    "nullable": true,
                    "description": "ID that uniquely identifies the payment agreement to the client.",
                    "example": "MONPAG12345",
                    "default": "MONPAG12345",
                    "pattern": "^[a-zA-Z0-9_-]{1,35}$"
                  },
                  {
                    "name": "subMerchantId",
                    "kind": "optional",
                    "type": "string",
                    "nullable": true,
                    "description": "<p>ID of the sub-merchant related to this payment agreement, if any.</p>",
                    "example": "93bf57eb1e2c42cf8101509b4356741e",
                    "default": "93bf57eb1e2c42cf8101509b4356741e",
                    "pattern": "^[ -~]{1,35}$"
                  },
                  {
                    "name": "mmsId",
                    "kind": "optional",
                    "type": "string",
                    "nullable": true,
                    "description": "<p>Unique ID that identifies this payment agreement to the NPP (MMS ID).</p>",
                    "example": "a9ba56f64baa1dee9ac2d7f87c2621fa",
                    "default": "a9ba56f64baa1dee9ac2d7f87c2621fa",
                    "pattern": "^[a-f0-9]{32}$"
                  },
                  {
                    "name": "registrationDateTime",
                    "kind": "optional",
                    "type": "string",
                    "nullable": true,
                    "description": "<p>Date and time the mandate was created, in ISO 8601 date-time format.</p>",
                    "example": "2026-10-16T04:25:47.031Z",
                    "default": "2026-10-16T04:25:47.031Z",
                    "pattern": "^\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])T([01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(\\.\\d{1,7})?(Z|[+-]([01]\\d|2[0-3])(:?[0-5]\\d)?)?$"
                  },
                  {
                    "name": "paymentAgreementStatus",
                    "kind": "optional",
                    "type": "string",
                    "nullable": true,
                    "description": "<p>Status of the payment agreement. Possible values: <code>InProgress</code>, <code>Created</code>, <code>Active</code>, <code>Paused</code>, <code>Cancelled</code>, <code>Rejected</code>, <code>Expired</code>.</p>",
                    "example": "Active",
                    "default": "Active",
                    "pattern": "^(InProgress|Created|Active|Paused|Cancelled|Rejected|Expired)$"
                  },
                  {
                    "name": "statusReasonCode",
                    "kind": "optional",
                    "type": "string",
                    "nullable": true,
                    "description": "<p>Reason code for the current status, if any. See <a href=\"https://developer.monoova.com/payto-status-and-error-codes\" target=\"_blank\">PayTo Status and Error Codes</a> for the mandate status reason codes.</p>",
                    "example": "M011",
                    "default": "M011",
                    "pattern": "^[A-Z0-9]{4}$"
                  },
                  {
                    "name": "statusReasonDescription",
                    "kind": "optional",
                    "type": "string",
                    "nullable": true,
                    "description": "Description of the status reason code.",
                    "example": "Contract Amended",
                    "default": "Contract Amended",
                    "pattern": "^.+$"
                  },
                  {
                    "name": "payeeDetails",
                    "kind": "optional",
                    "type": "object",
                    "description": "<p>Details of the payee (the party that receives the payments).</p>",
                    "modelRef": "#/components/schemas/MandateManager.Application.Common.Dtos.PayeeDetailsDto",
                    "customType": "MandateManager.Application.Common.Dtos.PayeeDetailsDto",
                    "schema": [
                      {
                        "name": "payeeType",
                        "kind": "optional",
                        "type": "string",
                        "nullable": true,
                        "description": "<p><strong>Optional</strong>. Type of payee. Accepted values: <code>ORGN</code> (organisation), <code>PERS</code> (individual).</p>",
                        "example": "ORGN",
                        "default": "ORGN",
                        "pattern": "^(ORGN|PERS)$"
                      },
                      {
                        "name": "payeeLinkedBsb",
                        "kind": "optional",
                        "type": "string",
                        "nullable": true,
                        "description": "<p><strong>Conditional</strong>. BSB number of the payee's account, with or without a hyphen.</p>\n<p>When creating a payment agreement, required if <code>payeeLinkedPayId</code> and <code>payeeLinkedPayIdType</code> are not provided. Prohibited if <code>payeeLinkedPayId</code> is provided.</p>",
                        "example": "062000",
                        "default": "062000",
                        "pattern": "^[0-9]{3}-?[0-9]{3}$"
                      },
                      {
                        "name": "payeeLinkedAccount",
                        "kind": "optional",
                        "type": "string",
                        "nullable": true,
                        "description": "<p><strong>Conditional</strong>. Account number of the payee's account, from 1 to 28 characters. Must not be all zeros or spaces.</p>\n<p>Required if <code>payeeLinkedPayId</code> and <code>payeeLinkedPayIdType</code> are not provided. Prohibited if <code>payeeLinkedPayId</code> is provided.</p>",
                        "example": "12345678",
                        "default": "12345678",
                        "minLength": 1,
                        "maxLength": 28,
                        "pattern": "^[0-9A-Za-z -]{1,28}$"
                      },
                      {
                        "name": "payeeLinkedPayId",
                        "kind": "optional",
                        "type": "string",
                        "nullable": true,
                        "description": "<p><strong>Conditional</strong>. PayID of the payee: a mobile number, email address, ABN, ACN or organisation ID. The required format depends on <code>payeeLinkedPayIdType</code>; mobile numbers use the format <code>+61-4XXXXXXXX</code>.</p>\n<p>Required if <code>payeeLinkedBsb</code> and <code>payeeLinkedAccount</code> are not provided. Prohibited if <code>payeeLinkedAccount</code> is provided.</p>",
                        "example": "payments@abccorp.com.au",
                        "default": "payments@abccorp.com.au",
                        "pattern": "^[ -~]{1,256}$"
                      },
                      {
                        "name": "payeeLinkedPayIdType",
                        "kind": "optional",
                        "type": "string",
                        "nullable": true,
                        "description": "<p><strong>Conditional</strong>. Type of the payee's PayID. Accepted values: <code>PhoneNumber</code>, <code>Email</code>, <code>ABN</code>, <code>ACN</code>, <code>OrganisationId</code>.</p>\n<p>Required if <code>payeeLinkedBsb</code> and <code>payeeLinkedAccount</code> are not provided. Prohibited if <code>payeeLinkedAccount</code> is provided.</p>",
                        "example": "Email",
                        "default": "Email",
                        "pattern": "^(PhoneNumber|Email|ABN|ACN|OrganisationId)$"
                      },
                      {
                        "name": "payeeAccountName",
                        "kind": "optional",
                        "type": "string",
                        "nullable": true,
                        "description": "<p><strong>Conditional</strong>. Name of the payee's bank account, from 1 to 140 characters.</p>\n<p>Can only be provided when crediting an external BSB. Mandatory when crediting a PayID. Allowed external account names may also be whitelisted in your account configuration.</p>",
                        "example": "ABC Corp Pty Ltd",
                        "default": "ABC Corp Pty Ltd",
                        "minLength": 1,
                        "maxLength": 140,
                        "pattern": "^[ -~]{1,140}$"
                      },
                      {
                        "name": "ultimatePayee",
                        "kind": "optional",
                        "type": "string",
                        "nullable": true,
                        "description": "<p><strong>Optional</strong>. Name by which the ultimate payee is known and usually identified, from 1 to 140 characters.</p>\n<p>Can only be provided when crediting an external BSB. Allowed external ultimate payee names may also be whitelisted in your account configuration.</p>",
                        "example": "ABC Corp",
                        "default": "ABC Corp",
                        "minLength": 1,
                        "maxLength": 140,
                        "pattern": "^[ -~]{1,140}$"
                      },
                      {
                        "name": "payeeMCCCode",
                        "kind": "optional",
                        "type": "string",
                        "nullable": true,
                        "description": "<p><strong>Conditional</strong>. Merchant Category Code (MCC) of the payee, as 4 digits. If provided, it is validated against the payee MCC allow-list configured for your account. If not provided, the default payee MCC configured for your account is used, if one exists.</p>\n<p>Mandatory if <code>payeeType</code> is <code>ORGN</code> and the agreement <code>purpose</code> is <code>OTHR</code>, <code>PERS</code>, <code>UTIL</code>, <code>GAMP</code> or <code>RETL</code>.</p>\n<p>When amending, set to <code>-</code> to clear the field.</p>",
                        "example": "5968",
                        "default": "5968",
                        "pattern": "^([0-9]{4}|-)$"
                      },
                      {
                        "name": "ultimatePayeeMCCCode",
                        "kind": "optional",
                        "type": "string",
                        "nullable": true,
                        "description": "<p><strong>Conditional</strong>. Merchant Category Code (MCC) of the ultimate payee, as 4 digits. If provided, it is validated against the ultimate payee MCC allow-list configured for your account. If not provided, the default ultimate payee MCC configured for your account is used, if one exists.</p>\n<p>Mandatory if <code>payeeType</code> is <code>ORGN</code> and the agreement <code>purpose</code> is <code>OTHR</code>, <code>PERS</code>, <code>UTIL</code>, <code>GAMP</code> or <code>RETL</code>.</p>\n<p>When amending, set to <code>-</code> to clear the field.</p>",
                        "example": "5968",
                        "default": "5968",
                        "pattern": "^([0-9]{4}|-)$"
                      }
                    ]
                  },
                  {
                    "name": "payerDetails",
                    "kind": "optional",
                    "type": "object",
                    "description": "<p>Details of the payer (the party whose account is debited).</p>",
                    "modelRef": "#/components/schemas/MandateManager.Application.Common.Dtos.PayerDetailsDto",
                    "customType": "MandateManager.Application.Common.Dtos.PayerDetailsDto",
                    "schema": [
                      {
                        "name": "payerType",
                        "kind": "required",
                        "type": "string",
                        "description": "<p>Type of payer. Accepted values: <code>ORGN</code> (organisation), <code>PERS</code> (individual).</p>",
                        "example": "PERS",
                        "default": "PERS",
                        "pattern": "^(ORGN|PERS)$"
                      },
                      {
                        "name": "linkedBsb",
                        "kind": "optional",
                        "type": "string",
                        "nullable": true,
                        "description": "<p><strong>Conditional</strong>. BSB number of the payer's account, with or without a hyphen.</p>\n<p>When creating a payment agreement, required if <code>linkedPayId</code> and <code>linkedPayIdType</code> are not provided. Prohibited if <code>linkedPayId</code> is provided.</p>",
                        "example": "802950",
                        "default": "802950",
                        "pattern": "^[0-9]{3}-?[0-9]{3}$"
                      },
                      {
                        "name": "linkedAccount",
                        "kind": "optional",
                        "type": "string",
                        "nullable": true,
                        "description": "<p><strong>Conditional</strong>. Account number of the payer's account, from 1 to 28 characters. Must not be all zeros or spaces.</p>\n<p>Required if <code>linkedPayId</code> and <code>linkedPayIdType</code> are not provided. Prohibited if <code>linkedPayId</code> is provided.</p>",
                        "example": "22090100",
                        "default": "22090100",
                        "minLength": 1,
                        "maxLength": 28,
                        "pattern": "^[0-9A-Za-z -]{1,28}$"
                      },
                      {
                        "name": "linkedPayId",
                        "kind": "optional",
                        "type": "string",
                        "nullable": true,
                        "description": "<p><strong>Conditional</strong>. PayID of the payer: a mobile number, email address, ABN, ACN or organisation ID. The required format depends on <code>linkedPayIdType</code>; mobile numbers use the format <code>+61-4XXXXXXXX</code>.</p>\n<p>Required if <code>linkedBsb</code> and <code>linkedAccount</code> are not provided. Prohibited if <code>linkedAccount</code> is provided.</p>",
                        "example": "+61-422020901",
                        "default": "+61-422020901",
                        "pattern": "^[ -~]{1,256}$"
                      },
                      {
                        "name": "linkedPayIdType",
                        "kind": "optional",
                        "type": "string",
                        "nullable": true,
                        "description": "<p><strong>Conditional</strong>. Type of the payer's PayID. Accepted values: <code>PhoneNumber</code>, <code>Email</code>, <code>ABN</code>, <code>ACN</code>, <code>OrganisationId</code>.</p>\n<p>Required if <code>linkedBsb</code> and <code>linkedAccount</code> are not provided. Prohibited if <code>linkedAccount</code> is provided.</p>",
                        "example": "PhoneNumber",
                        "default": "PhoneNumber",
                        "pattern": "^(PhoneNumber|Email|ABN|ACN|OrganisationId)$"
                      },
                      {
                        "name": "payer",
                        "kind": "required",
                        "type": "string",
                        "description": "<p>Name by which the payer is known and usually identified, from 1 to 140 characters.</p>",
                        "example": "Monoova Sample 1",
                        "default": "Monoova Sample 1",
                        "minLength": 1,
                        "maxLength": 140,
                        "pattern": "^[ -~]{1,140}$"
                      },
                      {
                        "name": "ultimatePayer",
                        "kind": "required",
                        "type": "string",
                        "description": "<p>Name by which the ultimate payer is known and usually identified, from 1 to 140 characters.</p>",
                        "example": "Monoova Sample 1",
                        "default": "Monoova Sample 1",
                        "minLength": 1,
                        "maxLength": 140,
                        "pattern": "^[ -~]{1,140}$"
                      },
                      {
                        "name": "payerPartyReference",
                        "kind": "required",
                        "type": "string",
                        "description": "<p>Your reference for the payer, from 1 to 35 characters. It is shown to the payer in the agreement details view and can be used to group payment initiations associated with a payment agreement.</p>\n<p>Must contain at least one letter or number and must not be all zeros or spaces.</p>",
                        "example": "CUST-000123",
                        "default": "CUST-000123",
                        "minLength": 1,
                        "maxLength": 35,
                        "pattern": "^[ -~]{1,35}$"
                      }
                    ]
                  },
                  {
                    "name": "paymentTerms",
                    "kind": "optional",
                    "type": "object",
                    "description": "Payment terms of the agreement.",
                    "modelRef": "#/components/schemas/MandateManager.Application.Common.Dtos.PaymentTermsDto",
                    "customType": "MandateManager.Application.Common.Dtos.PaymentTermsDto",
                    "schema": [
                      {
                        "name": "numberOfTransactionsPermitted",
                        "kind": "optional",
                        "type": "string",
                        "nullable": true,
                        "description": "<p><strong>Conditional</strong>. Number of transactions allowed per <code>frequency</code> period, as a whole number of 1 or more.</p>\n<p>Required when creating a payment agreement, unless <code>frequency</code> is <code>ADHO</code> or <code>pointInTime</code> is provided. Prohibited if <code>pointInTime</code> is provided. When amending, set to <code>-</code> to clear the field.</p>",
                        "example": "1",
                        "default": "1",
                        "pattern": "^([1-9][0-9]*|-)$"
                      },
                      {
                        "name": "frequency",
                        "kind": "optional",
                        "type": "string",
                        "nullable": true,
                        "description": "<p><strong>Conditional</strong>. Specifies how often payments can be made. Required when creating a payment agreement.</p>\n<p>Accepted values: <code>ADHO</code> (ad hoc), <code>DAIL</code> (daily), <code>FRTN</code> (fortnightly), <code>INDA</code> (intraday), <code>MIAN</code> (semi-annual), <code>MNTH</code> (monthly), <code>QURT</code> (quarterly), <code>WEEK</code> (weekly), <code>YEAR</code> (annual).</p>",
                        "example": "MNTH",
                        "default": "MNTH",
                        "pattern": "^(ADHO|DAIL|FRTN|INDA|MIAN|MNTH|QURT|WEEK|YEAR)$"
                      },
                      {
                        "name": "pointInTime",
                        "kind": "optional",
                        "type": "string",
                        "nullable": true,
                        "description": "<p><strong>Conditional</strong>. Exact point in time within the <code>frequency</code> period, as a two-digit value from <code>01</code> to <code>31</code> (for example, the day of the month).</p>\n<p>Can only be provided when <code>frequency</code> is <code>MNTH</code>, and must not be provided with <code>numberOfTransactionsPermitted</code>. When amending, set to <code>-</code> to clear the field.</p>",
                        "example": "15",
                        "default": "15",
                        "maxLength": 2,
                        "pattern": "^(0[1-9]|[12][0-9]|3[01]|-)$"
                      },
                      {
                        "name": "amount",
                        "kind": "optional",
                        "type": "string",
                        "nullable": true,
                        "description": "<p><strong>Conditional</strong>. Exact amount that may be paid from the payer's account per instruction, in dollars with up to 2 decimal places. Required when <code>agreementType</code> is <code>FIXE</code>. If <code>maximumAmount</code> is also provided, <code>amount</code> must be less than <code>maximumAmount</code>. When amending, set to <code>-</code> to clear the field.</p>\n<p>In Sandbox, the cents value decides the test outcome of a new agreement; for example, amounts ending in <code>.00</code> are approved. If both <code>amount</code> and <code>maximumAmount</code> are provided, <code>amount</code> decides.</p>",
                        "example": "50.00",
                        "default": "50.00",
                        "pattern": "^(-|(?=.{1,19}$)[0-9]{1,18}(\\.[0-9]{1,2})?)$"
                      },
                      {
                        "name": "maximumAmount",
                        "kind": "optional",
                        "type": "string",
                        "nullable": true,
                        "description": "<p><strong>Optional</strong>. Maximum amount that may be paid from the payer's account per instruction, in dollars with up to 2 decimal places. Recommended when <code>agreementType</code> is <code>USGB</code> or <code>VARI</code>; must not be provided when <code>agreementType</code> is <code>FIXE</code>. When amending, set to <code>-</code> to clear the field.</p>\n<p>In Sandbox, the cents value decides the test outcome of a new agreement; for example, amounts ending in <code>.00</code> are approved. If both <code>amount</code> and <code>maximumAmount</code> are provided, <code>amount</code> decides.</p>",
                        "example": "100.00",
                        "default": "100.00",
                        "pattern": "^(-|(?=.{1,19}$)[0-9]{1,18}(\\.[0-9]{1,2})?)$"
                      },
                      {
                        "name": "agreementType",
                        "kind": "optional",
                        "type": "string",
                        "nullable": true,
                        "description": "<p><strong>Conditional</strong>. Identifies the payment arrangement of the agreement. Required when creating a payment agreement.</p>\n<p>Accepted values: <code>BALN</code> (balloon), <code>FIXE</code> (fixed), <code>USGB</code> (usage based), <code>VARI</code> (variable). For <code>FIXE</code>, provide <code>amount</code> only.</p>",
                        "example": "VARI",
                        "default": "VARI",
                        "pattern": "^(BALN|FIXE|USGB|VARI)$"
                      }
                    ]
                  },
                  {
                    "name": "paymentDetails",
                    "kind": "optional",
                    "type": "object",
                    "description": "<p>Details of the agreement, such as start and end dates, renewal, purpose and description.</p>",
                    "modelRef": "#/components/schemas/MandateManager.Application.Common.Dtos.PaymentDetailsDto",
                    "customType": "MandateManager.Application.Common.Dtos.PaymentDetailsDto",
                    "schema": [
                      {
                        "name": "automaticRenewal",
                        "kind": "required",
                        "type": "string",
                        "nullable": true,
                        "description": "<p>Determines whether the payment agreement automatically renews at the end of the defined period. Accepted values: <code>true</code> or <code>false</code>.</p>\n<p><code>endDate</code> must not be provided when <code>automaticRenewal</code> is <code>true</code>, and must be provided when <code>automaticRenewal</code> is <code>false</code>.</p>",
                        "example": "false",
                        "default": "false",
                        "pattern": "^(true|false)$"
                      },
                      {
                        "name": "description",
                        "kind": "optional",
                        "type": "string",
                        "nullable": true,
                        "description": "<p><strong>Conditional</strong>. Reason for the mandate setup, as narrative text, from 1 to 140 characters.</p>\n<p>Either <code>description</code> or <code>shortDescription</code> must be provided.</p>",
                        "example": "Monthly subscription for ABC Corp services",
                        "default": "Monthly subscription for ABC Corp services",
                        "minLength": 1,
                        "maxLength": 140,
                        "pattern": "^[ -~]{1,140}$"
                      },
                      {
                        "name": "shortDescription",
                        "kind": "optional",
                        "type": "string",
                        "nullable": true,
                        "description": "<p><strong>Conditional</strong>. Short reason for the mandate setup, as narrative text, from 1 to 35 characters.</p>\n<p>Either <code>description</code> or <code>shortDescription</code> must be provided.</p>",
                        "example": "ABC Corp subscription",
                        "default": "ABC Corp subscription",
                        "minLength": 1,
                        "maxLength": 35,
                        "pattern": "^[ -~]{1,35}$"
                      },
                      {
                        "name": "purpose",
                        "kind": "optional",
                        "type": "string",
                        "nullable": true,
                        "description": "<p><strong>Optional</strong>. Payment purpose code. The default value and the allowed values are configured for each client account.</p>\n<p>Accepted values: <code>MORT</code> (mortgage), <code>UTIL</code> (utility), <code>LOAN</code> (loan), <code>DEPD</code> (dependant support), <code>GAMP</code> (gambling), <code>RETL</code> (retail), <code>SALA</code> (salary), <code>PERS</code> (personal), <code>GOVT</code> (government), <code>PENS</code> (pension), <code>TAXS</code> (tax), <code>OTHR</code> (other).</p>",
                        "example": "RETL",
                        "default": "RETL",
                        "pattern": "^(MORT|UTIL|LOAN|DEPD|GAMP|RETL|SALA|PERS|GOVT|PENS|TAXS|OTHR)$"
                      },
                      {
                        "name": "respondByTime",
                        "kind": "optional",
                        "type": "string",
                        "nullable": true,
                        "description": "<p><strong>Optional</strong>. Time by which the payer is asked to respond. It is included in any notification sent to the counterparty and is for information only; it does not affect the expiry time imposed by the MMS.</p>\n<p>Must be a future date-time less than 5 days away, in ISO 8601 format including a time zone. If not provided, defaults to the agreement creation date-time + 5 days.</p>",
                        "example": "2026-12-28T17:00:00+11:00",
                        "default": "2026-12-28T17:00:00+11:00",
                        "pattern": "^\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])T([01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(\\.\\d{1,7})?(Z|[+-]([01]\\d|2[0-3])(:?[0-5]\\d)?)$"
                      },
                      {
                        "name": "startDate",
                        "kind": "required",
                        "type": "string",
                        "nullable": true,
                        "description": "<p>Start date of the validity of the mandate, in <code>YYYY-MM-DD</code> format. The mandate is valid from 00:00</p><div></div>.000 Sydney time on this date. Must be a future date.<p></p>",
                        "example": "2027-01-01",
                        "default": "2027-01-01",
                        "pattern": "^\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$"
                      },
                      {
                        "name": "endDate",
                        "kind": "optional",
                        "type": "string",
                        "nullable": true,
                        "description": "<p><strong>Conditional</strong>. End date of the validity of the mandate, in <code>YYYY-MM-DD</code> format. If specified, the mandate is valid until 23:59</p><div></div>.999 Sydney time on this date.<p></p>\n<p>Required if <code>automaticRenewal</code> is <code>false</code>; prohibited if <code>automaticRenewal</code> is <code>true</code>. Cannot be earlier than <code>startDate</code>.</p>",
                        "example": "2027-12-31",
                        "default": "2027-12-31",
                        "pattern": "^\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$"
                      }
                    ]
                  },
                  {
                    "name": "pendingActions",
                    "kind": "optional",
                    "type": "array",
                    "nullable": true,
                    "description": "<p>Pending (unapproved) actions on the payment agreement, such as a creation or a bilateral amendment awaiting the payer's approval.</p>",
                    "modelRef": "#/components/schemas/MandateManager.Application.Common.Dtos.PaymentAgreementActionSummary",
                    "customType": "MandateManager.Application.Common.Dtos.PaymentAgreementActionSummary[]",
                    "schema": [
                      {
                        "name": "actionId",
                        "kind": "optional",
                        "type": "string",
                        "nullable": true,
                        "description": "Unique ID of the pending action. Use it to recall the action before the payer approves it.",
                        "example": "eea687ee114eae368ca066aa62bae488",
                        "default": "eea687ee114eae368ca066aa62bae488",
                        "pattern": "^[a-f0-9]{32}$"
                      },
                      {
                        "name": "actionType",
                        "kind": "optional",
                        "type": "string",
                        "nullable": true,
                        "description": "<p>Type of the pending action, for example <code>Create</code> or <code>Amend</code>.</p>",
                        "example": "Amend",
                        "default": "Amend",
                        "pattern": "^[A-Za-z]+$"
                      },
                      {
                        "name": "bilateral",
                        "kind": "optional",
                        "type": "string",
                        "nullable": true,
                        "description": "<p>Indicates whether the action needs the payer's approval. Returned as <code>true</code> or <code>false</code>.</p>",
                        "example": "true",
                        "default": "true",
                        "pattern": "^(true|false)$"
                      },
                      {
                        "name": "status",
                        "kind": "optional",
                        "type": "string",
                        "nullable": true,
                        "description": "<p>Status of the pending action, for example <code>PendingApproval</code>.</p>",
                        "example": "PendingApproval",
                        "default": "PendingApproval",
                        "pattern": "^[A-Za-z]+$"
                      }
                    ]
                  },
                  {
                    "name": "scheduleDetails",
                    "kind": "optional",
                    "type": "object",
                    "description": "<p>Details of the payment schedule linked to the agreement, if any.</p>",
                    "modelRef": "#/components/schemas/MandateManager.Application.PaymentSchedules.Dto.PaymentScheduleDtoOut",
                    "customType": "MandateManager.Application.PaymentSchedules.Dto.PaymentScheduleDtoOut",
                    "schema": [
                      {
                        "name": "createdDateTime",
                        "kind": "optional",
                        "type": "string",
                        "nullable": true,
                        "description": "<p>Date and time the schedule was created, in ISO 8601 format (UTC).</p>",
                        "example": "2026-10-16T04:40:12.512Z",
                        "default": "2026-10-16T04:40:12.512Z",
                        "pattern": "^\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])T([01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(\\.\\d{1,7})?(Z|[+-]([01]\\d|2[0-3])(:?[0-5]\\d)?)?$"
                      },
                      {
                        "name": "lastModifiedDateTime",
                        "kind": "optional",
                        "type": "string",
                        "nullable": true,
                        "description": "<p>Date and time the schedule was last modified, in ISO 8601 format (UTC).</p>",
                        "example": "2027-01-14T22:00:03.118Z",
                        "default": "2027-01-14T22:00:03.118Z",
                        "pattern": "^\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])T([01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(\\.\\d{1,7})?(Z|[+-]([01]\\d|2[0-3])(:?[0-5]\\d)?)?$"
                      },
                      {
                        "name": "scheduleId",
                        "kind": "optional",
                        "type": "string",
                        "nullable": true,
                        "description": "<p>Unique <code>scheduleId</code> provided by the client when the schedule was created. Cannot be reused.</p>",
                        "example": "MONSCH12345",
                        "default": "MONSCH12345",
                        "pattern": "^[a-zA-Z0-9_-]{1,36}$"
                      },
                      {
                        "name": "entityId",
                        "kind": "optional",
                        "type": "string",
                        "nullable": true,
                        "description": "<p><code>paymentAgreementUID</code> of the payment agreement that the schedule applies to.</p>",
                        "example": "MONPAG12345",
                        "default": "MONPAG12345",
                        "pattern": "^[a-zA-Z0-9_-]{1,35}$"
                      },
                      {
                        "name": "entityType",
                        "kind": "optional",
                        "type": "string",
                        "nullable": true,
                        "description": "<p>Type of entity that the schedule applies to. Possible value: <code>PaymentAgreement</code>.</p>",
                        "example": "PaymentAgreement",
                        "default": "PaymentAgreement",
                        "pattern": "^(PaymentAgreement)$"
                      },
                      {
                        "name": "startDate",
                        "kind": "optional",
                        "type": "string",
                        "nullable": true,
                        "description": "<p>Start date of the schedule, in <code>YYYY-MM-DD</code> format.</p>",
                        "example": "2027-01-15",
                        "default": "2027-01-15",
                        "pattern": "^\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$"
                      },
                      {
                        "name": "endDate",
                        "kind": "optional",
                        "type": "string",
                        "nullable": true,
                        "description": "<p>End date of the schedule, in <code>YYYY-MM-DD</code> format.</p>",
                        "example": "2027-12-15",
                        "default": "2027-12-15",
                        "pattern": "^\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$"
                      },
                      {
                        "name": "executionTime",
                        "kind": "optional",
                        "type": "string",
                        "nullable": true,
                        "description": "<p>Time of day the schedule is intended to run, as <code>HH:MM:SS</code> in Sydney local time.</p>",
                        "example": "09:00:00",
                        "default": "09:00:00",
                        "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]$"
                      },
                      {
                        "name": "frequency",
                        "kind": "optional",
                        "type": "string",
                        "nullable": true,
                        "description": "<p>Frequency of execution.</p>\n<p>Possible values: <code>ADHO</code> (ad hoc), <code>DAIL</code> (daily), <code>FRTN</code> (fortnightly), <code>INDA</code> (intraday), <code>MIAN</code> (semi-annual), <code>MNTH</code> (monthly), <code>QURT</code> (quarterly), <code>WEEK</code> (weekly), <code>YEAR</code> (annual).</p>",
                        "example": "MNTH",
                        "default": "MNTH",
                        "pattern": "^(ADHO|DAIL|FRTN|INDA|MIAN|MNTH|QURT|WEEK|YEAR)$"
                      },
                      {
                        "name": "scheduledAmount",
                        "kind": "optional",
                        "type": "number<double>",
                        "nullable": true,
                        "description": "Amount of each scheduled payment.",
                        "example": 50,
                        "default": 50,
                        "format": "double",
                        "pattern": "^[0-9]{1,16}(\\.[0-9]{1,2})?$"
                      },
                      {
                        "name": "totalInstances",
                        "kind": "optional",
                        "type": "integer<int32>",
                        "nullable": true,
                        "description": "Number of executions after which the schedule expires.",
                        "example": 12,
                        "default": 12,
                        "format": "int32",
                        "pattern": "^[1-9][0-9]*$"
                      },
                      {
                        "name": "totalAmount",
                        "kind": "optional",
                        "type": "number<double>",
                        "nullable": true,
                        "description": "Total value of executions after which the schedule expires.",
                        "example": 600,
                        "default": 600,
                        "format": "double",
                        "pattern": "^[0-9]{1,16}(\\.[0-9]{1,2})?$"
                      },
                      {
                        "name": "lastExecutionDateTime",
                        "kind": "optional",
                        "type": "string",
                        "nullable": true,
                        "description": "<p>Date and time of the last payment execution, in ISO 8601 format (UTC).</p>",
                        "example": "2027-01-14T22:00:00Z",
                        "default": "2027-01-14T22:00:00Z",
                        "pattern": "^\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])T([01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(\\.\\d{1,7})?(Z|[+-]([01]\\d|2[0-3])(:?[0-5]\\d)?)?$"
                      },
                      {
                        "name": "nextExecutionDateTime",
                        "kind": "optional",
                        "type": "string",
                        "nullable": true,
                        "description": "<p>Date and time of the next scheduled payment execution, in ISO 8601 format (UTC).</p>",
                        "example": "2027-02-14T22:00:00Z",
                        "default": "2027-02-14T22:00:00Z",
                        "pattern": "^\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])T([01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(\\.\\d{1,7})?(Z|[+-]([01]\\d|2[0-3])(:?[0-5]\\d)?)?$"
                      },
                      {
                        "name": "status",
                        "kind": "optional",
                        "type": "string",
                        "nullable": true,
                        "description": "<p>Status of the schedule. Possible values: <code>Pending</code>, <code>Active</code>, <code>Paused</code>, <code>Cancelled</code>.</p>",
                        "example": "Active",
                        "default": "Active",
                        "pattern": "^(Pending|Active|Paused|Cancelled)$"
                      },
                      {
                        "name": "statusDescription",
                        "kind": "optional",
                        "type": "string",
                        "nullable": true,
                        "description": "Description of the schedule status.",
                        "example": "Active",
                        "default": "Active",
                        "pattern": "^.+$"
                      },
                      {
                        "name": "statusReasonCode",
                        "kind": "optional",
                        "type": "string",
                        "nullable": true,
                        "description": "<p>Reason code for the status. Possible values: <code>CustReq</code>, <code>CreateError</code>, <code>Expired</code>, <code>AgreementStatusChanged</code>, <code>InvalidPayeeDetails</code>, <code>BilateralAmendmentInitiated</code>, <code>MaxedOutTotalInstanceLimit</code>, <code>MaxedOutTotalAmountLimit</code>, <code>ExceededScheduleEndDate</code>, <code>FinalPaymentInitiated</code>, <code>SchedulingDisabled</code>.</p>",
                        "example": "CustReq",
                        "default": "CustReq",
                        "pattern": "^(CustReq|CreateError|Expired|AgreementStatusChanged|InvalidPayeeDetails|BilateralAmendmentInitiated|MaxedOutTotalInstanceLimit|MaxedOutTotalAmountLimit|ExceededScheduleEndDate|FinalPaymentInitiated|SchedulingDisabled)$"
                      },
                      {
                        "name": "statusReasonDescription",
                        "kind": "optional",
                        "type": "string",
                        "nullable": true,
                        "description": "Description of the reason code.",
                        "example": "Requested by customer",
                        "default": "Requested by customer",
                        "pattern": "^.+$"
                      },
                      {
                        "name": "paymentReference",
                        "kind": "optional",
                        "type": "string",
                        "nullable": true,
                        "description": "<p>Unique reference, assigned by the creditor, for the sequence of scheduled payments.</p>",
                        "example": "ABC Corp monthly subscription",
                        "default": "ABC Corp monthly subscription",
                        "pattern": "^[ -~]{1,280}$"
                      }
                    ]
                  }
                ]
              }
            ],
            "modelRef": "#/components/schemas/MandateManager.Application.Common.Dtos.GetPaymentAgreementByIdResponse",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "400",
        "description": "<p>Bad Request. The request failed validation. See <code>errors</code> for details.</p>",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "example": "{\"traceId\":\"4ea61012-2d9b-413d-a5b4-90ad69a68741\",\"errors\":[{\"errorCode\":\"PAM_PAGID_INVALID\",\"errorMessage\":\"paymentAgreementUID MONPAG#12345 must match ^[a-zA-Z0-9_-]{1,35}$\"}]}",
            "description": "Error response returned when a request fails.",
            "customType": "MandateManager.Application.Common.Dtos.ErrorResponse",
            "schema": [
              {
                "name": "traceId",
                "kind": "optional",
                "type": "string",
                "nullable": true,
                "description": "Unique ID for logging and tracing this request.",
                "example": "4ea61012-2d9b-413d-a5b4-90ad69a68741",
                "default": "4ea61012-2d9b-413d-a5b4-90ad69a68741",
                "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
              },
              {
                "name": "errors",
                "kind": "optional",
                "type": "array",
                "nullable": true,
                "description": "List of errors that occurred while processing the request.",
                "modelRef": "#/components/schemas/MandateManager.Application.Common.Dtos.ErrorDto",
                "customType": "MandateManager.Application.Common.Dtos.ErrorDto[]",
                "schema": [
                  {
                    "name": "errorCode",
                    "kind": "optional",
                    "type": "string",
                    "nullable": true,
                    "description": "<p>Monoova error code. See <a href=\"https://developer.monoova.com/payto-status-and-error-codes\" target=\"_blank\">PayTo Status and Error Codes</a> for the meaning of each code.</p>",
                    "example": "PAM_STARTDATE_EARLY",
                    "default": "PAM_STARTDATE_EARLY",
                    "pattern": "^[A-Z]{3}_[A-Z0-9_]+$"
                  },
                  {
                    "name": "errorMessage",
                    "kind": "optional",
                    "type": "string",
                    "nullable": true,
                    "description": "<p>More detailed description of the error, which may include information from the request.</p>",
                    "example": "paymentDetails.startDate must be future date",
                    "default": "paymentDetails.startDate must be future date",
                    "pattern": "^.+$"
                  }
                ]
              }
            ],
            "modelRef": "#/components/schemas/MandateManager.Application.Common.Dtos.ErrorResponse",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "401",
        "description": "<p>Unauthorized. The bearer token is missing, invalid or expired. Bearer tokens are valid for 24 hours; generate a new token and retry.</p>",
        "jsonExample": "",
        "isExpanded": true
      },
      {
        "statusCode": "403",
        "description": "Forbidden. Your account is not permitted to perform this operation.",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "example": "{\"traceId\":\"4ea61012-2d9b-413d-a5b4-90ad69a68741\",\"errors\":[{\"errorCode\":\"PAM_FORBIDDEN_ERROR\",\"errorMessage\":\"Not allowed to get payment agreement for account 6279059778044302\"}]}",
            "description": "Error response returned when a request fails.",
            "customType": "MandateManager.Application.Common.Dtos.ErrorResponse",
            "schema": [
              {
                "name": "traceId",
                "kind": "optional",
                "type": "string",
                "nullable": true,
                "description": "Unique ID for logging and tracing this request.",
                "example": "4ea61012-2d9b-413d-a5b4-90ad69a68741",
                "default": "4ea61012-2d9b-413d-a5b4-90ad69a68741",
                "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
              },
              {
                "name": "errors",
                "kind": "optional",
                "type": "array",
                "nullable": true,
                "description": "List of errors that occurred while processing the request.",
                "modelRef": "#/components/schemas/MandateManager.Application.Common.Dtos.ErrorDto",
                "customType": "MandateManager.Application.Common.Dtos.ErrorDto[]",
                "schema": [
                  {
                    "name": "errorCode",
                    "kind": "optional",
                    "type": "string",
                    "nullable": true,
                    "description": "<p>Monoova error code. See <a href=\"https://developer.monoova.com/payto-status-and-error-codes\" target=\"_blank\">PayTo Status and Error Codes</a> for the meaning of each code.</p>",
                    "example": "PAM_STARTDATE_EARLY",
                    "default": "PAM_STARTDATE_EARLY",
                    "pattern": "^[A-Z]{3}_[A-Z0-9_]+$"
                  },
                  {
                    "name": "errorMessage",
                    "kind": "optional",
                    "type": "string",
                    "nullable": true,
                    "description": "<p>More detailed description of the error, which may include information from the request.</p>",
                    "example": "paymentDetails.startDate must be future date",
                    "default": "paymentDetails.startDate must be future date",
                    "pattern": "^.+$"
                  }
                ]
              }
            ],
            "modelRef": "#/components/schemas/MandateManager.Application.Common.Dtos.ErrorResponse",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "404",
        "description": "Not Found. The payment agreement could not be found.",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "example": "{\"traceId\":\"4ea61012-2d9b-413d-a5b4-90ad69a68741\",\"errors\":[{\"errorCode\":\"PAM_PAG_NOT_FOUND_ERROR\",\"errorMessage\":\"PaymentAgreement not found for PaymentAgreementUID MONPAG12345\"}]}",
            "description": "Error response returned when a request fails.",
            "customType": "MandateManager.Application.Common.Dtos.ErrorResponse",
            "schema": [
              {
                "name": "traceId",
                "kind": "optional",
                "type": "string",
                "nullable": true,
                "description": "Unique ID for logging and tracing this request.",
                "example": "4ea61012-2d9b-413d-a5b4-90ad69a68741",
                "default": "4ea61012-2d9b-413d-a5b4-90ad69a68741",
                "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
              },
              {
                "name": "errors",
                "kind": "optional",
                "type": "array",
                "nullable": true,
                "description": "List of errors that occurred while processing the request.",
                "modelRef": "#/components/schemas/MandateManager.Application.Common.Dtos.ErrorDto",
                "customType": "MandateManager.Application.Common.Dtos.ErrorDto[]",
                "schema": [
                  {
                    "name": "errorCode",
                    "kind": "optional",
                    "type": "string",
                    "nullable": true,
                    "description": "<p>Monoova error code. See <a href=\"https://developer.monoova.com/payto-status-and-error-codes\" target=\"_blank\">PayTo Status and Error Codes</a> for the meaning of each code.</p>",
                    "example": "PAM_STARTDATE_EARLY",
                    "default": "PAM_STARTDATE_EARLY",
                    "pattern": "^[A-Z]{3}_[A-Z0-9_]+$"
                  },
                  {
                    "name": "errorMessage",
                    "kind": "optional",
                    "type": "string",
                    "nullable": true,
                    "description": "<p>More detailed description of the error, which may include information from the request.</p>",
                    "example": "paymentDetails.startDate must be future date",
                    "default": "paymentDetails.startDate must be future date",
                    "pattern": "^.+$"
                  }
                ]
              }
            ],
            "modelRef": "#/components/schemas/MandateManager.Application.Common.Dtos.ErrorResponse",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "500",
        "description": "Internal Server Error. An unexpected error occurred. Contact Monoova support if the problem persists.",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "example": "{\"traceId\":\"4ea61012-2d9b-413d-a5b4-90ad69a68741\",\"errors\":[{\"errorCode\":\"PAM_UNEXPECTED_ERROR\",\"errorMessage\":\"Internal server error. Please contact Monoova support.\"}]}",
            "description": "Error response returned when a request fails.",
            "customType": "MandateManager.Application.Common.Dtos.ErrorResponse",
            "schema": [
              {
                "name": "traceId",
                "kind": "optional",
                "type": "string",
                "nullable": true,
                "description": "Unique ID for logging and tracing this request.",
                "example": "4ea61012-2d9b-413d-a5b4-90ad69a68741",
                "default": "4ea61012-2d9b-413d-a5b4-90ad69a68741",
                "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
              },
              {
                "name": "errors",
                "kind": "optional",
                "type": "array",
                "nullable": true,
                "description": "List of errors that occurred while processing the request.",
                "modelRef": "#/components/schemas/MandateManager.Application.Common.Dtos.ErrorDto",
                "customType": "MandateManager.Application.Common.Dtos.ErrorDto[]",
                "schema": [
                  {
                    "name": "errorCode",
                    "kind": "optional",
                    "type": "string",
                    "nullable": true,
                    "description": "<p>Monoova error code. See <a href=\"https://developer.monoova.com/payto-status-and-error-codes\" target=\"_blank\">PayTo Status and Error Codes</a> for the meaning of each code.</p>",
                    "example": "PAM_STARTDATE_EARLY",
                    "default": "PAM_STARTDATE_EARLY",
                    "pattern": "^[A-Z]{3}_[A-Z0-9_]+$"
                  },
                  {
                    "name": "errorMessage",
                    "kind": "optional",
                    "type": "string",
                    "nullable": true,
                    "description": "<p>More detailed description of the error, which may include information from the request.</p>",
                    "example": "paymentDetails.startDate must be future date",
                    "default": "paymentDetails.startDate must be future date",
                    "pattern": "^.+$"
                  }
                ]
              }
            ],
            "modelRef": "#/components/schemas/MandateManager.Application.Common.Dtos.ErrorResponse",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "502",
        "description": "<p>Bad Gateway. An upstream service, such as the NPP gateway, returned an error. Retry the request later.</p>",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "example": "{\"traceId\":\"4ea61012-2d9b-413d-a5b4-90ad69a68741\",\"errors\":[{\"errorCode\":\"PAM_NPP_GATEWAY_ERROR\",\"errorMessage\":\"Error returned from NPP gateway - service unavailable\"}]}",
            "description": "Error response returned when a request fails.",
            "customType": "MandateManager.Application.Common.Dtos.ErrorResponse",
            "schema": [
              {
                "name": "traceId",
                "kind": "optional",
                "type": "string",
                "nullable": true,
                "description": "Unique ID for logging and tracing this request.",
                "example": "4ea61012-2d9b-413d-a5b4-90ad69a68741",
                "default": "4ea61012-2d9b-413d-a5b4-90ad69a68741",
                "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
              },
              {
                "name": "errors",
                "kind": "optional",
                "type": "array",
                "nullable": true,
                "description": "List of errors that occurred while processing the request.",
                "modelRef": "#/components/schemas/MandateManager.Application.Common.Dtos.ErrorDto",
                "customType": "MandateManager.Application.Common.Dtos.ErrorDto[]",
                "schema": [
                  {
                    "name": "errorCode",
                    "kind": "optional",
                    "type": "string",
                    "nullable": true,
                    "description": "<p>Monoova error code. See <a href=\"https://developer.monoova.com/payto-status-and-error-codes\" target=\"_blank\">PayTo Status and Error Codes</a> for the meaning of each code.</p>",
                    "example": "PAM_STARTDATE_EARLY",
                    "default": "PAM_STARTDATE_EARLY",
                    "pattern": "^[A-Z]{3}_[A-Z0-9_]+$"
                  },
                  {
                    "name": "errorMessage",
                    "kind": "optional",
                    "type": "string",
                    "nullable": true,
                    "description": "<p>More detailed description of the error, which may include information from the request.</p>",
                    "example": "paymentDetails.startDate must be future date",
                    "default": "paymentDetails.startDate must be future date",
                    "pattern": "^.+$"
                  }
                ]
              }
            ],
            "modelRef": "#/components/schemas/MandateManager.Application.Common.Dtos.ErrorResponse",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "504",
        "description": "<p>Gateway Timeout. An upstream service, such as the NPP gateway, did not respond in time. Retry the request later.</p>",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "example": "{\"traceId\":\"4ea61012-2d9b-413d-a5b4-90ad69a68741\",\"errors\":[{\"errorCode\":\"PAM_NPP_GATEWAY_TIMEOUT\",\"errorMessage\":\"Timeout from NPP gateway\"}]}",
            "description": "Error response returned when a request fails.",
            "customType": "MandateManager.Application.Common.Dtos.ErrorResponse",
            "schema": [
              {
                "name": "traceId",
                "kind": "optional",
                "type": "string",
                "nullable": true,
                "description": "Unique ID for logging and tracing this request.",
                "example": "4ea61012-2d9b-413d-a5b4-90ad69a68741",
                "default": "4ea61012-2d9b-413d-a5b4-90ad69a68741",
                "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
              },
              {
                "name": "errors",
                "kind": "optional",
                "type": "array",
                "nullable": true,
                "description": "List of errors that occurred while processing the request.",
                "modelRef": "#/components/schemas/MandateManager.Application.Common.Dtos.ErrorDto",
                "customType": "MandateManager.Application.Common.Dtos.ErrorDto[]",
                "schema": [
                  {
                    "name": "errorCode",
                    "kind": "optional",
                    "type": "string",
                    "nullable": true,
                    "description": "<p>Monoova error code. See <a href=\"https://developer.monoova.com/payto-status-and-error-codes\" target=\"_blank\">PayTo Status and Error Codes</a> for the meaning of each code.</p>",
                    "example": "PAM_STARTDATE_EARLY",
                    "default": "PAM_STARTDATE_EARLY",
                    "pattern": "^[A-Z]{3}_[A-Z0-9_]+$"
                  },
                  {
                    "name": "errorMessage",
                    "kind": "optional",
                    "type": "string",
                    "nullable": true,
                    "description": "<p>More detailed description of the error, which may include information from the request.</p>",
                    "example": "paymentDetails.startDate must be future date",
                    "default": "paymentDetails.startDate must be future date",
                    "pattern": "^.+$"
                  }
                ]
              }
            ],
            "modelRef": "#/components/schemas/MandateManager.Application.Common.Dtos.ErrorResponse",
            "isExpanded": true
          }
        ]
      }
    ],
    "hasXCodeSamples": false,
    "examples": {
      "languages": [
        {
          "id": "example-0-curl",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request GET \\\n     --url https://api-beta.monoova.com/au/payto/pam-v1/PaymentAgreement/{paymentAgreementUID} \\\n     --header 'accept: application/json'"
        },
        {
          "id": "example-1-javascript",
          "language": "javascript",
          "label": "javascript",
          "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n   method: 'GET',\n   headers: myHeaders,\n   redirect: 'follow'\n};\n\nfetch(\"https://api-beta.monoova.com/au/payto/pam-v1/PaymentAgreement/{paymentAgreementUID}\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "example-2-ruby",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api-beta.monoova.com/au/payto/pam-v1/PaymentAgreement/{paymentAgreementUID}\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n"
        },
        {
          "id": "example-3-python",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"https://api-beta.monoova.com/au/payto/pam-v1/PaymentAgreement/{paymentAgreementUID}\"\n\npayload = {}\nheaders = {\n   'accept': 'application/json',\n   'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        }
      ],
      "selectedLanguageId": "example-0-curl"
    },
    "results": {
      "languages": [
        {
          "id": "response-0-200",
          "language": "200",
          "code": "// OK. Returns the payment agreement.\n{\n  \"traceId\": \"1dabfaa9-abe8-4d2d-a69a-b723079d84ed\",\n  \"paymentAgreementDetails\": {\n    \"createdDateTime\": \"2026-10-16T04:25:46.183Z\",\n    \"lastModifiedDateTime\": \"2026-11-02T01:14:09.457Z\",\n    \"paymentAgreementUID\": \"MONPAG12345\",\n    \"subMerchantId\": \"93bf57eb1e2c42cf8101509b4356741e\",\n    \"mmsId\": \"a9ba56f64baa1dee9ac2d7f87c2621fa\",\n    \"registrationDateTime\": \"2026-10-16T04:25:47.031Z\",\n    \"paymentAgreementStatus\": \"Active\",\n    \"statusReasonCode\": \"M011\",\n    \"statusReasonDescription\": \"Contract Amended\",\n    \"payeeDetails\": {\n      \"payeeType\": \"ORGN\",\n      \"payeeLinkedBsb\": \"062000\",\n      \"payeeLinkedAccount\": \"12345678\",\n      \"payeeLinkedPayId\": \"payments@abccorp.com.au\",\n      \"payeeLinkedPayIdType\": \"Email\",\n      \"payeeAccountName\": \"ABC Corp Pty Ltd\",\n      \"ultimatePayee\": \"ABC Corp\",\n      \"payeeMCCCode\": \"5968\",\n      \"ultimatePayeeMCCCode\": \"5968\"\n    },\n    \"payerDetails\": {\n      \"payerType\": \"PERS\",\n      \"linkedBsb\": \"802950\",\n      \"linkedAccount\": \"22090100\",\n      \"linkedPayId\": \"+61-422020901\",\n      \"linkedPayIdType\": \"PhoneNumber\",\n      \"payer\": \"Monoova Sample 1\",\n      \"ultimatePayer\": \"Monoova Sample 1\",\n      \"payerPartyReference\": \"CUST-000123\"\n    },\n    \"paymentTerms\": {\n      \"numberOfTransactionsPermitted\": \"1\",\n      \"frequency\": \"MNTH\",\n      \"pointInTime\": \"15\",\n      \"amount\": \"50.00\",\n      \"maximumAmount\": \"100.00\",\n      \"agreementType\": \"VARI\"\n    },\n    \"paymentDetails\": {\n      \"automaticRenewal\": \"false\",\n      \"description\": \"Monthly subscription for ABC Corp services\",\n      \"shortDescription\": \"ABC Corp subscription\",\n      \"purpose\": \"RETL\",\n      \"respondByTime\": \"2026-12-28T17:00:00+11:00\",\n      \"startDate\": \"2027-01-01\",\n      \"endDate\": \"2027-12-31\"\n    },\n    \"pendingActions\": [\n      {\n        \"actionId\": \"eea687ee114eae368ca066aa62bae488\",\n        \"actionType\": \"Amend\",\n        \"bilateral\": \"true\",\n        \"status\": \"PendingApproval\"\n      }\n    ],\n    \"scheduleDetails\": {\n      \"createdDateTime\": \"2026-10-16T04:40:12.512Z\",\n      \"lastModifiedDateTime\": \"2027-01-14T22:00:03.118Z\",\n      \"scheduleId\": \"MONSCH12345\",\n      \"entityId\": \"MONPAG12345\",\n      \"entityType\": \"PaymentAgreement\",\n      \"startDate\": \"2027-01-15\",\n      \"endDate\": \"2027-12-15\",\n      \"executionTime\": \"09:00:00\",\n      \"frequency\": \"MNTH\",\n      \"scheduledAmount\": 50,\n      \"totalInstances\": 12,\n      \"totalAmount\": 600,\n      \"lastExecutionDateTime\": \"2027-01-14T22:00:00Z\",\n      \"nextExecutionDateTime\": \"2027-02-14T22:00:00Z\",\n      \"status\": \"Active\",\n      \"statusDescription\": \"Active\",\n      \"statusReasonCode\": \"CustReq\",\n      \"statusReasonDescription\": \"Requested by customer\",\n      \"paymentReference\": \"ABC Corp monthly subscription\"\n    }\n  }\n}"
        },
        {
          "id": "response-1-400",
          "language": "400",
          "code": "// Bad Request. The request failed validation. See errors for details.\n{\n  \"traceId\": \"4ea61012-2d9b-413d-a5b4-90ad69a68741\",\n  \"errors\": [\n    {\n      \"errorCode\": \"PAM_STARTDATE_EARLY\",\n      \"errorMessage\": \"paymentDetails.startDate must be future date\"\n    }\n  ]\n}"
        },
        {
          "id": "response-2-401",
          "language": "401",
          "code": "// Unauthorized. The bearer token is missing, invalid or expired. Bearer tokens are valid for 24 hours; generate a new token and retry.\n"
        },
        {
          "id": "response-3-403",
          "language": "403",
          "code": "// Forbidden. Your account is not permitted to perform this operation.\n{\n  \"traceId\": \"4ea61012-2d9b-413d-a5b4-90ad69a68741\",\n  \"errors\": [\n    {\n      \"errorCode\": \"PAM_STARTDATE_EARLY\",\n      \"errorMessage\": \"paymentDetails.startDate must be future date\"\n    }\n  ]\n}"
        },
        {
          "id": "response-4-404",
          "language": "404",
          "code": "// Not Found. The payment agreement could not be found.\n{\n  \"traceId\": \"4ea61012-2d9b-413d-a5b4-90ad69a68741\",\n  \"errors\": [\n    {\n      \"errorCode\": \"PAM_STARTDATE_EARLY\",\n      \"errorMessage\": \"paymentDetails.startDate must be future date\"\n    }\n  ]\n}"
        },
        {
          "id": "response-5-500",
          "language": "500",
          "code": "// Internal Server Error. An unexpected error occurred. Contact Monoova support if the problem persists.\n{\n  \"traceId\": \"4ea61012-2d9b-413d-a5b4-90ad69a68741\",\n  \"errors\": [\n    {\n      \"errorCode\": \"PAM_STARTDATE_EARLY\",\n      \"errorMessage\": \"paymentDetails.startDate must be future date\"\n    }\n  ]\n}"
        },
        {
          "id": "response-6-502",
          "language": "502",
          "code": "// Bad Gateway. An upstream service, such as the NPP gateway, returned an error. Retry the request later.\n{\n  \"traceId\": \"4ea61012-2d9b-413d-a5b4-90ad69a68741\",\n  \"errors\": [\n    {\n      \"errorCode\": \"PAM_STARTDATE_EARLY\",\n      \"errorMessage\": \"paymentDetails.startDate must be future date\"\n    }\n  ]\n}"
        },
        {
          "id": "response-7-504",
          "language": "504",
          "code": "// Gateway Timeout. An upstream service, such as the NPP gateway, did not respond in time. Retry the request later.\n{\n  \"traceId\": \"4ea61012-2d9b-413d-a5b4-90ad69a68741\",\n  \"errors\": [\n    {\n      \"errorCode\": \"PAM_STARTDATE_EARLY\",\n      \"errorMessage\": \"paymentDetails.startDate must be future date\"\n    }\n  ]\n}"
        }
      ],
      "selectedLanguageId": "response-0-200"
    }
  },
  "children": [
    {
      "text": ""
    }
  ]
}