---
title: Bilateral Amendment Async
slug: api/bilateral-amendment-async
docTags: 
createdAt: 2025-01-12T22:58:42.121Z
---

{
  "id": "_ol5bjAbnGg5Pa3IIC-K_",
  "type": "api-oas-v2",
  "data": {
    "method": "PATCH",
    "url": "https://sand-api.monoova.com/au/payto/pam-v1/PaymentAgreementAsync/{paymentAgreementUID}/bilateral",
    "servers": [
      {
        "url": "https://sand-api.monoova.com/au/payto/pam-v1/PaymentAgreementAsync/{paymentAgreementUID}/bilateral",
        "description": "Sandbox URL"
      },
      {
        "url": "https://api.monoova.com/au/payto/pam-v1/PaymentAgreementAsync/{paymentAgreementUID}/bilateral",
        "description": "Production 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-patch+json",
    "request": {
      "pathParameters": [
        {
          "kind": "required",
          "name": "paymentAgreementUID",
          "type": "string",
          "description": "Id to uniquely Identify a payment agreement."
        }
      ],
      "headerParameters": [],
      "queryParameters": [],
      "bodyDataParameters": [
        {
          "kind": "optional",
          "name": "body",
          "type": "object",
          "description": "",
          "customType": "AmendBilateralDetailsDto",
          "schema": [
            {
              "name": "automaticRenewal",
              "kind": "optional",
              "type": "boolean",
              "description": "Determines if the payment agreement automatically renews at the end of the defined period.\n\nCannot be true if agreement has an endDate.  Cannot be false if agreement has no endDate.",
              "example": ""
            },
            {
              "name": "endDate",
              "kind": "optional",
              "type": "string",
              "description": "End date of the validity of the mandate. If specified, the mandate is valid until 23:59:59.999 Australia Sydney time on this date.\n\nFormat YYYY-MM-DD\n\nProhibited if agreement has automaticRenewal enabled.",
              "example": ""
            },
            {
              "name": "respondByTime",
              "kind": "optional",
              "type": "string<date-time>",
              "description": "Optional time used to indicate by when resolution of a bilateral action is requested from the other party to the payment agreement.\n\nIt will be provided in any notification sent to the counterparty. This time is for informational purposes only and does not affect the expiry time imposed by the MMS.\n\nMust be future date and less than 5 days\n\nIf not provided value will be defaulted to agreement creation datetime + 5 days\n\nTimezone must be included.",
              "example": ""
            },
            {
              "name": "paymentTerms",
              "kind": "optional",
              "type": "object",
              "description": "",
              "modelRef": "#/components/schemas/PaymentTermsDto",
              "customType": "PaymentTermsDto",
              "schema": [
                {
                  "name": "numberOfTransactionsPermitted",
                  "kind": "optional",
                  "type": "string",
                  "description": "Quantifies the number of transactions allowed per frequency.\n\nRequired for CreatePaymentAgreement, unless frequency is ADHO or pointInTime is provided.\n\nProhibited if pointInTime is provided.\n\nMay be set to \"-\" on Update to clear the field.",
                  "example": ""
                },
                {
                  "name": "frequency",
                  "kind": "optional",
                  "type": "string<ADHO | DAIL | FRTN | INDA | MIAN | MNTH | QURT | WEEK | YEAR>",
                  "description": "Specifies the regularity of an event. See Frequency Table for allowed values.\n\nRequired for CreatePaymentAgreement.",
                  "example": ""
                },
                {
                  "name": "pointInTime",
                  "kind": "optional",
                  "type": "string",
                  "description": "Qualifies the frequency in terms of an exact point in time or moment within the specified period.\n\nValid non decimal numeric value. Supported values will be 01 to 31\n\nThis field works in combination with frequency and can only be provided when frequency = MNTH\n\nThis field should not be provided if numberOfTransactionsPermitted is provided.\n\nMay be set to \"-\" on Update to clear the field.",
                  "example": ""
                },
                {
                  "name": "amount",
                  "kind": "optional",
                  "type": "string",
                  "description": "Exact amount that may be paid from the Creditor's account, per instruction.\n\nMay be set to \"-\" on Update to clear the field.",
                  "example": ""
                },
                {
                  "name": "maximumAmount",
                  "kind": "optional",
                  "type": "string",
                  "description": "Maximum amount that may be paid from the Creditor's account, per instruction.\n\nMay be set to \"-\" on Update to clear the field.",
                  "example": ""
                },
                {
                  "name": "agreementType",
                  "kind": "optional",
                  "type": "string<BALN | FIXE | USGB | VARI>",
                  "description": "Identifies the payment agreement payment arrangement.\n\nRequired for CreatePaymentAgreement.",
                  "example": ""
                }
              ]
            }
          ],
          "modelRef": "#/components/schemas/AmendBilateralDetailsDto",
          "isExpanded": true
        }
      ],
      "formDataParameters": [],
      "oAuthParameters": [
        {
          "id": "BearerAuth",
          "name": "BearerAuth",
          "kind": "optional",
          "type": "http",
          "scheme": "bearer"
        }
      ]
    },
    "responses": [
      {
        "statusCode": "202",
        "description": "Accepted",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "customType": "AsyncResponse",
            "schema": [
              {
                "name": "traceId",
                "kind": "optional",
                "type": "string",
                "description": "Unique id for logging",
                "example": ""
              },
              {
                "name": "uniqueRequestId",
                "kind": "optional",
                "type": "string",
                "description": "Server generated unique request identifier.",
                "example": ""
              }
            ],
            "modelRef": "#/components/schemas/AsyncResponse",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "400",
        "description": "Bad Request",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "customType": "ErrorResponse",
            "schema": [
              {
                "name": "traceId",
                "kind": "optional",
                "type": "string",
                "description": "Unique id for logging",
                "example": ""
              },
              {
                "name": "errors",
                "kind": "optional",
                "type": "array",
                "description": "",
                "modelRef": "#/components/schemas/ErrorDto",
                "customType": "ErrorDto[]",
                "schema": [
                  {
                    "name": "errorCode",
                    "kind": "optional",
                    "type": "string<PAM_REQ_BODY_INVALID | PAM_VALIDATION_ERROR | PAM_ACCTID_REQUIRED | PAM_PAGID_INVALID | PAM_SCHEDID_REQUIRED | PAM_SCHEDID_INVALID | PAM_SCHEDID_FORBIDDEN | PAM_PAGID_REQUIRED | PAM_PAGMMSID_REQUIRED | PAM_SCHED_INVALID | PAM_PAYER_REQUIRED | PAM_TERMS_REQUIRED | PAM_DETAILS_REQUIRED | PAM_SCHEDULE_REQUIRED | PAM_ACTION_INVALID | PAM_SCHED_FREQ_PROHIBITED | PAM_SCHED_FREQ_INVALID | PAM_JOBID_INVALID | PAM_REQUEST_EMPTY | PAM_RESOLUTION_INVALID | PAM_ENDDATE_FORBIDDEN | PAM_ENDDATE_REQUIRED | PAM_ENDDATE_EARLY | PAM_ENDDATE_INVALID | PAM_STATUS_CHG_REQUIRED | PAM_STATUS_CHG_INVALID | PAM_REASON_CODE_REQUIRED | PAM_REASON_CODE_INVALID | PAM_PAG_STATUS_INVALID | PAM_PAG_STATE_INVALID | PAM_PAG_CREDITOR_REQD | PAM_REASON_DESC_INVALID | PAM_DESC_INVALID | PAM_AMEND_DESC_INVALID | PAM_SHORT_DESC_INVALID | PAM_AMEND_SHORT_DESC_INVALID | PAM_DESC_SHORT_DESC_MISSING | PAM_PMT_FREQ_REQUIRED | PAM_PMT_FREQ_INVALID | PAM_PIT_FORBIDDEN | PAM_NUM_TRANS_INVALID | PAM_PIT_INVALID | PAM_PAG_TYPE_INVALID | PAM_AMT_TYPE_UNSUPPORTED | PAM_AMT_TYPE_INVALID_COMBINATION | PAM_AMT_TYPE_AMT_REQUIRED | PAM_AMT_INVALID | PAM_SCHED_AMT_REQUIRED | PAM_SCHED_AMT_INVALID | PAM_SCHED_AMT_TOO_LARGE | PAM_SCHED_EXECUTIONS_INVALID | PAM_SCHED_TOTAL_AMT_INVALID | PAM_MAX_AMT_INVALID | PAM_SCHED_STATUS_REQUIRED | PAM_SCHED_REASON_INVALID | PAM_SCHED_STATUS_INVALID | PAM_SCHED_STATUS_UPDATE_INVALID | PAM_SCHED_STATUS_UPDATE_NOCHANGE | PAM_AMT_GTR_MAX_AMT | PAM_AMT_GTR_ACC_AMT_LIMIT | PAM_MAX_AMT_GTR_ACC_AMT_LIMIT | PAM_TZ_INVALID | PAM_AUTO_RENEWAL_REQUIRED | PAM_PAG_PURPOSE_INVALID | PAM_CRTD_STARTDATE_INVALID | PAM_LMOD_STARTDATE_INVALID | PAM_CRTD_ENDDATE_INVALID | PAM_LMOD_ENDDATE_INVALID | PAM_STARTDATE_REQUIRED | PAM_STARTDATE_EARLY | PAM_STARTDATE_INVALID | PAM_PG_SZ_INVALID | PAM_PG_NUM_INVALID | PAM_PAYEE_EMPTY | PAM_PAYEE_TYPE_INVALID | PAM_PAYEE_ID_TYPE_FORBIDDEN | PAM_PAYEE_BSB_REQUIRED | PAM_PAYEE_BSB_INVALID | PAM_PAYEE_ACCT_REQUIRED | PAM_PAYEE_ACCT_LENGTH | PAM_PAYEE_ACCT_INVALID | PAM_PAYEE_ACCT_EMPTY | PAM_PAYEE_ID_TYPE_REQUIRED | PAM_PAYEE_ID_TYPE_INVALID | PAM_PAYEE_ID_INVALID | PAM_PAYEE_BSB_FORBIDDEN | PAM_PAYEE_ACCT_FORBIDDEN | PAM_MOV_PAYEE_ACCT_NAME_FORBIDDEN | PAM_PAYEE_ACCT_NAME_FORBIDDEN | PAM_DEFAULT_PAYEE_ACCT_NAME_REQUIRED | PAM_PAYEE_ACCT_NAME_REQUIRED | PAM_PAYEE_ACCT_NAME_INVALID | PAM_PAYEE_ACCOUNT_NAME_FORBIDDEN | PAM_ULT_PAYEE_FORBIDDEN | PAM_ULTIMATE_PAYEE_FORBIDDEN | PAM_ULT_PAYEE_INVALID | PAM_ULT_PAYEE_REQUIRED | PAM_PAYER_TYPE_REQUIRED | PAM_PAYER_TYPE_INVALID | PAM_PAYER_ID_TYPE_FORBIDDEN | PAM_PAYER_BSB_REQUIRED | PAM_PAYER_BSB_INVALID | PAM_PAYER_ACCT_REQUIRED | PAM_PAYER_ACCT_LENGTH | PAM_PAYER_ACCT_INVALID | PAM_PAYER_ACCT_EMPTY | PAM_PAYER_ID_TYPE_REQUIRED | PAM_PAYER_ID_TYPE_INVALID | PAM_PAYER_ID_INVALID | PAM_PAYER_BSB_FORBIDDEN | PAM_PAYER_ACCT_FORBIDDEN | PAM_PAYER_NAME_REQUIRED | PAM_PAYER_NAME_LENGTH | PAM_PAYER_NAME_INVALID | PAM_ULT_PAYER_REQUIRED | PAM_ULT_PAYER_LENGTH | PAM_ULT_PAYER_INVALID | PAM_PAYER_PARTY_REQUIRED | PAM_PAYER_PARTY_LENGTH | PAM_PAYER_PARTY_INVALID | PAM_PAYER_PARTY_ALNUM | PAM_INVALID_TIME_FORMAT | PAM_BSB_ACCOUNT_TOGETHER | PAM_BUSINESS_RULE_ERROR | PAM_INVALID_PURPOSE | PAM_NUMTRANS_REQUIRED | PAM_PAYMENTINFORMATION_FREQUENCYCOMBINATIONRULE | PAM_INVALID_OPERATION | PAM_CANCEL_CREATED | PAM_DEBTOR_PAUSED | PAM_PAYEE_BSB_RESTRICTED | PAM_ENDDATE_WITH_AUTORENEW | PAM_ENDDATE_TOO_OLD | PAM_ENDDATE_BEFORE_START | PAM_SCHED_START_TOO_EARLY | PAM_SCHED_START_TOO_LATE | PAM_SCHED_END_TOO_EARLY | PAM_SCHED_END_TOO_LATE | PAM_SCHED_DAY_INVALID | PAM_SCHED_ALREADY_ACTIVE | PAM_AMEND_FORBIDDEN | PAM_AMEND_PENDING | PAM_SCHED_AMEND_PENDING | PAM_AMEND_QUEUED | PAM_AMEND_REQUIRES_CHANGE | PAM_PAYER_FORBIDDEN | PAM_PAYER_MISSING | PAM_PAYEE_FORBIDDEN | PAM_DEFAULT_PAYEE_NOT_IN_ALLOWED_LIST | PAM_PAYEE_MISSING | PAM_PAYEE_ACCT_MISSING | PAM_DUP_PAYEE | PAM_PAG_LIMIT_EXCEEDED | PAM_PAG_STATUS_INACTIVE | PAM_PAG_EXISTS | PAM_PAYER_PAYEE_EXISTS | PAM_JOB_EXISTS | PAM_SCHED_EXISTS | PAM_RECORD_NOT_FOUND_ERROR | PAM_ACCT_NOT_FOUND_ERROR | PAM_PAG_NOT_FOUND_ERROR | PAM_PARTY_NOT_FOUND_ERROR | PAM_JOB_NOT_FOUND_ERROR | PAM_SCHED_NOT_FOUND_ERROR | PAM_PAG_FQN_NOT_FOUND_ERROR | PAM_ACTION_NOT_FOUND_ERROR | PAM_RECALL_INVALID | PAM_FORBIDDEN_ERROR | PAM_ACCT_MAX_TRN_EXCEEDED | PAM_ACCT_MAX_END_DATE_EXCEEDED | PAM_ACCT_AUTORENEWAL_FORBIDDEN | PAM_ACCT_PMT_FREQ_FORBIDDEN | PAM_ACCT_PMT_TYPE_FORBIDDEN | PAM_REF_INVALID | PAM_NPP_GATEWAY_ERROR | PAM_SCHEDULER_ERROR | PAM_NPP_GWM_ERROR | PAM_NPP_GATEWAY_TIMEOUT | PAM_SCHEDULER_TIMEOUT | PAM_NPP_GWM_TIMEOUT | PAM_ACCT_CFG_PURPOSE_ERROR | PAM_MAPPING_ERROR | PAM_AMOUNT_ERROR | PAM_AMOUNT_MISMATCH | PAM_CURRENCY_ERROR | PAM_INVALID_DATE_ONLY_STRING | PAM_ACCT_UPDATE_ERROR | PAM_PARTY_CREATE_ERROR | PAM_JOB_CREATE_ERROR | PAM_SCHED_CREATE_ERROR | PAM_PARTY_UPDATE_ERROR | PAM_JOB_UPDATE_ERROR | PAM_SCHED_UPDATE_ERROR | PAM_PAG_CREATE_ERROR | PAM_PAG_UPDATE_ERROR | PAM_PAG_UPSERT_ERROR | PAM_IDEMPOTENT_DETAIL_UPDATE_ERROR | PAM_UID_NOT_UNIQUE | PAM_NOT_IMPLEMENTED | PAM_UNEXPECTED_ERROR | PAM_DUPLICATE_EVENT>",
                    "description": "Monoova error code",
                    "example": ""
                  },
                  {
                    "name": "errorMessage",
                    "kind": "optional",
                    "type": "string",
                    "description": "More detailed description of the specific error which may include information from the specific request.",
                    "example": ""
                  }
                ]
              }
            ],
            "modelRef": "#/components/schemas/ErrorResponse",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "404",
        "description": "Not Found",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "customType": "ErrorResponse",
            "schema": [
              {
                "name": "traceId",
                "kind": "optional",
                "type": "string",
                "description": "Unique id for logging",
                "example": ""
              },
              {
                "name": "errors",
                "kind": "optional",
                "type": "array",
                "description": "",
                "modelRef": "#/components/schemas/ErrorDto",
                "customType": "ErrorDto[]",
                "schema": [
                  {
                    "name": "errorCode",
                    "kind": "optional",
                    "type": "string<PAM_REQ_BODY_INVALID | PAM_VALIDATION_ERROR | PAM_ACCTID_REQUIRED | PAM_PAGID_INVALID | PAM_SCHEDID_REQUIRED | PAM_SCHEDID_INVALID | PAM_SCHEDID_FORBIDDEN | PAM_PAGID_REQUIRED | PAM_PAGMMSID_REQUIRED | PAM_SCHED_INVALID | PAM_PAYER_REQUIRED | PAM_TERMS_REQUIRED | PAM_DETAILS_REQUIRED | PAM_SCHEDULE_REQUIRED | PAM_ACTION_INVALID | PAM_SCHED_FREQ_PROHIBITED | PAM_SCHED_FREQ_INVALID | PAM_JOBID_INVALID | PAM_REQUEST_EMPTY | PAM_RESOLUTION_INVALID | PAM_ENDDATE_FORBIDDEN | PAM_ENDDATE_REQUIRED | PAM_ENDDATE_EARLY | PAM_ENDDATE_INVALID | PAM_STATUS_CHG_REQUIRED | PAM_STATUS_CHG_INVALID | PAM_REASON_CODE_REQUIRED | PAM_REASON_CODE_INVALID | PAM_PAG_STATUS_INVALID | PAM_PAG_STATE_INVALID | PAM_PAG_CREDITOR_REQD | PAM_REASON_DESC_INVALID | PAM_DESC_INVALID | PAM_AMEND_DESC_INVALID | PAM_SHORT_DESC_INVALID | PAM_AMEND_SHORT_DESC_INVALID | PAM_DESC_SHORT_DESC_MISSING | PAM_PMT_FREQ_REQUIRED | PAM_PMT_FREQ_INVALID | PAM_PIT_FORBIDDEN | PAM_NUM_TRANS_INVALID | PAM_PIT_INVALID | PAM_PAG_TYPE_INVALID | PAM_AMT_TYPE_UNSUPPORTED | PAM_AMT_TYPE_INVALID_COMBINATION | PAM_AMT_TYPE_AMT_REQUIRED | PAM_AMT_INVALID | PAM_SCHED_AMT_REQUIRED | PAM_SCHED_AMT_INVALID | PAM_SCHED_AMT_TOO_LARGE | PAM_SCHED_EXECUTIONS_INVALID | PAM_SCHED_TOTAL_AMT_INVALID | PAM_MAX_AMT_INVALID | PAM_SCHED_STATUS_REQUIRED | PAM_SCHED_REASON_INVALID | PAM_SCHED_STATUS_INVALID | PAM_SCHED_STATUS_UPDATE_INVALID | PAM_SCHED_STATUS_UPDATE_NOCHANGE | PAM_AMT_GTR_MAX_AMT | PAM_AMT_GTR_ACC_AMT_LIMIT | PAM_MAX_AMT_GTR_ACC_AMT_LIMIT | PAM_TZ_INVALID | PAM_AUTO_RENEWAL_REQUIRED | PAM_PAG_PURPOSE_INVALID | PAM_CRTD_STARTDATE_INVALID | PAM_LMOD_STARTDATE_INVALID | PAM_CRTD_ENDDATE_INVALID | PAM_LMOD_ENDDATE_INVALID | PAM_STARTDATE_REQUIRED | PAM_STARTDATE_EARLY | PAM_STARTDATE_INVALID | PAM_PG_SZ_INVALID | PAM_PG_NUM_INVALID | PAM_PAYEE_EMPTY | PAM_PAYEE_TYPE_INVALID | PAM_PAYEE_ID_TYPE_FORBIDDEN | PAM_PAYEE_BSB_REQUIRED | PAM_PAYEE_BSB_INVALID | PAM_PAYEE_ACCT_REQUIRED | PAM_PAYEE_ACCT_LENGTH | PAM_PAYEE_ACCT_INVALID | PAM_PAYEE_ACCT_EMPTY | PAM_PAYEE_ID_TYPE_REQUIRED | PAM_PAYEE_ID_TYPE_INVALID | PAM_PAYEE_ID_INVALID | PAM_PAYEE_BSB_FORBIDDEN | PAM_PAYEE_ACCT_FORBIDDEN | PAM_MOV_PAYEE_ACCT_NAME_FORBIDDEN | PAM_PAYEE_ACCT_NAME_FORBIDDEN | PAM_DEFAULT_PAYEE_ACCT_NAME_REQUIRED | PAM_PAYEE_ACCT_NAME_REQUIRED | PAM_PAYEE_ACCT_NAME_INVALID | PAM_PAYEE_ACCOUNT_NAME_FORBIDDEN | PAM_ULT_PAYEE_FORBIDDEN | PAM_ULTIMATE_PAYEE_FORBIDDEN | PAM_ULT_PAYEE_INVALID | PAM_ULT_PAYEE_REQUIRED | PAM_PAYER_TYPE_REQUIRED | PAM_PAYER_TYPE_INVALID | PAM_PAYER_ID_TYPE_FORBIDDEN | PAM_PAYER_BSB_REQUIRED | PAM_PAYER_BSB_INVALID | PAM_PAYER_ACCT_REQUIRED | PAM_PAYER_ACCT_LENGTH | PAM_PAYER_ACCT_INVALID | PAM_PAYER_ACCT_EMPTY | PAM_PAYER_ID_TYPE_REQUIRED | PAM_PAYER_ID_TYPE_INVALID | PAM_PAYER_ID_INVALID | PAM_PAYER_BSB_FORBIDDEN | PAM_PAYER_ACCT_FORBIDDEN | PAM_PAYER_NAME_REQUIRED | PAM_PAYER_NAME_LENGTH | PAM_PAYER_NAME_INVALID | PAM_ULT_PAYER_REQUIRED | PAM_ULT_PAYER_LENGTH | PAM_ULT_PAYER_INVALID | PAM_PAYER_PARTY_REQUIRED | PAM_PAYER_PARTY_LENGTH | PAM_PAYER_PARTY_INVALID | PAM_PAYER_PARTY_ALNUM | PAM_INVALID_TIME_FORMAT | PAM_BSB_ACCOUNT_TOGETHER | PAM_BUSINESS_RULE_ERROR | PAM_INVALID_PURPOSE | PAM_NUMTRANS_REQUIRED | PAM_PAYMENTINFORMATION_FREQUENCYCOMBINATIONRULE | PAM_INVALID_OPERATION | PAM_CANCEL_CREATED | PAM_DEBTOR_PAUSED | PAM_PAYEE_BSB_RESTRICTED | PAM_ENDDATE_WITH_AUTORENEW | PAM_ENDDATE_TOO_OLD | PAM_ENDDATE_BEFORE_START | PAM_SCHED_START_TOO_EARLY | PAM_SCHED_START_TOO_LATE | PAM_SCHED_END_TOO_EARLY | PAM_SCHED_END_TOO_LATE | PAM_SCHED_DAY_INVALID | PAM_SCHED_ALREADY_ACTIVE | PAM_AMEND_FORBIDDEN | PAM_AMEND_PENDING | PAM_SCHED_AMEND_PENDING | PAM_AMEND_QUEUED | PAM_AMEND_REQUIRES_CHANGE | PAM_PAYER_FORBIDDEN | PAM_PAYER_MISSING | PAM_PAYEE_FORBIDDEN | PAM_DEFAULT_PAYEE_NOT_IN_ALLOWED_LIST | PAM_PAYEE_MISSING | PAM_PAYEE_ACCT_MISSING | PAM_DUP_PAYEE | PAM_PAG_LIMIT_EXCEEDED | PAM_PAG_STATUS_INACTIVE | PAM_PAG_EXISTS | PAM_PAYER_PAYEE_EXISTS | PAM_JOB_EXISTS | PAM_SCHED_EXISTS | PAM_RECORD_NOT_FOUND_ERROR | PAM_ACCT_NOT_FOUND_ERROR | PAM_PAG_NOT_FOUND_ERROR | PAM_PARTY_NOT_FOUND_ERROR | PAM_JOB_NOT_FOUND_ERROR | PAM_SCHED_NOT_FOUND_ERROR | PAM_PAG_FQN_NOT_FOUND_ERROR | PAM_ACTION_NOT_FOUND_ERROR | PAM_RECALL_INVALID | PAM_FORBIDDEN_ERROR | PAM_ACCT_MAX_TRN_EXCEEDED | PAM_ACCT_MAX_END_DATE_EXCEEDED | PAM_ACCT_AUTORENEWAL_FORBIDDEN | PAM_ACCT_PMT_FREQ_FORBIDDEN | PAM_ACCT_PMT_TYPE_FORBIDDEN | PAM_REF_INVALID | PAM_NPP_GATEWAY_ERROR | PAM_SCHEDULER_ERROR | PAM_NPP_GWM_ERROR | PAM_NPP_GATEWAY_TIMEOUT | PAM_SCHEDULER_TIMEOUT | PAM_NPP_GWM_TIMEOUT | PAM_ACCT_CFG_PURPOSE_ERROR | PAM_MAPPING_ERROR | PAM_AMOUNT_ERROR | PAM_AMOUNT_MISMATCH | PAM_CURRENCY_ERROR | PAM_INVALID_DATE_ONLY_STRING | PAM_ACCT_UPDATE_ERROR | PAM_PARTY_CREATE_ERROR | PAM_JOB_CREATE_ERROR | PAM_SCHED_CREATE_ERROR | PAM_PARTY_UPDATE_ERROR | PAM_JOB_UPDATE_ERROR | PAM_SCHED_UPDATE_ERROR | PAM_PAG_CREATE_ERROR | PAM_PAG_UPDATE_ERROR | PAM_PAG_UPSERT_ERROR | PAM_IDEMPOTENT_DETAIL_UPDATE_ERROR | PAM_UID_NOT_UNIQUE | PAM_NOT_IMPLEMENTED | PAM_UNEXPECTED_ERROR | PAM_DUPLICATE_EVENT>",
                    "description": "Monoova error code",
                    "example": ""
                  },
                  {
                    "name": "errorMessage",
                    "kind": "optional",
                    "type": "string",
                    "description": "More detailed description of the specific error which may include information from the specific request.",
                    "example": ""
                  }
                ]
              }
            ],
            "modelRef": "#/components/schemas/ErrorResponse",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "500",
        "description": "Internal Server Error",
        "jsonExample": "",
        "isExpanded": true
      },
      {
        "statusCode": "502",
        "description": "Bad Gateway",
        "jsonExample": "",
        "isExpanded": true
      }
    ],
    "hasXCodeSamples": false,
    "examples": {
      "languages": [
        {
          "id": "FYH1U-ysINOhu3zmxFAd4",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request PATCH \\\n     --url https://sand-api.monoova.com/au/payto/pam-v1/PaymentAgreementAsync/{paymentAgreementUID}/bilateral \\\n     --header 'accept: application/json'"
        },
        {
          "id": "l7beMIj0XSqf4E2-Eu6hF",
          "language": "csharp",
          "label": "C#",
          "code": "var options = new RestClientOptions(\"https://sand-api.monoova.com\")\n{\n   MaxTimeout = -1,\n};\nvar client = new RestClient(options);\nvar request = new RestRequest(\"/au/payto/pam-v1/PaymentAgreementAsync/{paymentAgreementUID}/bilateral\", Method.Patch);\nrequest.AddHeader(\"accept\", \"application/json\");\nrequest.AddHeader(\"content-type\", \"application/json-patch+json\");\nRestResponse response = await client.ExecuteAsync(request);\nConsole.WriteLine(response.Content);"
        },
        {
          "id": "9vtWZa9L0IvR70iLPD35b",
          "language": "javascript",
          "label": "JavaScript",
          "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json-patch+json\");\n\nvar requestOptions = {\n   method: 'PATCH',\n   headers: myHeaders,\n   redirect: 'follow'\n};\n\nfetch(\"https://sand-api.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": "KJGUBYRi9v9vsRYKo9XIy",
          "language": "php",
          "label": "PHP",
          "code": "<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, array(\n   CURLOPT_URL => 'https://sand-api.monoova.com/au/payto/pam-v1/PaymentAgreementAsync/{paymentAgreementUID}/bilateral',\n   CURLOPT_RETURNTRANSFER => true,\n   CURLOPT_ENCODING => '',\n   CURLOPT_MAXREDIRS => 10,\n   CURLOPT_TIMEOUT => 0,\n   CURLOPT_FOLLOWLOCATION => true,\n   CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n   CURLOPT_CUSTOMREQUEST => 'PATCH',\n   CURLOPT_HTTPHEADER => array(\n      'accept: application/json',\n      'content-type: application/json-patch+json'\n   ),\n));\n\n$response = curl_exec($curl);\n\ncurl_close($curl);\necho $response;\n"
        }
      ],
      "selectedLanguageId": "FYH1U-ysINOhu3zmxFAd4"
    },
    "results": {
      "languages": [
        {
          "id": "B5cTCJy9okA-NpXOhQJ5T",
          "language": "202",
          "code": "// Accepted\n{\n  \"traceId\": \"\",\n  \"uniqueRequestId\": \"\"\n}"
        },
        {
          "id": "UgEqVjKheF9ZTJ0Yttcnj",
          "language": "400",
          "code": "// Bad Request\n{\n  \"traceId\": \"\",\n  \"errors\": [\n    {\n      \"errorCode\": \"\",\n      \"errorMessage\": \"\"\n    }\n  ]\n}"
        },
        {
          "id": "UzkFkTBTsnRaFku7cPyMG",
          "language": "404",
          "code": "// Not Found\n{\n  \"traceId\": \"\",\n  \"errors\": [\n    {\n      \"errorCode\": \"\",\n      \"errorMessage\": \"\"\n    }\n  ]\n}"
        },
        {
          "id": "gDI1pWttAxwdzMrIFtQbp",
          "language": "500",
          "code": "// Internal Server Error\n"
        },
        {
          "id": "Ug_IzmKEi0Kh6VyLueAzk",
          "language": "502",
          "code": "// Bad Gateway\n"
        }
      ],
      "selectedLanguageId": "B5cTCJy9okA-NpXOhQJ5T"
    }
  },
  "children": [
    {
      "id": "1C40RgRE1GM0t0_YiD8NC",
      "type": "paragraph",
      "children": [
        {
          "text": "The purpose of this endpoint is to asynchronously amend a payment agreement which requires approval from the Payer."
        }
      ]
    },
    {
      "id": "Q-A4CbvJWZKAWPJ3alhne",
      "type": "paragraph",
      "children": [
        {
          "text": "Changes made using this end point will only get reflected after payer approves the change."
        }
      ]
    },
    {
      "id": "GFLk-ybtkNJCxrvl2ok8P",
      "type": "paragraph",
      "children": [
        {
          "text": "The API returns as soon as the amend request has been captured and validated for background processing."
        }
      ]
    }
  ]
}