--- title: Create payment instruction slug: r10-integration/create-payment-instruction createdAt: 2026-10-30T01:19:30.445Z --- { "id": "rRduefwwOA8fEHcWoZ-tu", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://api-beta.monoova.com/au/payto/pas-v1/PaymentInstruction", "servers": [ { "url": "https://api-beta.monoova.com/au/payto/pas-v1/PaymentInstruction", "description": "Beta Sandbox URL" } ], "name": "Create payment instruction", "description": "

Once a valid payment agreement has been approved by the payer, use this endpoint to create a payment instruction, which creates a real-time pull payment.

\n

You are allowed a maximum of 5 failed instructions in a 24-hour period. If you reach this limit, you need to wait until the next day to retry.

\n

The response code reflects the status of the payment: 201 when the payment is settled (ACSC), 202 while it is still being processed (an intermediate status such as INPR or SENT), and 422 when it is rejected (RJCT).

", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "Details of the payment instruction to create.", "customType": "PAS.Application.Common.Dtos.InitiateMandatePaymentDto", "schema": [ { "name": "paymentAgreementUID", "kind": "required", "type": "string", "description": "

ID of the payment agreement to make the payment under. This is the paymentAgreementUID supplied when the agreement was created. The payer must have approved the agreement.

", "example": "MONPAG12345", "default": "MONPAG12345", "pattern": "^[a-zA-Z0-9_-]{1,35}$" }, { "name": "paymentInitiationUID", "kind": "required", "type": "string", "description": "

Your unique ID for the payment instruction, from 1 to 35 characters: letters, numbers, hyphens and underscores only. A request that reuses an existing paymentInitiationUID is rejected.

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

Conditional. Details of the payee account to credit. Required if the payment agreement does not include payee details. Must not be provided if the payment agreement already includes them.

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

Optional. Type of payee. Accepted values: ORGN (organisation), PERS (individual).

", "example": "ORGN", "default": "ORGN", "pattern": "^(ORGN|PERS)$" }, { "name": "payeeLinkedBsb", "kind": "optional", "type": "string", "nullable": true, "description": "

Conditional. BSB number of the payee's account, with or without a hyphen, for example 062-000 or 062000.

\n

Required if payeeLinkedPayId and payeeLinkedPayIdType are not provided. Prohibited if payeeLinkedPayId is provided.

", "example": "062000", "default": "062000", "pattern": "^[0-9]{3}-?[0-9]{3}$" }, { "name": "payeeLinkedAccount", "kind": "optional", "type": "string", "nullable": true, "description": "

Conditional. Account number of the payee's account, from 1 to 28 characters. Must not be all zeros or spaces.

\n

Required if payeeLinkedPayId and payeeLinkedPayIdType are not provided. Prohibited if payeeLinkedPayId is provided.

", "example": "12345678", "default": "12345678", "maxLength": 28, "pattern": "^[0-9A-Za-z -]{1,28}$" }, { "name": "payeeLinkedPayId", "kind": "optional", "type": "string", "nullable": true, "description": "

Conditional. PayID of the payee: a mobile number, email address, ABN, ACN or organisation ID. The required format depends on payeeLinkedPayIdType; mobile numbers use the format +61-4XXXXXXXX.

\n

Required if payeeLinkedBsb and payeeLinkedAccount are not provided. Prohibited if payeeLinkedAccount is provided.

", "example": "payments@abccorp.com.au", "default": "payments@abccorp.com.au", "pattern": "^[ -~]{1,256}$" }, { "name": "payeeLinkedPayIdType", "kind": "optional", "type": "string", "nullable": true, "description": "

Conditional. Type of the payee's PayID. Accepted values: PhoneNumber, Email, ABN, ACN, OrganisationId.

\n

Required if payeeLinkedBsb and payeeLinkedAccount are not provided. Prohibited if payeeLinkedAccount is provided.

", "example": "Email", "default": "Email", "pattern": "^(PhoneNumber|Email|ABN|ACN|OrganisationId)$" }, { "name": "payeeAccountName", "kind": "optional", "type": "string", "nullable": true, "description": "

Conditional. Name of the payee's bank account, from 1 to 140 characters.

\n

Can only be provided when crediting an external BSB. Mandatory when crediting a PayID.

", "example": "ABC Corp Pty Ltd", "default": "ABC Corp Pty Ltd", "minLength": 1, "maxLength": 140, "pattern": "^[ -~]{1,140}$" }, { "name": "ultimatePayee", "kind": "optional", "type": "string", "nullable": true, "description": "

Optional. Name by which the ultimate payee is known and usually identified, from 1 to 140 characters.

\n

Can only be provided when crediting an external BSB.

", "example": "ABC Corp", "default": "ABC Corp", "minLength": 1, "maxLength": 140, "pattern": "^[ -~]{1,140}$" }, { "name": "payeeMCCCode", "kind": "optional", "type": "string", "nullable": true, "description": "

Conditional. Merchant Category Code (MCC) of the payee, as 4 digits. If provided, it is validated against the payee MCC allow-list configured for your account. If not provided, the default payee MCC configured for your account is used, if one exists.

\n

Mandatory if payeeType is ORGN and the payment agreement's purpose is OTHR, PERS, UTIL, GAMP or RETL.

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

Conditional. Merchant Category Code (MCC) of the ultimate payee, as 4 digits. If provided, it is validated against the ultimate payee MCC allow-list configured for your account. If not provided, the default ultimate payee MCC configured for your account is used, if one exists.

\n

Mandatory if payeeType is ORGN and the payment agreement's purpose is OTHR, PERS, UTIL, GAMP or RETL.

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

Details of the payment, such as the amount and lodgement reference.

", "modelRef": "#/components/schemas/PAS.Application.Common.Dtos.PaymentInitiationDetailsDto", "customType": "PAS.Application.Common.Dtos.PaymentInitiationDetailsDto", "schema": [ { "name": "amount", "kind": "required", "type": "string", "description": "

Amount to be transferred, in dollars with up to 2 decimal places. Must be 0.01 or more.

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

Optional. Set to true to indicate that this is the last payment initiation request for the payment agreement. Accepted values: true or false.

", "example": false, "default": false, "pattern": "^(true|false)$" }, { "name": "lodgementReference", "kind": "optional", "type": "string", "nullable": true, "description": "

Optional. Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction, from 1 to 280 characters.

", "example": "INV-2026-000123", "default": "INV-2026-000123", "minLength": 1, "maxLength": 280, "pattern": "^[ -~]{1,280}$" }, { "name": "uniqueSuperAnnuationCode", "kind": "optional", "type": "string", "nullable": true, "description": "

Conditional. Name of the identification scheme, in free text, from 1 to 35 characters. Required when uniqueSuperAnnuationIdentification is provided.

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

Conditional. Identification assigned by an institution, from 1 to 35 characters. Required when uniqueSuperAnnuationCode is provided.

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

Conditional. Payroll payment date, in YYYY-MM-DD format. Provide it only if the payment agreement's purpose is PENS.

", "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": "

Optional. ID of the sub-merchant related to this payment, from 1 to 35 characters. Only sub-merchant IDs assigned by Monoova are accepted.

", "example": "93bf57eb1e2c42cf8101509b4356741e", "default": "93bf57eb1e2c42cf8101509b4356741e", "pattern": "^[ -~]{1,35}$" } ] }, { "name": "batchInformation", "kind": "optional", "type": "object", "description": "

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

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

ID of the batch that the payment is part of, from 1 to 40 characters: letters, numbers, hyphens and underscores only. Required when batchInformation is provided.

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

Optional. Determines whether the debit side is booked as a batch or as individual transactions. Accepted values: true (report a single consolidated debit amount) or false (report individual debit transactions).

", "example": false, "default": false, "pattern": "^(true|false)$" }, { "name": "numberOfTransactions", "kind": "optional", "type": "string", "nullable": true, "description": "

Optional. Number of individual transactions in the batch, as a string of 1 to 15 digits.

", "example": "3", "default": "3", "pattern": "^[0-9]{1,15}$" }, { "name": "batchAmount", "kind": "optional", "type": "string", "nullable": true, "description": "

Optional. 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": "

Optional. 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)?)?$" } ] } ], "modelRef": "#/components/schemas/PAS.Application.Common.Dtos.InitiateMandatePaymentDto", "isExpanded": true } ], "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\",\"paymentAgreementUID\":\"MONPAG12345\",\"paymentInitiationUID\":\"MONPIR12345\",\"nppInstructionId\":\"MOPYAUS1XXXI20241119004756058205270\",\"paymentInitiationStatus\":\"ACSC\",\"paymentInitiationStatusDescription\":\"Accepted Settlement Completed\",\"mmsId\":\"a9ba56f64baa1dee9ac2d7f87c2621fa\",\"batchInformation\":{\"clientBatchIdentification\":\"MONBAT12345\",\"batchBookingIndicator\":false,\"numberOfTransactions\":\"3\",\"batchAmount\":\"150.00\",\"batchIdExpiry\":\"2026-11-30T23:59:59+11:00\",\"nppBatchIdentification\":\"MOPYAUS1XXXB20261030000000123456789\"}}", "description": "Result of a create payment instruction request.", "customType": "PAS.Application.Common.Dtos.InitiateMandatePaymentResponseDto", "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": "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 in the request.

", "example": "MONPIR12345", "default": "MONPIR12345", "pattern": "^[a-zA-Z0-9_-]{1,35}$" }, { "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": "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": "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.InitiateMandatePaymentResponseDto", "isExpanded": true } ] }, { "statusCode": "201", "description": "

Created. The payment instruction was created and the payment was settled (paymentInitiationStatus is ACSC).

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"traceId\":\"1dabfaa9-abe8-4d2d-a69a-b723079d84ed\",\"paymentAgreementUID\":\"MONPAG12345\",\"paymentInitiationUID\":\"MONPIR12345\",\"nppInstructionId\":\"MOPYAUS1XXXI20241119004756058205270\",\"paymentInitiationStatus\":\"ACSC\",\"paymentInitiationStatusDescription\":\"Accepted Settlement Completed\",\"mmsId\":\"a9ba56f64baa1dee9ac2d7f87c2621fa\",\"batchInformation\":{\"clientBatchIdentification\":\"MONBAT12345\",\"batchBookingIndicator\":false,\"numberOfTransactions\":\"3\",\"batchAmount\":\"150.00\",\"batchIdExpiry\":\"2026-11-30T23:59:59+11:00\",\"nppBatchIdentification\":\"MOPYAUS1XXXB20261030000000123456789\"}}", "description": "Result of a create payment instruction request.", "customType": "PAS.Application.Common.Dtos.InitiateMandatePaymentResponseDto", "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": "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 in the request.

", "example": "MONPIR12345", "default": "MONPIR12345", "pattern": "^[a-zA-Z0-9_-]{1,35}$" }, { "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": "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": "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.InitiateMandatePaymentResponseDto", "isExpanded": true } ] }, { "statusCode": "202", "description": "

Accepted. The payment instruction was created, but the payment has not reached a final status yet; it has an intermediate status such as INPR (In Progress) or SENT (Sent To Payer). Use Get payment instruction by ID, or the PaymentInstructionNotification webhook, to get the final status.

", "jsonExample": "", "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_DUPLICATE_INSTRUCTION\",\"errorMessage\":\"Failed to create payment instruction - Duplicate paymentInitiationUID\"}]}", "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 create 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 agreement could not be found.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"traceId\":\"4ea61012-2d9b-413d-a5b4-90ad69a68741\",\"errors\":[{\"errorCode\":\"PAS_AGREEMENT_NOT_FOUND\",\"errorMessage\":\"The PaymentAgreement with the provided ID was not found: MONPAG12345\"}]}", "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": "422", "description": "

Unprocessable Content. The payment was rejected (paymentInitiationStatus is RJCT). See errors for details.

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"traceId\":\"4ea61012-2d9b-413d-a5b4-90ad69a68741\",\"errors\":[{\"errorCode\":\"PAS_BUSINESS_RULE_ERROR\",\"errorMessage\":\"Business rule failure - payment initiation rejected\"}]}", "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 POST \\\n --url https://api-beta.monoova.com/au/payto/pas-v1/PaymentInstruction \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data-raw '{\n \"paymentAgreementUID\": \"MONPAG12345\",\n \"paymentInitiationUID\": \"MONPIR12345\",\n \"payeeDetails\": {\n \"payeeType\": \"ORGN\",\n \"payeeLinkedBsb\": \"062000\",\n \"payeeLinkedAccount\": \"12345678\",\n \"payeeLinkedPayId\": \"payments@abccorp.com.au\",\n \"payeeLinkedPayIdType\": \"Email\",\n \"payeeAccountName\": \"ABC Corp Pty Ltd\",\n \"ultimatePayee\": \"ABC Corp\",\n \"payeeMCCCode\": \"5968\",\n \"ultimatePayeeMCCCode\": \"5968\"\n },\n \"paymentDetails\": {\n \"amount\": \"50.00\",\n \"lodgementReference\": \"INV-2026-000123\",\n \"uniqueSuperAnnuationCode\": \"USI\",\n \"uniqueSuperAnnuationIdentification\": \"ABC0001AU\",\n \"payrollPaymentDate\": \"2026-11-13\",\n \"subMerchantId\": \"93bf57eb1e2c42cf8101509b4356741e\"\n },\n \"batchInformation\": {\n \"clientBatchIdentification\": \"MONBAT12345\",\n \"numberOfTransactions\": \"3\",\n \"batchAmount\": \"150.00\",\n \"batchIdExpiry\": \"2026-11-30T23:59:59+11:00\"\n }\n }'" }, { "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 raw = JSON.stringify({\n \"paymentAgreementUID\": \"MONPAG12345\",\n \"paymentInitiationUID\": \"MONPIR12345\",\n \"payeeDetails\": {\n \"payeeType\": \"ORGN\",\n \"payeeLinkedBsb\": \"062000\",\n \"payeeLinkedAccount\": \"12345678\",\n \"payeeLinkedPayId\": \"payments@abccorp.com.au\",\n \"payeeLinkedPayIdType\": \"Email\",\n \"payeeAccountName\": \"ABC Corp Pty Ltd\",\n \"ultimatePayee\": \"ABC Corp\",\n \"payeeMCCCode\": \"5968\",\n \"ultimatePayeeMCCCode\": \"5968\"\n },\n \"paymentDetails\": {\n \"amount\": \"50.00\",\n \"lodgementReference\": \"INV-2026-000123\",\n \"uniqueSuperAnnuationCode\": \"USI\",\n \"uniqueSuperAnnuationIdentification\": \"ABC0001AU\",\n \"payrollPaymentDate\": \"2026-11-13\",\n \"subMerchantId\": \"93bf57eb1e2c42cf8101509b4356741e\"\n },\n \"batchInformation\": {\n \"clientBatchIdentification\": \"MONBAT12345\",\n \"numberOfTransactions\": \"3\",\n \"batchAmount\": \"150.00\",\n \"batchIdExpiry\": \"2026-11-30T23:59:59+11:00\"\n }\n});\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://api-beta.monoova.com/au/payto/pas-v1/PaymentInstruction\", 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\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest.body = JSON.dump({\n \"paymentAgreementUID\": \"MONPAG12345\",\n \"paymentInitiationUID\": \"MONPIR12345\",\n \"payeeDetails\": {\n \"payeeType\": \"ORGN\",\n \"payeeLinkedBsb\": \"062000\",\n \"payeeLinkedAccount\": \"12345678\",\n \"payeeLinkedPayId\": \"payments@abccorp.com.au\",\n \"payeeLinkedPayIdType\": \"Email\",\n \"payeeAccountName\": \"ABC Corp Pty Ltd\",\n \"ultimatePayee\": \"ABC Corp\",\n \"payeeMCCCode\": \"5968\",\n \"ultimatePayeeMCCCode\": \"5968\"\n },\n \"paymentDetails\": {\n \"amount\": \"50.00\",\n \"lodgementReference\": \"INV-2026-000123\",\n \"uniqueSuperAnnuationCode\": \"USI\",\n \"uniqueSuperAnnuationIdentification\": \"ABC0001AU\",\n \"payrollPaymentDate\": \"2026-11-13\",\n \"subMerchantId\": \"93bf57eb1e2c42cf8101509b4356741e\"\n },\n \"batchInformation\": {\n \"clientBatchIdentification\": \"MONBAT12345\",\n \"numberOfTransactions\": \"3\",\n \"batchAmount\": \"150.00\",\n \"batchIdExpiry\": \"2026-11-30T23:59:59+11:00\"\n }\n})\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\"\n\npayload = json.dumps({\n \"paymentAgreementUID\": \"MONPAG12345\",\n \"paymentInitiationUID\": \"MONPIR12345\",\n \"payeeDetails\": {\n \"payeeType\": \"ORGN\",\n \"payeeLinkedBsb\": \"062000\",\n \"payeeLinkedAccount\": \"12345678\",\n \"payeeLinkedPayId\": \"payments@abccorp.com.au\",\n \"payeeLinkedPayIdType\": \"Email\",\n \"payeeAccountName\": \"ABC Corp Pty Ltd\",\n \"ultimatePayee\": \"ABC Corp\",\n \"payeeMCCCode\": \"5968\",\n \"ultimatePayeeMCCCode\": \"5968\"\n },\n \"paymentDetails\": {\n \"amount\": \"50.00\",\n \"lodgementReference\": \"INV-2026-000123\",\n \"uniqueSuperAnnuationCode\": \"USI\",\n \"uniqueSuperAnnuationIdentification\": \"ABC0001AU\",\n \"payrollPaymentDate\": \"2026-11-13\",\n \"subMerchantId\": \"93bf57eb1e2c42cf8101509b4356741e\"\n },\n \"batchInformation\": {\n \"clientBatchIdentification\": \"MONBAT12345\",\n \"numberOfTransactions\": \"3\",\n \"batchAmount\": \"150.00\",\n \"batchIdExpiry\": \"2026-11-30T23:59:59+11:00\"\n }\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", 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 \"paymentAgreementUID\": \"MONPAG12345\",\n \"paymentInitiationUID\": \"MONPIR12345\",\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 \"mmsId\": \"a9ba56f64baa1dee9ac2d7f87c2621fa\",\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}" }, { "id": "response-1-201", "language": "201", "code": "// Created. The payment instruction was created and the payment was settled (paymentInitiationStatus is ACSC).\n{\n \"traceId\": \"1dabfaa9-abe8-4d2d-a69a-b723079d84ed\",\n \"paymentAgreementUID\": \"MONPAG12345\",\n \"paymentInitiationUID\": \"MONPIR12345\",\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 \"mmsId\": \"a9ba56f64baa1dee9ac2d7f87c2621fa\",\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}" }, { "id": "response-2-202", "language": "202", "code": "// Accepted. The payment instruction was created, but the payment has not reached a final status yet; it has an intermediate status such as INPR (In Progress) or SENT (Sent To Payer). Use Get payment instruction by ID, or the PaymentInstructionNotification webhook, to get the final status.\n" }, { "id": "response-3-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-4-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-5-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-6-404", "language": "404", "code": "// Not Found. The payment agreement 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-7-422", "language": "422", "code": "// Unprocessable Content. The payment was rejected (paymentInitiationStatus is RJCT). 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-8-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-9-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-10-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": "" } ] }