Create payment instruction

POST

https://api-beta.monoova.com/au/payto/pas-v1/PaymentInstruction

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.

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.

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).

acceptstringGenerated from available response content types

bodyobjectDetails of the payment instruction to create.

200OK. Returns the payment instruction and its current status.

201Created. The payment instruction was created and the payment was settled (<code>paymentInitiationStatus</code> is <code>ACSC</code>).

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

400Bad Request. The request failed validation. See <code>errors</code> for details.

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

403Forbidden. Your account is not permitted to perform this operation.

404Not Found. The payment agreement could not be found.

422Unprocessable Content. The payment was rejected (<code>paymentInitiationStatus</code> is <code>RJCT</code>). See <code>errors</code> for details.

500Internal Server Error. An unexpected error occurred. Contact Monoova support if the problem persists.

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

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

curl --request POST \
     --url https://api-beta.monoova.com/au/payto/pas-v1/PaymentInstruction \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data-raw '{
     "paymentAgreementUID": "MONPAG12345",
     "paymentInitiationUID": "MONPIR12345",
     "payeeDetails": {
     "payeeType": "ORGN",
     "payeeLinkedBsb": "062000",
     "payeeLinkedAccount": "12345678",
     "payeeLinkedPayId": "[email protected]",
     "payeeLinkedPayIdType": "Email",
     "payeeAccountName": "ABC Corp Pty Ltd",
     "ultimatePayee": "ABC Corp",
     "payeeMCCCode": "5968",
     "ultimatePayeeMCCCode": "5968"
     },
     "paymentDetails": {
     "amount": "50.00",
     "lodgementReference": "INV-2026-000123",
     "uniqueSuperAnnuationCode": "USI",
     "uniqueSuperAnnuationIdentification": "ABC0001AU",
     "payrollPaymentDate": "2026-11-13",
     "subMerchantId": "93bf57eb1e2c42cf8101509b4356741e"
     },
     "batchInformation": {
     "clientBatchIdentification": "MONBAT12345",
     "numberOfTransactions": "3",
     "batchAmount": "150.00",
     "batchIdExpiry": "2026-11-30T23:59:59+11:00"
     }
     }'