Create a Payment Agreement

POST

https://api-beta.monoova.com/au/payto/pam-v1/PaymentAgreement

This endpoint creates a new payment agreement.

acceptstringGenerated from available response content types

bodyobjectDetails of the payment agreement to create.

200OK. The payment agreement was created and is pending the payer's approval.

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 account could not be found.

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/pam-v1/PaymentAgreement \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data-raw '{
     "paymentAgreementUID": "MONPAG12345",
     "subMerchantId": "93bf57eb1e2c42cf8101509b4356741e",
     "payeeDetails": {
     "payeeType": "ORGN",
     "payeeLinkedBsb": "062000",
     "payeeLinkedAccount": "12345678",
     "payeeLinkedPayId": "[email protected]",
     "payeeLinkedPayIdType": "Email",
     "payeeAccountName": "ABC Corp Pty Ltd",
     "ultimatePayee": "ABC Corp",
     "payeeMCCCode": "5968",
     "ultimatePayeeMCCCode": "5968"
     },
     "payerDetails": {
     "payerType": "PERS",
     "linkedBsb": "802950",
     "linkedAccount": "22090100",
     "linkedPayId": "+61-422020901",
     "linkedPayIdType": "PhoneNumber",
     "payer": "Monoova Sample 1",
     "ultimatePayer": "Monoova Sample 1",
     "payerPartyReference": "CUST-000123"
     },
     "paymentTerms": {
     "numberOfTransactionsPermitted": "1",
     "frequency": "MNTH",
     "pointInTime": "15",
     "amount": "50.00",
     "maximumAmount": "100.00",
     "agreementType": "VARI"
     },
     "paymentDetails": {
     "automaticRenewal": "false",
     "description": "Monthly subscription for ABC Corp services",
     "shortDescription": "ABC Corp subscription",
     "purpose": "RETL",
     "respondByTime": "2026-12-28T17:00:00+11:00",
     "startDate": "2027-01-01",
     "endDate": "2027-12-31"
     }
     }'