---
title: Get Payment Agreements by Date Range
slug: api/get-payment-agreements-by-date-range
docTags: 
createdAt: 2025-01-12T22:58:42.121Z
---

{
  "id": "9MKiwXwA9X7Xz8e8Esdv5",
  "type": "api-oas-v2",
  "data": {
    "method": "GET",
    "url": "https://sand-api.monoova.com/au/payto/pam-v1/PaymentAgreement",
    "servers": [
      {
        "url": "https://sand-api.monoova.com/au/payto/pam-v1/PaymentAgreement",
        "description": "Sandbox URL"
      },
      {
        "url": "https://api.monoova.com/au/payto/pam-v1/PaymentAgreement",
        "description": "Production URL"
      }
    ],
    "name": "Get Payment Agreements by Date Range",
    "description": "Retrieve a list of payment agreements created in a date range.",
    "contentType": "application/json",
    "request": {
      "pathParameters": [],
      "headerParameters": [],
      "queryParameters": [
        {
          "kind": "optional",
          "name": "createdStartDate",
          "type": "string<date-time>",
          "description": "<p>Date must be ISO 8601 date-time format. Cannot be future date.</p>\n<p>it is recommended that either createdStartDate or lastModifiedStartDate is provided.</p>"
        },
        {
          "kind": "optional",
          "name": "createdEndDate",
          "type": "string<date-time>",
          "description": "<p>Date must be ISO 8601 date-time format.  Cannot be future date.</p>\n<p>Cannot be earlier than createdStartDate. Cannot be more than 1 month after createdStartDate.</p>\n<p>Defaults to createdStartDate + 24 hours.</p>"
        },
        {
          "kind": "optional",
          "name": "lastModifiedStartDate",
          "type": "string<date-time>",
          "description": "<p>Date must be ISO 8601 date-time format.</p>\n<p>it is recommended that either createdStartDate or lastModifiedStartDate is provided.</p>"
        },
        {
          "kind": "optional",
          "name": "lastModifiedEndDate",
          "type": "string<date-time>",
          "description": "<p>Date must be ISO 8601 date-time format.</p>"
        },
        {
          "kind": "optional",
          "name": "paymentAgreementUid",
          "type": "string",
          "description": ""
        },
        {
          "kind": "optional",
          "name": "mmsId",
          "type": "string",
          "description": "This is the unique ID that identifies this payment agreement."
        },
        {
          "kind": "optional",
          "name": "pageNumber",
          "type": "integer<int32>",
          "description": "Page to be returned after records are split as per pageSize"
        },
        {
          "kind": "optional",
          "name": "pageSize",
          "type": "integer<int32>",
          "description": "Number of records per page."
        }
      ],
      "bodyDataParameters": [],
      "formDataParameters": [],
      "oAuthParameters": [
        {
          "id": "BearerAuth",
          "name": "BearerAuth",
          "kind": "optional",
          "type": "http",
          "scheme": "bearer"
        }
      ]
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "OK",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "customType": "GetPaymentAgreementsListResponse",
            "schema": [
              {
                "name": "traceId",
                "kind": "optional",
                "type": "string",
                "description": "Unique id for logging",
                "example": ""
              },
              {
                "name": "paymentAgreementDetails",
                "kind": "optional",
                "type": "array",
                "description": "",
                "modelRef": "#/components/schemas/PaymentAgreementDto",
                "customType": "PaymentAgreementDto[]",
                "schema": [
                  {
                    "name": "createdDateTime",
                    "kind": "optional",
                    "type": "string",
                    "example": ""
                  },
                  {
                    "name": "lastModifiedDateTime",
                    "kind": "optional",
                    "type": "string",
                    "example": ""
                  },
                  {
                    "name": "paymentAgreementUID",
                    "kind": "optional",
                    "type": "string",
                    "example": ""
                  },
                  {
                    "name": "mmsId",
                    "kind": "optional",
                    "type": "string",
                    "example": ""
                  },
                  {
                    "name": "registrationDateTime",
                    "kind": "optional",
                    "type": "string",
                    "example": ""
                  },
                  {
                    "name": "paymentAgreementStatus",
                    "kind": "optional",
                    "type": "string",
                    "example": ""
                  },
                  {
                    "name": "statusReasonCode",
                    "kind": "optional",
                    "type": "string",
                    "example": ""
                  },
                  {
                    "name": "statusReasonDescription",
                    "kind": "optional",
                    "type": "string",
                    "example": ""
                  },
                  {
                    "name": "payeeDetails",
                    "kind": "optional",
                    "type": "object",
                    "description": "",
                    "modelRef": "#/components/schemas/PayeeDetailsDto",
                    "customType": "PayeeDetailsDto",
                    "schema": [
                      {
                        "name": "payeeType",
                        "kind": "optional",
                        "type": "string<ORGN | PERS>",
                        "description": "ype of payee; Organisation or Individual.",
                        "example": ""
                      },
                      {
                        "name": "payeeLinkedBsb",
                        "kind": "optional",
                        "type": "string",
                        "description": "BSB number.\n\nFor Create, required if 'payeeLinkedPayId' and 'payeeLinkedPayIdType' are not provided.\n\nProhibited if payeeLinkedPayId is provided.",
                        "example": ""
                      },
                      {
                        "name": "payeeLinkedAccount",
                        "kind": "optional",
                        "type": "string",
                        "description": "Bank Account Number.\n\nRequired if 'payeeLinkedPayId' and 'payeeLinkedPayIdType' are not provided.\n\nProhibited if payeeLinkedPayId is provided.\n\nMust not be all zeros or spaces.",
                        "example": ""
                      },
                      {
                        "name": "payeeLinkedPayId",
                        "kind": "optional",
                        "type": "string",
                        "description": "PayID.\n\nEmail, phone number, ABN, ACN or Organisation name.\n\nRequired if 'payeeLinkedBsb' and 'payeeLinkedAccount' are not provided.\n\nProhibited if payeeLinkedAccount is provided.\n\nRequired format depends on the payeeLinkedPayIdType",
                        "example": ""
                      },
                      {
                        "name": "payeeLinkedPayIdType",
                        "kind": "optional",
                        "type": "string<PhoneNumber | Email | ABN | ACN | OrganisationId>",
                        "description": "PayID Type.\n\nRequired if 'payeeLinkedBsb' and 'payeeLinkedAccount' are not provided.\n\nProhibited if payeeLinkedAccount is provided.",
                        "example": ""
                      },
                      {
                        "name": "payeeAccountName",
                        "kind": "optional",
                        "type": "string",
                        "description": "Bank Account Name\n\nCan only provide payeeAccountName in the payload if crediting an external BSB. Mandatory if crediting a PayID.\n\nAllowed external payeeAccountNames may also be white-listed in the Account configuration.",
                        "example": ""
                      },
                      {
                        "name": "ultimatePayee",
                        "kind": "optional",
                        "type": "string",
                        "description": "Name by which the ultimate party is known, and which is usually used to identify that party.\n\nCan only provide ultimatePayee in the payload if crediting an external BSB.\n\nAllowed external ultimatePayee names may also be white-listed in the Account configuration.",
                        "example": ""
                      }
                    ]
                  },
                  {
                    "name": "payerDetails",
                    "kind": "optional",
                    "type": "object",
                    "description": "",
                    "modelRef": "#/components/schemas/PayerDetailsDto",
                    "customType": "PayerDetailsDto",
                    "schema": [
                      {
                        "name": "payerType",
                        "kind": "required",
                        "type": "string<ORGN | PERS>",
                        "description": "Type of payer; Organisation or Individual.",
                        "example": ""
                      },
                      {
                        "name": "linkedBsb",
                        "kind": "optional",
                        "type": "string",
                        "description": "BSB number.\n\nFor Create, required if 'linkedPayId' and 'linkedPayIdType' are not provided.\n\nProhibited if linkedPayId is provided.",
                        "example": ""
                      },
                      {
                        "name": "linkedAccount",
                        "kind": "optional",
                        "type": "string",
                        "description": "Bank Account Number.\n\nRequired if 'linkedPayId' and 'linkedPayIdType' are not provided.\n\nProhibited if linkedPayId is provided.\n\nMust not be all zeros or spaces.",
                        "example": ""
                      },
                      {
                        "name": "linkedPayId",
                        "kind": "optional",
                        "type": "string",
                        "description": "PayID.\n\nEmail, phone number, ABN, ACN or Organisation name.\n\nRequired if 'linkedBsb' and 'linkedAccount' are not provided.\n\nProhibited if linkedAccount is provided.\n\nRequired format depends on the linkedPayIdType",
                        "example": ""
                      },
                      {
                        "name": "linkedPayIdType",
                        "kind": "optional",
                        "type": "string<PhoneNumber | Email | ABN | ACN | OrganisationId>",
                        "description": "PayID Type.\n\nRequired if 'linkedBsb' and 'linkedAccount' are not provided.\n\nProhibited if linkedAccount is provided.",
                        "example": ""
                      },
                      {
                        "name": "payer",
                        "kind": "required",
                        "type": "string",
                        "description": "Name by which the paying party is known, and which is usually used to identify that party.",
                        "example": ""
                      },
                      {
                        "name": "ultimatePayer",
                        "kind": "required",
                        "type": "string",
                        "description": "Name by which the ultimate paying party is known, and which is usually used to identify that party.",
                        "example": ""
                      },
                      {
                        "name": "payerPartyReference",
                        "kind": "required",
                        "type": "string",
                        "description": "This field will be presented to Payer in the detail agreement view.\n\nThis field also be used group payment initiations associated with a payment agreement.\n\nMust not be all zeros and spaces.",
                        "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": ""
                      }
                    ]
                  },
                  {
                    "name": "paymentDetails",
                    "kind": "optional",
                    "type": "object",
                    "description": "",
                    "modelRef": "#/components/schemas/PaymentDetailsDto",
                    "customType": "PaymentDetailsDto",
                    "schema": [
                      {
                        "name": "automaticRenewal",
                        "kind": "required",
                        "type": "boolean",
                        "description": "Determines if the payment agreement automatically renews at the end of the defined period.\n\nendDate cannot be present if automaticRenewal is set as 'true', endDate must be present if automaticRenewal is set as 'false'.",
                        "example": ""
                      },
                      {
                        "name": "description",
                        "kind": "optional",
                        "type": "string",
                        "description": "Reason for the mandate setup as narrative text.\n\nEither \"description\" or \"short_description\" must be present.",
                        "example": ""
                      },
                      {
                        "name": "shortDescription",
                        "kind": "optional",
                        "type": "string",
                        "description": "Reason for the mandate setup as narrative text.\n\nEither \"description\" or \"short_description\" must be present.",
                        "example": ""
                      },
                      {
                        "name": "purpose",
                        "kind": "optional",
                        "type": "string<MORT | UTIL | LOAN | DEPD | GAMP | RETL | SALA | PERS | GOVT | PENS | TAXS | OTHR>",
                        "description": "Payment Purpose Code.\n\nDefault value and allowed values are configured on a per client account basis.",
                        "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": "startDate",
                        "kind": "required",
                        "type": "string",
                        "description": "Start date of the validity of the mandate. The mandate is valid as of 00:00:00.000 Australia Sydney time on this date.\n\nMust be future dated.",
                        "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\nRequired if automaticRenewal is false, prohibited if automaticRenewal is true.\n\nCannot be less than startDate.",
                        "example": ""
                      }
                    ]
                  },
                  {
                    "name": "scheduleDetails",
                    "kind": "optional",
                    "type": "object",
                    "description": "",
                    "modelRef": "#/components/schemas/PaymentScheduleDtoOut",
                    "customType": "PaymentScheduleDtoOut",
                    "schema": [
                      {
                        "name": "createdDateTime",
                        "kind": "optional",
                        "type": "string",
                        "description": "DateTime the schedule was created, in ISO 8601 format and UTC timezone.",
                        "example": ""
                      },
                      {
                        "name": "lastModifiedDateTime",
                        "kind": "optional",
                        "type": "string",
                        "description": "DateTime the schedule was last modified, in ISO 8601 format and UTC timezone.",
                        "example": ""
                      },
                      {
                        "name": "scheduleId",
                        "kind": "optional",
                        "type": "string",
                        "description": "Unique scheduleId as provided by client at creation.\r\nCannot be re-used.",
                        "example": ""
                      },
                      {
                        "name": "entityId",
                        "kind": "optional",
                        "type": "string",
                        "description": "entityId (paymentAgreementUid) that the schedule applies to.",
                        "example": ""
                      },
                      {
                        "name": "entityType",
                        "kind": "optional",
                        "type": "string<PaymentAgreement>",
                        "description": "Type of entity that the schedule applies to.",
                        "example": ""
                      },
                      {
                        "name": "startDate",
                        "kind": "optional",
                        "type": "string",
                        "description": "Start date of the schedule.",
                        "example": ""
                      },
                      {
                        "name": "endDate",
                        "kind": "optional",
                        "type": "string",
                        "description": "End date of the schedule.",
                        "example": ""
                      },
                      {
                        "name": "executionTime",
                        "kind": "optional",
                        "type": "string",
                        "description": "time of day that the schedule is intended to be executed as HH:MM:SS (Sydney local time)",
                        "example": ""
                      },
                      {
                        "name": "frequency",
                        "kind": "optional",
                        "type": "string<ADHO | DAIL | FRTN | INDA | MIAN | MNTH | QURT | WEEK | YEAR>",
                        "description": "Frequency of execution.",
                        "example": ""
                      },
                      {
                        "name": "scheduledAmount",
                        "kind": "optional",
                        "type": "number<double>",
                        "description": "Value of the scheduled payment",
                        "example": ""
                      },
                      {
                        "name": "totalInstances",
                        "kind": "optional",
                        "type": "integer<int32>",
                        "description": "Number of executions after which the schedule expires.",
                        "example": 0
                      },
                      {
                        "name": "totalAmount",
                        "kind": "optional",
                        "type": "number<double>",
                        "description": "Total value of executions after which the schedule expires.",
                        "example": ""
                      },
                      {
                        "name": "lastExecutionDateTime",
                        "kind": "optional",
                        "type": "string",
                        "description": "DateTime of last payment execution, in ISO 8601 format and UTC timezone.",
                        "example": ""
                      },
                      {
                        "name": "nextExecutionDateTime",
                        "kind": "optional",
                        "type": "string",
                        "description": "DateTime of next scheduled payment execution, in ISO 8601 format and UTC timezone.",
                        "example": ""
                      },
                      {
                        "name": "status",
                        "kind": "optional",
                        "type": "string<Pending | Active | Paused | Cancelled>",
                        "description": "Status of the schedule.",
                        "example": ""
                      },
                      {
                        "name": "statusDescription",
                        "kind": "optional",
                        "type": "string",
                        "description": "Description of schedule status.",
                        "example": ""
                      },
                      {
                        "name": "statusReasonCode",
                        "kind": "optional",
                        "type": "string<CustReq | CreateError | Expired | AgreementStatusChanged | InvalidPayeeDetails | BilateralAmendmentInitiated | MaxedOutTotalInstanceLimit | MaxedOutTotalAmountLimit | ExceededScheduleEndDate | FinalPaymentInitiated | SchedulingDisabled>",
                        "description": "Reason code for status.",
                        "example": ""
                      },
                      {
                        "name": "statusReasonDescription",
                        "kind": "optional",
                        "type": "string",
                        "description": "Description of reason code.",
                        "example": ""
                      },
                      {
                        "name": "paymentReference",
                        "kind": "optional",
                        "type": "string",
                        "description": "Unique reference, as assigned by the creditor, to refer to the sequence of scheduled payments.",
                        "example": ""
                      }
                    ]
                  }
                ]
              }
            ],
            "modelRef": "#/components/schemas/GetPaymentAgreementsListResponse",
            "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": "403",
        "description": "Forbidden",
        "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
      },
      {
        "statusCode": "504",
        "description": "Gateway Timeout",
        "jsonExample": "",
        "isExpanded": true
      }
    ],
    "hasXCodeSamples": false,
    "examples": {
      "languages": [
        {
          "id": "I25vz4KRAY0JOT0dQRYEJ",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request GET \\\n     --url https://sand-api.monoova.com/au/payto/pam-v1/PaymentAgreement \\\n     --header 'accept: application/json'"
        },
        {
          "id": "Bl-rVc0H5gVTm2lU9nN9U",
          "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/PaymentAgreement\", Method.Get);\nrequest.AddHeader(\"accept\", \"application/json\");\nrequest.AddHeader(\"content-type\", \"application/json\");\nRestResponse response = await client.ExecuteAsync(request);\nConsole.WriteLine(response.Content);"
        },
        {
          "id": "AONkcuRAy1lpl-jFuKqP7",
          "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://sand-api.monoova.com/au/payto/pam-v1/PaymentAgreement\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "2z30WVZMxfHzCRFmT-p_b",
          "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/PaymentAgreement',\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 => 'GET',\n   CURLOPT_HTTPHEADER => array(\n      'accept: application/json',\n      'content-type: application/json'\n   ),\n));\n\n$response = curl_exec($curl);\n\ncurl_close($curl);\necho $response;\n"
        }
      ],
      "selectedLanguageId": "I25vz4KRAY0JOT0dQRYEJ"
    },
    "results": {
      "languages": [
        {
          "id": "FUY6dq1wGl40gWoZliEWB",
          "language": "200",
          "code": "// OK\n{\n  \"traceId\": \"\",\n  \"paymentAgreementDetails\": [\n    {\n      \"createdDateTime\": \"\",\n      \"lastModifiedDateTime\": \"\",\n      \"paymentAgreementUID\": \"\",\n      \"mmsId\": \"\",\n      \"registrationDateTime\": \"\",\n      \"paymentAgreementStatus\": \"\",\n      \"statusReasonCode\": \"\",\n      \"statusReasonDescription\": \"\",\n      \"payeeDetails\": {\n        \"payeeType\": \"\",\n        \"payeeLinkedBsb\": \"\",\n        \"payeeLinkedAccount\": \"\",\n        \"payeeLinkedPayId\": \"\",\n        \"payeeLinkedPayIdType\": \"\",\n        \"payeeAccountName\": \"\",\n        \"ultimatePayee\": \"\"\n      },\n      \"payerDetails\": {\n        \"payerType\": \"\",\n        \"linkedBsb\": \"\",\n        \"linkedAccount\": \"\",\n        \"linkedPayId\": \"\",\n        \"linkedPayIdType\": \"\",\n        \"payer\": \"\",\n        \"ultimatePayer\": \"\",\n        \"payerPartyReference\": \"\"\n      },\n      \"paymentTerms\": {\n        \"numberOfTransactionsPermitted\": \"\",\n        \"frequency\": \"\",\n        \"pointInTime\": \"\",\n        \"amount\": \"\",\n        \"maximumAmount\": \"\",\n        \"agreementType\": \"\"\n      },\n      \"paymentDetails\": {\n        \"automaticRenewal\": false,\n        \"description\": \"\",\n        \"shortDescription\": \"\",\n        \"purpose\": \"\",\n        \"respondByTime\": \"\",\n        \"startDate\": \"\",\n        \"endDate\": \"\"\n      },\n      \"scheduleDetails\": {\n        \"createdDateTime\": \"\",\n        \"lastModifiedDateTime\": \"\",\n        \"scheduleId\": \"\",\n        \"entityId\": \"\",\n        \"entityType\": \"\",\n        \"startDate\": \"\",\n        \"endDate\": \"\",\n        \"executionTime\": \"\",\n        \"frequency\": \"\",\n        \"scheduledAmount\": \"\",\n        \"totalInstances\": \"\",\n        \"totalAmount\": \"\",\n        \"lastExecutionDateTime\": \"\",\n        \"nextExecutionDateTime\": \"\",\n        \"status\": \"\",\n        \"statusDescription\": \"\",\n        \"statusReasonCode\": \"\",\n        \"statusReasonDescription\": \"\",\n        \"paymentReference\": \"\"\n      }\n    }\n  ]\n}"
        },
        {
          "id": "vI0FHb4NlWNzYbJuvuyox",
          "language": "400",
          "code": "// Bad Request\n{\n  \"traceId\": \"\",\n  \"errors\": [\n    {\n      \"errorCode\": \"\",\n      \"errorMessage\": \"\"\n    }\n  ]\n}"
        },
        {
          "id": "Zu4o419r__LyhEx1_ZxGx",
          "language": "403",
          "code": "// Forbidden\n{\n  \"traceId\": \"\",\n  \"errors\": [\n    {\n      \"errorCode\": \"\",\n      \"errorMessage\": \"\"\n    }\n  ]\n}"
        },
        {
          "id": "Jf-RWjv86bcSSdbfz02sd",
          "language": "404",
          "code": "// Not Found\n{\n  \"traceId\": \"\",\n  \"errors\": [\n    {\n      \"errorCode\": \"\",\n      \"errorMessage\": \"\"\n    }\n  ]\n}"
        },
        {
          "id": "e_20NvOYbs9E8SlNgWwDZ",
          "language": "500",
          "code": "// Internal Server Error\n"
        },
        {
          "id": "XmHgTaH1Z5eEmKa_yh1Nj",
          "language": "502",
          "code": "// Bad Gateway\n"
        },
        {
          "id": "Rli5V66cWFxofJbTZ5G8B",
          "language": "504",
          "code": "// Gateway Timeout\n"
        }
      ],
      "selectedLanguageId": "FUY6dq1wGl40gWoZliEWB"
    }
  },
  "children": [
    {
      "id": "rNqqLZmNIFGYLQacRYNDq",
      "type": "paragraph",
      "children": [
        {
          "text": "Retrieve a list of payment agreements created in a date range."
        }
      ]
    }
  ]
}