---
title: Bilateral Amendment Async
slug: r10-integration/bilateral-amendment-async
createdAt: 2026-10-29T06:44:31.903Z
---

{
  "id": "6UD4vzFU0IxjS8-lPzrfV",
  "type": "api-oas-v2",
  "data": {
    "method": "PATCH",
    "url": "https://api-beta.monoova.com/au/payto/pam-v1/PaymentAgreementAsync/{paymentAgreementUID}/bilateral",
    "servers": [
      {
        "url": "https://api-beta.monoova.com/au/payto/pam-v1/PaymentAgreementAsync/{paymentAgreementUID}/bilateral",
        "description": "Beta Sandbox URL"
      }
    ],
    "name": "Bilateral Amendment Async",
    "description": "The purpose of this endpoint is to asynchronously amend a payment agreement which requires approval from the Payer.\n\nChanges made using this end point will only get reflected after payer approves the change.\n\nThe API returns as soon as the amend request has been captured and validated for background processing.",
    "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": [
        {
          "kind": "required",
          "name": "body",
          "type": "object",
          "description": "Changes to a payment agreement that need the payer's approval. Include only the fields you want to change.",
          "customType": "MandateManager.Application.Common.Dtos.AmendBilateralDetailsDto",
          "schema": [
            {
              "name": "automaticRenewal",
              "kind": "optional",
              "type": "string",
              "nullable": true,
              "description": "<p><strong>Optional</strong>. 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>Cannot be <code>true</code> if the agreement has an <code>endDate</code>. Cannot be <code>false</code> if the agreement has no <code>endDate</code>.</p>",
              "example": "false",
              "default": "false",
              "pattern": "^(true|false)$"
            },
            {
              "name": "endDate",
              "kind": "optional",
              "type": "string",
              "nullable": true,
              "description": "<p><strong>Optional</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>Prohibited if the agreement has <code>automaticRenewal</code> enabled.</p>",
              "example": "2028-06-30",
              "default": "2028-06-30",
              "pattern": "^\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$"
            },
            {
              "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": "paymentTerms",
              "kind": "optional",
              "type": "object",
              "description": "<p><strong>Optional</strong>. New payment terms for the agreement. Include only the terms you want to change.</p>",
              "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)$"
                }
              ]
            }
          ],
          "modelRef": "#/components/schemas/MandateManager.Application.Common.Dtos.AmendBilateralDetailsDto",
          "isExpanded": true
        }
      ],
      "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": "202",
        "description": "<p>Accepted. The request was validated and accepted for background processing. Use <code>uniqueRequestId</code> to check its status.</p>",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "Confirmation that an asynchronous request was accepted for background processing.",
            "customType": "MandateManager.Application.Common.Dtos.AsyncResponse",
            "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": "uniqueRequestId",
                "kind": "optional",
                "type": "string",
                "nullable": true,
                "description": "<p>Server-generated unique ID of the async request. Use it with the Get Async Payment Agreement Request Status endpoint to check progress.</p>",
                "example": "4834dba5-27b0-465c-aea7-aa530315c68c",
                "default": "4834dba5-27b0-465c-aea7-aa530315c68c",
                "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
              }
            ],
            "modelRef": "#/components/schemas/MandateManager.Application.Common.Dtos.AsyncResponse",
            "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_AMEND_PENDING\",\"errorMessage\":\"Can not amend payment agreement with pending bilateral amend\"}]}",
            "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 amend 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 PATCH \\\n     --url https://api-beta.monoova.com/au/payto/pam-v1/PaymentAgreementAsync/{paymentAgreementUID}/bilateral \\\n     --header 'accept: application/json' \\\n     --header 'content-type: application/json' \\\n     --data '{\n     \"automaticRenewal\": \"false\",\n     \"endDate\": \"2028-06-30\",\n     \"respondByTime\": \"2026-12-28T17:00:00+11:00\",\n     \"paymentTerms\": {\n     \"numberOfTransactionsPermitted\": \"1\",\n     \"frequency\": \"MNTH\",\n     \"pointInTime\": \"15\",\n     \"amount\": \"50.00\",\n     \"maximumAmount\": \"100.00\",\n     \"agreementType\": \"VARI\"\n     }\n     }'"
        },
        {
          "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 raw = JSON.stringify({\n   \"automaticRenewal\": \"false\",\n   \"endDate\": \"2028-06-30\",\n   \"respondByTime\": \"2026-12-28T17:00:00+11:00\",\n   \"paymentTerms\": {\n      \"numberOfTransactionsPermitted\": \"1\",\n      \"frequency\": \"MNTH\",\n      \"pointInTime\": \"15\",\n      \"amount\": \"50.00\",\n      \"maximumAmount\": \"100.00\",\n      \"agreementType\": \"VARI\"\n   }\n});\n\nvar requestOptions = {\n   method: 'PATCH',\n   headers: myHeaders,\n   body: raw,\n   redirect: 'follow'\n};\n\nfetch(\"https://api-beta.monoova.com/au/payto/pam-v1/PaymentAgreementAsync/{paymentAgreementUID}/bilateral\", 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/PaymentAgreementAsync/{paymentAgreementUID}/bilateral\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Patch.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest.body = JSON.dump({\n   \"automaticRenewal\": \"false\",\n   \"endDate\": \"2028-06-30\",\n   \"respondByTime\": \"2026-12-28T17:00:00+11:00\",\n   \"paymentTerms\": {\n      \"numberOfTransactionsPermitted\": \"1\",\n      \"frequency\": \"MNTH\",\n      \"pointInTime\": \"15\",\n      \"amount\": \"50.00\",\n      \"maximumAmount\": \"100.00\",\n      \"agreementType\": \"VARI\"\n   }\n})\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/PaymentAgreementAsync/{paymentAgreementUID}/bilateral\"\n\npayload = json.dumps({\n   \"automaticRenewal\": \"false\",\n   \"endDate\": \"2028-06-30\",\n   \"respondByTime\": \"2026-12-28T17:00:00+11:00\",\n   \"paymentTerms\": {\n      \"numberOfTransactionsPermitted\": \"1\",\n      \"frequency\": \"MNTH\",\n      \"pointInTime\": \"15\",\n      \"amount\": \"50.00\",\n      \"maximumAmount\": \"100.00\",\n      \"agreementType\": \"VARI\"\n   }\n})\nheaders = {\n   'accept': 'application/json',\n   'content-type': 'application/json'\n}\n\nresponse = requests.request(\"PATCH\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        }
      ],
      "selectedLanguageId": "example-0-curl"
    },
    "results": {
      "languages": [
        {
          "id": "response-0-202",
          "language": "202",
          "code": "// Accepted. The request was validated and accepted for background processing. Use uniqueRequestId to check its status.\n{\n  \"traceId\": \"1dabfaa9-abe8-4d2d-a69a-b723079d84ed\",\n  \"uniqueRequestId\": \"4834dba5-27b0-465c-aea7-aa530315c68c\"\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-202"
    }
  },
  "children": [
    {
      "text": ""
    }
  ]
}