--- title: Get Payment Schedule by Id slug: api/get-payment-schedule-by-id docTags: createdAt: 2025-05-02T04:49:46.118Z --- { "id": "HYGRd0IfWSw0KelsPC2tQ", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://sand-api.monoova.com/au/payto/pam-v1/PaymentSchedule/{scheduleId}", "servers": [ { "url": "https://sand-api.monoova.com/au/payto/pam-v1/PaymentSchedule/{scheduleId}", "description": "Sandbox URL" }, { "url": "https://api.monoova.com/au/payto/pam-v1/PaymentSchedule/{scheduleId}", "description": "Production 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", "description": "Id to uniquely Identify a payment schedule." } ], "headerParameters": [], "queryParameters": [], "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": "GetPaymentScheduleByIdResponse", "schema": [ { "name": "traceId", "kind": "optional", "type": "string", "description": "Unique id for logging", "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", "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", "description": "Frequency of execution.", "example": "" }, { "name": "scheduledAmount", "kind": "optional", "type": "number", "description": "Value of the scheduled payment", "example": "" }, { "name": "totalInstances", "kind": "optional", "type": "integer", "description": "Number of executions after which the schedule expires.", "example": 0 }, { "name": "totalAmount", "kind": "optional", "type": "number", "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", "description": "Status of the schedule.", "example": "" }, { "name": "statusDescription", "kind": "optional", "type": "string", "description": "Description of schedule status.", "example": "" }, { "name": "statusReasonCode", "kind": "optional", "type": "string", "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/GetPaymentScheduleByIdResponse", "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", "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", "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", "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": "503", "description": "Service Unavailable", "jsonExample": "", "isExpanded": true }, { "statusCode": "504", "description": "Gateway Timeout", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "hhpqCQKIqTHKgvPdiYMgm", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://sand-api.monoova.com/au/payto/pam-v1/PaymentSchedule/{scheduleId} \\\n --header 'accept: application/json'" }, { "id": "zIu7l-RzVYnzeAgwmkrt1", "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/PaymentSchedule/{scheduleId}\", Method.Get);\nrequest.AddHeader(\"accept\", \"application/json\");\nrequest.AddHeader(\"content-type\", \"application/json\");\nRestResponse response = await client.ExecuteAsync(request);\nConsole.WriteLine(response.Content);" }, { "id": "ypJoYL4YvMrm0DkUn0pko", "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/PaymentSchedule/{scheduleId}\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "lOQ941YIjOtLF-S6ziV-t", "language": "php", "label": "PHP", "code": " 'https://sand-api.monoova.com/au/payto/pam-v1/PaymentSchedule/{scheduleId}',\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": "hhpqCQKIqTHKgvPdiYMgm" }, "results": { "languages": [ { "id": "W4m_TGW-yqvEYgS-CTdWK", "language": "200", "code": "// OK\n{\n \"traceId\": \"\",\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}" }, { "id": "nKrPhxJTe5hGsXbnLd0u7", "language": "400", "code": "// Bad Request\n{\n \"traceId\": \"\",\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"errorMessage\": \"\"\n }\n ]\n}" }, { "id": "WBif5-yX_tJj4u8JzTrpZ", "language": "403", "code": "// Forbidden\n{\n \"traceId\": \"\",\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"errorMessage\": \"\"\n }\n ]\n}" }, { "id": "_QKrelmnjrE92U5HYsz2T", "language": "404", "code": "// Not Found\n{\n \"traceId\": \"\",\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"errorMessage\": \"\"\n }\n ]\n}" }, { "id": "Ho3yezQRZm982JFrEz1IH", "language": "500", "code": "// Internal Server Error\n" }, { "id": "iUq10OCfhYfHGOS3m5AZe", "language": "502", "code": "// Bad Gateway\n" }, { "id": "8mevWaK8JKuV__39iAJKR", "language": "503", "code": "// Service Unavailable\n" }, { "id": "y5M5Umkwxmkz48obLwS2X", "language": "504", "code": "// Gateway Timeout\n" } ], "selectedLanguageId": "W4m_TGW-yqvEYgS-CTdWK" } }, "children": [ { "id": "6m-AdUg96HWry16hjluXB", "type": "paragraph", "children": [ { "text": "Previously created Payment Schedule can be retrieved individually via uniqueId." } ] } ] }