--- title: Get payment instruction by ID slug: r10-integration/get-payment-instruction-by-id createdAt: 2026-10-30T01:19:30.445Z --- { "id": "zh7xTw31_UwEVVQpe33Sb", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://api-beta.monoova.com/au/payto/pas-v1/PaymentInstruction/{paymentInitiationUID}", "servers": [ { "url": "https://api-beta.monoova.com/au/payto/pas-v1/PaymentInstruction/{paymentInitiationUID}", "description": "Beta Sandbox URL" } ], "name": "Get payment instruction by ID", "description": "

Previously created payment instructions can be retrieved individually by their paymentInitiationUID.

", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "paymentInitiationUID", "type": "string", "example": "MONPIR12345", "description": "

ID that uniquely identifies the payment instruction. This is the paymentInitiationUID supplied when the payment instruction was created.

", "default": "MONPIR12345", "pattern": "^[A-Za-z0-9_-]{1,35}$" } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "BearerAuth", "name": "BearerAuth", "kind": "optional", "type": "http", "description": "

Bearer token (JWT) used to authenticate PayTo API requests. Generate it with the Monoova security token endpoint (/au/security/oauth-v1/Token) using your mAccount number and API key, then send it in the Authorization: Bearer <token> header. Tokens are valid for 24 hours.

", "scheme": "bearer" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "OK. Returns the payment instruction and its current status.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"traceId\":\"1dabfaa9-abe8-4d2d-a69a-b723079d84ed\",\"paymentInitiationDetail\":{\"paymentAgreementUID\":\"MONPAG12345\",\"paymentInitiationUID\":\"MONPIR12345\",\"mmsId\":\"a9ba56f64baa1dee9ac2d7f87c2621fa\",\"nppInstructionId\":\"MOPYAUS1XXXI20241119004756058205270\",\"paymentInitiationStatus\":\"ACSC\",\"paymentInitiationStatusDescription\":\"Accepted Settlement Completed\",\"subMerchantId\":\"93bf57eb1e2c42cf8101509b4356741e\",\"payeeMCCCode\":\"5968\",\"ultimatePayeeMCCCode\":\"5968\",\"batchInformation\":{\"clientBatchIdentification\":\"MONBAT12345\",\"batchBookingIndicator\":false,\"numberOfTransactions\":\"3\",\"batchAmount\":\"150.00\",\"batchIdExpiry\":\"2026-11-30T23:59:59+11:00\",\"nppBatchIdentification\":\"MOPYAUS1XXXB20261030000000123456789\"}}}", "description": "Payment instruction returned by ID.", "customType": "PAS.Application.Common.Dtos.GetPaymentInstructionByIdResponse", "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": "paymentInitiationDetail", "kind": "optional", "type": "object", "description": "Details and current status of the payment instruction.", "modelRef": "#/components/schemas/PAS.Application.PaymentInstructions.Models.PaymentInstructionStatusResponseDto", "customType": "PAS.Application.PaymentInstructions.Models.PaymentInstructionStatusResponseDto", "schema": [ { "name": "paymentAgreementUID", "kind": "optional", "type": "string", "nullable": true, "description": "ID that uniquely identifies the payment agreement that the payment was made under.", "example": "MONPAG12345", "default": "MONPAG12345", "pattern": "^[a-zA-Z0-9_-]{1,35}$" }, { "name": "paymentInitiationUID", "kind": "optional", "type": "string", "nullable": true, "description": "

ID that uniquely identifies the payment instruction, as supplied when it was created.

", "example": "MONPIR12345", "default": "MONPIR12345", "pattern": "^[a-zA-Z0-9_-]{1,35}$" }, { "name": "scheduleId", "kind": "optional", "type": "string", "nullable": true, "description": "

ID of the payment schedule that triggered the payment, if any.

", "example": "MONSCH12345", "default": "MONSCH12345", "pattern": "^[a-zA-Z0-9_-]{1,36}$" }, { "name": "mmsId", "kind": "optional", "type": "string", "nullable": true, "description": "

Unique ID that identifies the payment agreement to the NPP (MMS ID).

", "example": "a9ba56f64baa1dee9ac2d7f87c2621fa", "default": "a9ba56f64baa1dee9ac2d7f87c2621fa", "pattern": "^[a-f0-9]{32}$" }, { "name": "nppInstructionId", "kind": "optional", "type": "string", "nullable": true, "description": "Unique ID of the payment instruction in the NPP.", "example": "MOPYAUS1XXXI20241119004756058205270", "default": "MOPYAUS1XXXI20241119004756058205270", "pattern": "^[A-Za-z0-9]{1,35}$" }, { "name": "paymentInitiationStatus", "kind": "optional", "type": "string", "nullable": true, "description": "

Status of the payment instruction. Intermediate statuses: INPR (In Progress), SENT (Sent To Payer), RECV (Received), ACCP (Accepted Customer Profile), ACSP (Accepted Settlement in Process), SAFD (Participant Down), UNDV (Undelivered). Final statuses: ACSC (Accepted Settlement Completed), RJCT (Rejected).

", "example": "ACSC", "default": "ACSC", "pattern": "^(INPR|SENT|SAFD|ACCP|ACSP|ACSC|RJCT|RECV|UNDV)$" }, { "name": "paymentInitiationStatusDescription", "kind": "optional", "type": "string", "nullable": true, "description": "Description of the payment instruction status.", "example": "Accepted Settlement Completed", "default": "Accepted Settlement Completed", "pattern": "^.+$" }, { "name": "statusReasonCode", "kind": "optional", "type": "string", "nullable": true, "description": "

Reason code for the current status, if any; for example, the reason a payment was rejected (RJCT). Possible values: R001 to R072, R200 to R232 and R999. See PayTo Status and Error Codes for code descriptions.

", "example": "R016", "default": "R016", "pattern": "^R(0(0[1-9]|[1-6][0-9]|7[0-2])|2([0-2][0-9]|3[0-2])|999)$" }, { "name": "statusReasonDescription", "kind": "optional", "type": "string", "nullable": true, "description": "Description of the status reason code.", "example": "Amount of funds available to cover specified message amount is insufficient", "default": "Amount of funds available to cover specified message amount is insufficient", "pattern": "^.+$" }, { "name": "payrollPaymentDate", "kind": "optional", "type": "string", "nullable": true, "description": "

Payroll payment date supplied in the request, in YYYY-MM-DD format.

", "example": "2026-11-13", "default": "2026-11-13", "pattern": "^\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$" }, { "name": "subMerchantId", "kind": "optional", "type": "string", "nullable": true, "description": "

ID of the sub-merchant related to the payment.

", "example": "93bf57eb1e2c42cf8101509b4356741e", "default": "93bf57eb1e2c42cf8101509b4356741e", "pattern": "^[ -~]{1,35}$" }, { "name": "payeeMCCCode", "kind": "optional", "type": "string", "nullable": true, "description": "

Merchant Category Code (MCC) of the payee, as 4 digits.

", "example": "5968", "default": "5968", "pattern": "^[0-9]{4}$" }, { "name": "ultimatePayeeMCCCode", "kind": "optional", "type": "string", "nullable": true, "description": "

Merchant Category Code (MCC) of the ultimate payee, as 4 digits.

", "example": "5968", "default": "5968", "pattern": "^[0-9]{4}$" }, { "name": "batchInformation", "kind": "optional", "type": "object", "description": "

Details of the batch, if the payment is part of a batch.

", "modelRef": "#/components/schemas/PAS.Application.Common.Dtos.BatchInformationDtoOut", "customType": "PAS.Application.Common.Dtos.BatchInformationDtoOut", "schema": [ { "name": "clientBatchIdentification", "kind": "required", "type": "string", "nullable": true, "description": "

ID of the batch that the payment is part of, as supplied in the request.

", "example": "MONBAT12345", "default": "MONBAT12345", "pattern": "^[a-zA-Z0-9_-]{1,40}$" }, { "name": "batchBookingIndicator", "kind": "optional", "type": "boolean", "nullable": true, "description": "

Whether the debit side is booked as a batch or as individual transactions: true means a single consolidated debit amount is reported; false means individual debit transactions are reported.

", "example": false, "default": false, "pattern": "^(true|false)$" }, { "name": "numberOfTransactions", "kind": "optional", "type": "string", "nullable": true, "description": "Number of individual transactions in the batch.", "example": "3", "default": "3", "pattern": "^[0-9]{1,15}$" }, { "name": "batchAmount", "kind": "optional", "type": "string", "nullable": true, "description": "

Total of all individual amounts in the batch, in dollars with up to 2 decimal places.

", "example": "150.00", "default": "150.00", "pattern": "^(?=.{1,19}$)(?=.*[0-9])[0-9]{0,18}(\\.[0-9]{0,2})?$" }, { "name": "batchIdExpiry", "kind": "optional", "type": "string", "nullable": true, "description": "

Date and time when the batch ID expires, in ISO 8601 date-time format.

", "example": "2026-11-30T23:59:59+11:00", "default": "2026-11-30T23:59:59+11:00", "pattern": "^\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])T([01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(\\.\\d{1,7})?(Z|[+-]([01]\\d|2[0-3])(:?[0-5]\\d)?)?$" }, { "name": "nppBatchIdentification", "kind": "optional", "type": "string", "nullable": true, "description": "

Unique industry batch ID, generated by Monoova for the NPP.

", "example": "MOPYAUS1XXXB20261030000000123456789", "default": "MOPYAUS1XXXB20261030000000123456789", "pattern": "^[A-Za-z0-9]{1,35}$" } ] } ] } ], "modelRef": "#/components/schemas/PAS.Application.Common.Dtos.GetPaymentInstructionByIdResponse", "isExpanded": true } ] }, { "statusCode": "400", "description": "

Bad Request. The request failed validation. See errors for details.

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"traceId\":\"4ea61012-2d9b-413d-a5b4-90ad69a68741\",\"errors\":[{\"errorCode\":\"PAS_PMT_UID_INVALID\",\"errorMessage\":\"paymentInitiationUID MONPIR.12345 must match ^[A-Za-z0-9_-]{1,35}$\"}]}", "description": "Error response returned when a request fails.", "customType": "PAS.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/PAS.Application.Common.Dtos.ErrorDto", "customType": "PAS.Application.Common.Dtos.ErrorDto[]", "schema": [ { "name": "errorCode", "kind": "optional", "type": "string", "nullable": true, "description": "

Monoova error code. See PayTo Status and Error Codes for the meaning of each code.

", "example": "PAS_AMT_REQUIRED", "default": "PAS_AMT_REQUIRED", "pattern": "^[A-Z]{3}_[A-Z0-9_]+$" }, { "name": "errorMessage", "kind": "optional", "type": "string", "nullable": true, "description": "

More detailed description of the error, which may include information from the request.

", "example": "paymentDetails.amount is required", "default": "paymentDetails.amount is required", "pattern": "^.+$" } ] } ], "modelRef": "#/components/schemas/PAS.Application.Common.Dtos.ErrorResponse", "isExpanded": true } ] }, { "statusCode": "401", "description": "

Unauthorized. The bearer token is missing, invalid or expired. Bearer tokens are valid for 24 hours; generate a new token and retry.

", "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\":\"PAS_FORBIDDEN_ERROR\",\"errorMessage\":\"Not allowed to get payment instruction for account 6279059778044302\"}]}", "description": "Error response returned when a request fails.", "customType": "PAS.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/PAS.Application.Common.Dtos.ErrorDto", "customType": "PAS.Application.Common.Dtos.ErrorDto[]", "schema": [ { "name": "errorCode", "kind": "optional", "type": "string", "nullable": true, "description": "

Monoova error code. See PayTo Status and Error Codes for the meaning of each code.

", "example": "PAS_AMT_REQUIRED", "default": "PAS_AMT_REQUIRED", "pattern": "^[A-Z]{3}_[A-Z0-9_]+$" }, { "name": "errorMessage", "kind": "optional", "type": "string", "nullable": true, "description": "

More detailed description of the error, which may include information from the request.

", "example": "paymentDetails.amount is required", "default": "paymentDetails.amount is required", "pattern": "^.+$" } ] } ], "modelRef": "#/components/schemas/PAS.Application.Common.Dtos.ErrorResponse", "isExpanded": true } ] }, { "statusCode": "404", "description": "Not Found. The payment instruction could not be found.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"traceId\":\"4ea61012-2d9b-413d-a5b4-90ad69a68741\",\"errors\":[{\"errorCode\":\"PAS_INSTRUCTION_NOT_FOUND\",\"errorMessage\":\"PaymentInstruction MONPIR12345 is not found\"}]}", "description": "Error response returned when a request fails.", "customType": "PAS.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/PAS.Application.Common.Dtos.ErrorDto", "customType": "PAS.Application.Common.Dtos.ErrorDto[]", "schema": [ { "name": "errorCode", "kind": "optional", "type": "string", "nullable": true, "description": "

Monoova error code. See PayTo Status and Error Codes for the meaning of each code.

", "example": "PAS_AMT_REQUIRED", "default": "PAS_AMT_REQUIRED", "pattern": "^[A-Z]{3}_[A-Z0-9_]+$" }, { "name": "errorMessage", "kind": "optional", "type": "string", "nullable": true, "description": "

More detailed description of the error, which may include information from the request.

", "example": "paymentDetails.amount is required", "default": "paymentDetails.amount is required", "pattern": "^.+$" } ] } ], "modelRef": "#/components/schemas/PAS.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\":\"PAS_UNEXPECTED_ERROR\",\"errorMessage\":\"Internal server error. Please contact Monoova support.\"}]}", "description": "Error response returned when a request fails.", "customType": "PAS.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/PAS.Application.Common.Dtos.ErrorDto", "customType": "PAS.Application.Common.Dtos.ErrorDto[]", "schema": [ { "name": "errorCode", "kind": "optional", "type": "string", "nullable": true, "description": "

Monoova error code. See PayTo Status and Error Codes for the meaning of each code.

", "example": "PAS_AMT_REQUIRED", "default": "PAS_AMT_REQUIRED", "pattern": "^[A-Z]{3}_[A-Z0-9_]+$" }, { "name": "errorMessage", "kind": "optional", "type": "string", "nullable": true, "description": "

More detailed description of the error, which may include information from the request.

", "example": "paymentDetails.amount is required", "default": "paymentDetails.amount is required", "pattern": "^.+$" } ] } ], "modelRef": "#/components/schemas/PAS.Application.Common.Dtos.ErrorResponse", "isExpanded": true } ] }, { "statusCode": "502", "description": "

Bad Gateway. An upstream service, such as the NPP gateway, returned an error. Retry the request later.

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"traceId\":\"4ea61012-2d9b-413d-a5b4-90ad69a68741\",\"errors\":[{\"errorCode\":\"PAS_NPP_GATEWAY_ERROR\",\"errorMessage\":\"Error returned from NPP gateway - service unavailable\"}]}", "description": "Error response returned when a request fails.", "customType": "PAS.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/PAS.Application.Common.Dtos.ErrorDto", "customType": "PAS.Application.Common.Dtos.ErrorDto[]", "schema": [ { "name": "errorCode", "kind": "optional", "type": "string", "nullable": true, "description": "

Monoova error code. See PayTo Status and Error Codes for the meaning of each code.

", "example": "PAS_AMT_REQUIRED", "default": "PAS_AMT_REQUIRED", "pattern": "^[A-Z]{3}_[A-Z0-9_]+$" }, { "name": "errorMessage", "kind": "optional", "type": "string", "nullable": true, "description": "

More detailed description of the error, which may include information from the request.

", "example": "paymentDetails.amount is required", "default": "paymentDetails.amount is required", "pattern": "^.+$" } ] } ], "modelRef": "#/components/schemas/PAS.Application.Common.Dtos.ErrorResponse", "isExpanded": true } ] }, { "statusCode": "504", "description": "

Gateway Timeout. An upstream service, such as the NPP gateway, did not respond in time. Retry the request later.

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"traceId\":\"4ea61012-2d9b-413d-a5b4-90ad69a68741\",\"errors\":[{\"errorCode\":\"PAS_NPP_GATEWAY_TIMEOUT\",\"errorMessage\":\"Timeout calling NPP gateway\"}]}", "description": "Error response returned when a request fails.", "customType": "PAS.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/PAS.Application.Common.Dtos.ErrorDto", "customType": "PAS.Application.Common.Dtos.ErrorDto[]", "schema": [ { "name": "errorCode", "kind": "optional", "type": "string", "nullable": true, "description": "

Monoova error code. See PayTo Status and Error Codes for the meaning of each code.

", "example": "PAS_AMT_REQUIRED", "default": "PAS_AMT_REQUIRED", "pattern": "^[A-Z]{3}_[A-Z0-9_]+$" }, { "name": "errorMessage", "kind": "optional", "type": "string", "nullable": true, "description": "

More detailed description of the error, which may include information from the request.

", "example": "paymentDetails.amount is required", "default": "paymentDetails.amount is required", "pattern": "^.+$" } ] } ], "modelRef": "#/components/schemas/PAS.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/pas-v1/PaymentInstruction/{paymentInitiationUID} \\\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/pas-v1/PaymentInstruction/{paymentInitiationUID}\", 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/pas-v1/PaymentInstruction/{paymentInitiationUID}\")\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/pas-v1/PaymentInstruction/{paymentInitiationUID}\"\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 instruction and its current status.\n{\n \"traceId\": \"1dabfaa9-abe8-4d2d-a69a-b723079d84ed\",\n \"paymentInitiationDetail\": {\n \"paymentAgreementUID\": \"MONPAG12345\",\n \"paymentInitiationUID\": \"MONPIR12345\",\n \"scheduleId\": \"MONSCH12345\",\n \"mmsId\": \"a9ba56f64baa1dee9ac2d7f87c2621fa\",\n \"nppInstructionId\": \"MOPYAUS1XXXI20241119004756058205270\",\n \"paymentInitiationStatus\": \"ACSC\",\n \"paymentInitiationStatusDescription\": \"Accepted Settlement Completed\",\n \"statusReasonCode\": \"R016\",\n \"statusReasonDescription\": \"Amount of funds available to cover specified message amount is insufficient\",\n \"payrollPaymentDate\": \"2026-11-13\",\n \"subMerchantId\": \"93bf57eb1e2c42cf8101509b4356741e\",\n \"payeeMCCCode\": \"5968\",\n \"ultimatePayeeMCCCode\": \"5968\",\n \"batchInformation\": {\n \"clientBatchIdentification\": \"MONBAT12345\",\n \"batchBookingIndicator\": false,\n \"numberOfTransactions\": \"3\",\n \"batchAmount\": \"150.00\",\n \"batchIdExpiry\": \"2026-11-30T23:59:59+11:00\",\n \"nppBatchIdentification\": \"MOPYAUS1XXXB20261030000000123456789\"\n }\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\": \"PAS_AMT_REQUIRED\",\n \"errorMessage\": \"paymentDetails.amount is required\"\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\": \"PAS_AMT_REQUIRED\",\n \"errorMessage\": \"paymentDetails.amount is required\"\n }\n ]\n}" }, { "id": "response-4-404", "language": "404", "code": "// Not Found. The payment instruction could not be found.\n{\n \"traceId\": \"4ea61012-2d9b-413d-a5b4-90ad69a68741\",\n \"errors\": [\n {\n \"errorCode\": \"PAS_AMT_REQUIRED\",\n \"errorMessage\": \"paymentDetails.amount is required\"\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\": \"PAS_AMT_REQUIRED\",\n \"errorMessage\": \"paymentDetails.amount is required\"\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\": \"PAS_AMT_REQUIRED\",\n \"errorMessage\": \"paymentDetails.amount is required\"\n }\n ]\n}" }, { "id": "response-7-504", "language": "504", "code": "// Gateway Timeout. An upstream service, such as the NPP gateway, did not respond in time. Retry the request later.\n{\n \"traceId\": \"4ea61012-2d9b-413d-a5b4-90ad69a68741\",\n \"errors\": [\n {\n \"errorCode\": \"PAS_AMT_REQUIRED\",\n \"errorMessage\": \"paymentDetails.amount is required\"\n }\n ]\n}" } ], "selectedLanguageId": "response-0-200" } }, "children": [ { "text": "" } ] }