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

{
  "id": "6S4GbWp0qMpT0kgnN8qXl",
  "type": "api-oas-v2",
  "data": {
    "method": "GET",
    "url": "https://api-beta.monoova.com/au/payto/pam-v1/PaymentSchedule/{scheduleId}",
    "servers": [
      {
        "url": "https://api-beta.monoova.com/au/payto/pam-v1/PaymentSchedule/{scheduleId}",
        "description": "Beta Sandbox URL"
      }
    ],
    "name": "Get Payment Schedule by Id",
    "description": "Previously created Payment Schedule can be retrieved individually via uniqueId.",
    "contentType": "application/json",
    "request": {
      "pathParameters": [
        {
          "kind": "required",
          "name": "scheduleId",
          "type": "string",
          "example": "MONSCH12345",
          "description": "<p>ID that uniquely identifies the payment schedule. This is the <code>scheduleId</code> supplied when the schedule was created.</p>",
          "default": "MONSCH12345",
          "pattern": "^[a-zA-Z0-9_-]{1,36}$"
        }
      ],
      "headerParameters": [
        {
          "name": "accept",
          "type": "string",
          "kind": "optional",
          "description": "Generated from available response content types",
          "enum": [
            "application/json"
          ],
          "default": "application/json"
        }
      ],
      "queryParameters": [],
      "bodyDataParameters": [],
      "formDataParameters": [],
      "oAuthParameters": [
        {
          "id": "BearerAuth",
          "name": "BearerAuth",
          "kind": "optional",
          "type": "http",
          "description": "<p>Bearer token (JWT) used to authenticate PayTo API requests. Generate it with the Monoova security token endpoint (<code>/au/security/oauth-v1/Token</code>) using your mAccount number and API key, then send it in the <code>Authorization: Bearer &#x3C;token></code> header. Tokens are valid for 24 hours.</p>",
          "scheme": "bearer"
        }
      ],
      "cookieParameters": []
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "OK. Returns the payment schedule.",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "Payment schedule returned by ID.",
            "customType": "MandateManager.Application.PaymentSchedules.Dto.GetPaymentScheduleByIdResponse",
            "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": "scheduleDetails",
                "kind": "optional",
                "type": "object",
                "description": "Details of the payment schedule.",
                "modelRef": "#/components/schemas/MandateManager.Application.PaymentSchedules.Dto.PaymentScheduleDtoOut",
                "customType": "MandateManager.Application.PaymentSchedules.Dto.PaymentScheduleDtoOut",
                "schema": [
                  {
                    "name": "createdDateTime",
                    "kind": "optional",
                    "type": "string",
                    "nullable": true,
                    "description": "<p>Date and time the schedule was created, in ISO 8601 format (UTC).</p>",
                    "example": "2026-10-16T04:40:12.512Z",
                    "default": "2026-10-16T04:40:12.512Z",
                    "pattern": "^\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])T([01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(\\.\\d{1,7})?(Z|[+-]([01]\\d|2[0-3])(:?[0-5]\\d)?)?$"
                  },
                  {
                    "name": "lastModifiedDateTime",
                    "kind": "optional",
                    "type": "string",
                    "nullable": true,
                    "description": "<p>Date and time the schedule was last modified, in ISO 8601 format (UTC).</p>",
                    "example": "2027-01-14T22:00:03.118Z",
                    "default": "2027-01-14T22:00:03.118Z",
                    "pattern": "^\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])T([01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(\\.\\d{1,7})?(Z|[+-]([01]\\d|2[0-3])(:?[0-5]\\d)?)?$"
                  },
                  {
                    "name": "scheduleId",
                    "kind": "optional",
                    "type": "string",
                    "nullable": true,
                    "description": "<p>Unique <code>scheduleId</code> provided by the client when the schedule was created. Cannot be reused.</p>",
                    "example": "MONSCH12345",
                    "default": "MONSCH12345",
                    "pattern": "^[a-zA-Z0-9_-]{1,36}$"
                  },
                  {
                    "name": "entityId",
                    "kind": "optional",
                    "type": "string",
                    "nullable": true,
                    "description": "<p><code>paymentAgreementUID</code> of the payment agreement that the schedule applies to.</p>",
                    "example": "MONPAG12345",
                    "default": "MONPAG12345",
                    "pattern": "^[a-zA-Z0-9_-]{1,35}$"
                  },
                  {
                    "name": "entityType",
                    "kind": "optional",
                    "type": "string",
                    "nullable": true,
                    "description": "<p>Type of entity that the schedule applies to. Possible value: <code>PaymentAgreement</code>.</p>",
                    "example": "PaymentAgreement",
                    "default": "PaymentAgreement",
                    "pattern": "^(PaymentAgreement)$"
                  },
                  {
                    "name": "startDate",
                    "kind": "optional",
                    "type": "string",
                    "nullable": true,
                    "description": "<p>Start date of the schedule, in <code>YYYY-MM-DD</code> format.</p>",
                    "example": "2027-01-15",
                    "default": "2027-01-15",
                    "pattern": "^\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$"
                  },
                  {
                    "name": "endDate",
                    "kind": "optional",
                    "type": "string",
                    "nullable": true,
                    "description": "<p>End date of the schedule, in <code>YYYY-MM-DD</code> format.</p>",
                    "example": "2027-12-15",
                    "default": "2027-12-15",
                    "pattern": "^\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$"
                  },
                  {
                    "name": "executionTime",
                    "kind": "optional",
                    "type": "string",
                    "nullable": true,
                    "description": "<p>Time of day the schedule is intended to run, as <code>HH:MM:SS</code> in Sydney local time.</p>",
                    "example": "09:00:00",
                    "default": "09:00:00",
                    "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]$"
                  },
                  {
                    "name": "frequency",
                    "kind": "optional",
                    "type": "string",
                    "nullable": true,
                    "description": "<p>Frequency of execution.</p>\n<p>Possible values: <code>ADHO</code> (ad hoc), <code>DAIL</code> (daily), <code>FRTN</code> (fortnightly), <code>INDA</code> (intraday), <code>MIAN</code> (semi-annual), <code>MNTH</code> (monthly), <code>QURT</code> (quarterly), <code>WEEK</code> (weekly), <code>YEAR</code> (annual).</p>",
                    "example": "MNTH",
                    "default": "MNTH",
                    "pattern": "^(ADHO|DAIL|FRTN|INDA|MIAN|MNTH|QURT|WEEK|YEAR)$"
                  },
                  {
                    "name": "scheduledAmount",
                    "kind": "optional",
                    "type": "number<double>",
                    "nullable": true,
                    "description": "Amount of each scheduled payment.",
                    "example": 50,
                    "default": 50,
                    "format": "double",
                    "pattern": "^[0-9]{1,16}(\\.[0-9]{1,2})?$"
                  },
                  {
                    "name": "totalInstances",
                    "kind": "optional",
                    "type": "integer<int32>",
                    "nullable": true,
                    "description": "Number of executions after which the schedule expires.",
                    "example": 12,
                    "default": 12,
                    "format": "int32",
                    "pattern": "^[1-9][0-9]*$"
                  },
                  {
                    "name": "totalAmount",
                    "kind": "optional",
                    "type": "number<double>",
                    "nullable": true,
                    "description": "Total value of executions after which the schedule expires.",
                    "example": 600,
                    "default": 600,
                    "format": "double",
                    "pattern": "^[0-9]{1,16}(\\.[0-9]{1,2})?$"
                  },
                  {
                    "name": "lastExecutionDateTime",
                    "kind": "optional",
                    "type": "string",
                    "nullable": true,
                    "description": "<p>Date and time of the last payment execution, in ISO 8601 format (UTC).</p>",
                    "example": "2027-01-14T22:00:00Z",
                    "default": "2027-01-14T22:00:00Z",
                    "pattern": "^\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])T([01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(\\.\\d{1,7})?(Z|[+-]([01]\\d|2[0-3])(:?[0-5]\\d)?)?$"
                  },
                  {
                    "name": "nextExecutionDateTime",
                    "kind": "optional",
                    "type": "string",
                    "nullable": true,
                    "description": "<p>Date and time of the next scheduled payment execution, in ISO 8601 format (UTC).</p>",
                    "example": "2027-02-14T22:00:00Z",
                    "default": "2027-02-14T22:00:00Z",
                    "pattern": "^\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])T([01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(\\.\\d{1,7})?(Z|[+-]([01]\\d|2[0-3])(:?[0-5]\\d)?)?$"
                  },
                  {
                    "name": "status",
                    "kind": "optional",
                    "type": "string",
                    "nullable": true,
                    "description": "<p>Status of the schedule. Possible values: <code>Pending</code>, <code>Active</code>, <code>Paused</code>, <code>Cancelled</code>.</p>",
                    "example": "Active",
                    "default": "Active",
                    "pattern": "^(Pending|Active|Paused|Cancelled)$"
                  },
                  {
                    "name": "statusDescription",
                    "kind": "optional",
                    "type": "string",
                    "nullable": true,
                    "description": "Description of the schedule status.",
                    "example": "Active",
                    "default": "Active",
                    "pattern": "^.+$"
                  },
                  {
                    "name": "statusReasonCode",
                    "kind": "optional",
                    "type": "string",
                    "nullable": true,
                    "description": "<p>Reason code for the status. Possible values: <code>CustReq</code>, <code>CreateError</code>, <code>Expired</code>, <code>AgreementStatusChanged</code>, <code>InvalidPayeeDetails</code>, <code>BilateralAmendmentInitiated</code>, <code>MaxedOutTotalInstanceLimit</code>, <code>MaxedOutTotalAmountLimit</code>, <code>ExceededScheduleEndDate</code>, <code>FinalPaymentInitiated</code>, <code>SchedulingDisabled</code>.</p>",
                    "example": "CustReq",
                    "default": "CustReq",
                    "pattern": "^(CustReq|CreateError|Expired|AgreementStatusChanged|InvalidPayeeDetails|BilateralAmendmentInitiated|MaxedOutTotalInstanceLimit|MaxedOutTotalAmountLimit|ExceededScheduleEndDate|FinalPaymentInitiated|SchedulingDisabled)$"
                  },
                  {
                    "name": "statusReasonDescription",
                    "kind": "optional",
                    "type": "string",
                    "nullable": true,
                    "description": "Description of the reason code.",
                    "example": "Requested by customer",
                    "default": "Requested by customer",
                    "pattern": "^.+$"
                  },
                  {
                    "name": "paymentReference",
                    "kind": "optional",
                    "type": "string",
                    "nullable": true,
                    "description": "<p>Unique reference, assigned by the creditor, for the sequence of scheduled payments.</p>",
                    "example": "ABC Corp monthly subscription",
                    "default": "ABC Corp monthly subscription",
                    "pattern": "^[ -~]{1,280}$"
                  }
                ]
              }
            ],
            "modelRef": "#/components/schemas/MandateManager.Application.PaymentSchedules.Dto.GetPaymentScheduleByIdResponse",
            "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_SCHEDID_INVALID\",\"errorMessage\":\"scheduleId MONSCH#12345 must match ^[a-zA-Z0-9_-]{1,36}$\"}]}",
            "description": "Error response returned when a request fails.",
            "customType": "MandateManager.Application.Common.Dtos.ErrorResponse",
            "schema": [
              {
                "name": "traceId",
                "kind": "optional",
                "type": "string",
                "nullable": true,
                "description": "Unique ID for logging and tracing this request.",
                "example": "4ea61012-2d9b-413d-a5b4-90ad69a68741",
                "default": "4ea61012-2d9b-413d-a5b4-90ad69a68741",
                "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
              },
              {
                "name": "errors",
                "kind": "optional",
                "type": "array",
                "nullable": true,
                "description": "List of errors that occurred while processing the request.",
                "modelRef": "#/components/schemas/MandateManager.Application.Common.Dtos.ErrorDto",
                "customType": "MandateManager.Application.Common.Dtos.ErrorDto[]",
                "schema": [
                  {
                    "name": "errorCode",
                    "kind": "optional",
                    "type": "string",
                    "nullable": true,
                    "description": "<p>Monoova error code. See <a href=\"https://developer.monoova.com/payto-status-and-error-codes\" target=\"_blank\">PayTo Status and Error Codes</a> for the meaning of each code.</p>",
                    "example": "PAM_STARTDATE_EARLY",
                    "default": "PAM_STARTDATE_EARLY",
                    "pattern": "^[A-Z]{3}_[A-Z0-9_]+$"
                  },
                  {
                    "name": "errorMessage",
                    "kind": "optional",
                    "type": "string",
                    "nullable": true,
                    "description": "<p>More detailed description of the error, which may include information from the request.</p>",
                    "example": "paymentDetails.startDate must be future date",
                    "default": "paymentDetails.startDate must be future date",
                    "pattern": "^.+$"
                  }
                ]
              }
            ],
            "modelRef": "#/components/schemas/MandateManager.Application.Common.Dtos.ErrorResponse",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "401",
        "description": "<p>Unauthorized. The bearer token is missing, invalid or expired. Bearer tokens are valid for 24 hours; generate a new token and retry.</p>",
        "jsonExample": "",
        "isExpanded": true
      },
      {
        "statusCode": "403",
        "description": "Forbidden. Your account is not permitted to perform this operation.",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "example": "{\"traceId\":\"4ea61012-2d9b-413d-a5b4-90ad69a68741\",\"errors\":[{\"errorCode\":\"PAM_FORBIDDEN_ERROR\",\"errorMessage\":\"Not allowed to get payment schedule 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 schedule could not be found.",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "example": "{\"traceId\":\"4ea61012-2d9b-413d-a5b4-90ad69a68741\",\"errors\":[{\"errorCode\":\"PAM_SCHED_NOT_FOUND_ERROR\",\"errorMessage\":\"PaymentSchedule not found for ScheduleId MONSCH12345\"}]}",
            "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_SCHEDULER_ERROR\",\"errorMessage\":\"Error returned from scheduler service - 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": "503",
        "description": "Service Unavailable. The service is temporarily unavailable. Retry the request later.",
        "jsonExample": "",
        "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_SCHEDULER_TIMEOUT\",\"errorMessage\":\"Timeout from scheduler service\"}]}",
            "description": "Error response returned when a request fails.",
            "customType": "MandateManager.Application.Common.Dtos.ErrorResponse",
            "schema": [
              {
                "name": "traceId",
                "kind": "optional",
                "type": "string",
                "nullable": true,
                "description": "Unique ID for logging and tracing this request.",
                "example": "4ea61012-2d9b-413d-a5b4-90ad69a68741",
                "default": "4ea61012-2d9b-413d-a5b4-90ad69a68741",
                "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
              },
              {
                "name": "errors",
                "kind": "optional",
                "type": "array",
                "nullable": true,
                "description": "List of errors that occurred while processing the request.",
                "modelRef": "#/components/schemas/MandateManager.Application.Common.Dtos.ErrorDto",
                "customType": "MandateManager.Application.Common.Dtos.ErrorDto[]",
                "schema": [
                  {
                    "name": "errorCode",
                    "kind": "optional",
                    "type": "string",
                    "nullable": true,
                    "description": "<p>Monoova error code. See <a href=\"https://developer.monoova.com/payto-status-and-error-codes\" target=\"_blank\">PayTo Status and Error Codes</a> for the meaning of each code.</p>",
                    "example": "PAM_STARTDATE_EARLY",
                    "default": "PAM_STARTDATE_EARLY",
                    "pattern": "^[A-Z]{3}_[A-Z0-9_]+$"
                  },
                  {
                    "name": "errorMessage",
                    "kind": "optional",
                    "type": "string",
                    "nullable": true,
                    "description": "<p>More detailed description of the error, which may include information from the request.</p>",
                    "example": "paymentDetails.startDate must be future date",
                    "default": "paymentDetails.startDate must be future date",
                    "pattern": "^.+$"
                  }
                ]
              }
            ],
            "modelRef": "#/components/schemas/MandateManager.Application.Common.Dtos.ErrorResponse",
            "isExpanded": true
          }
        ]
      }
    ],
    "hasXCodeSamples": false,
    "examples": {
      "languages": [
        {
          "id": "example-0-curl",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request GET \\\n     --url https://api-beta.monoova.com/au/payto/pam-v1/PaymentSchedule/{scheduleId} \\\n     --header 'accept: application/json'"
        },
        {
          "id": "example-1-javascript",
          "language": "javascript",
          "label": "javascript",
          "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n   method: 'GET',\n   headers: myHeaders,\n   redirect: 'follow'\n};\n\nfetch(\"https://api-beta.monoova.com/au/payto/pam-v1/PaymentSchedule/{scheduleId}\", 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/PaymentSchedule/{scheduleId}\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n"
        },
        {
          "id": "example-3-python",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"https://api-beta.monoova.com/au/payto/pam-v1/PaymentSchedule/{scheduleId}\"\n\npayload = {}\nheaders = {\n   'accept': 'application/json',\n   'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        }
      ],
      "selectedLanguageId": "example-0-curl"
    },
    "results": {
      "languages": [
        {
          "id": "response-0-200",
          "language": "200",
          "code": "// OK. Returns the payment schedule.\n{\n  \"traceId\": \"1dabfaa9-abe8-4d2d-a69a-b723079d84ed\",\n  \"scheduleDetails\": {\n    \"createdDateTime\": \"2026-10-16T04:40:12.512Z\",\n    \"lastModifiedDateTime\": \"2027-01-14T22:00:03.118Z\",\n    \"scheduleId\": \"MONSCH12345\",\n    \"entityId\": \"MONPAG12345\",\n    \"entityType\": \"PaymentAgreement\",\n    \"startDate\": \"2027-01-15\",\n    \"endDate\": \"2027-12-15\",\n    \"executionTime\": \"09:00:00\",\n    \"frequency\": \"MNTH\",\n    \"scheduledAmount\": 50,\n    \"totalInstances\": 12,\n    \"totalAmount\": 600,\n    \"lastExecutionDateTime\": \"2027-01-14T22:00:00Z\",\n    \"nextExecutionDateTime\": \"2027-02-14T22:00:00Z\",\n    \"status\": \"Active\",\n    \"statusDescription\": \"Active\",\n    \"statusReasonCode\": \"CustReq\",\n    \"statusReasonDescription\": \"Requested by customer\",\n    \"paymentReference\": \"ABC Corp monthly subscription\"\n  }\n}"
        },
        {
          "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 schedule 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-503",
          "language": "503",
          "code": "// Service Unavailable. The service is temporarily unavailable. Retry the request later.\n"
        },
        {
          "id": "response-8-504",
          "language": "504",
          "code": "// Gateway Timeout. An upstream service, such as the NPP gateway, did not respond in time. Retry the request later.\n{\n  \"traceId\": \"4ea61012-2d9b-413d-a5b4-90ad69a68741\",\n  \"errors\": [\n    {\n      \"errorCode\": \"PAM_STARTDATE_EARLY\",\n      \"errorMessage\": \"paymentDetails.startDate must be future date\"\n    }\n  ]\n}"
        }
      ],
      "selectedLanguageId": "response-0-200"
    }
  },
  "children": [
    {
      "text": ""
    }
  ]
}