Create Payment Agreement Async
POST
https://beta-api.monoova.com/au/payto/pam-v1/PaymentAgreementAsync
Body Parameters
- bodyMandateManager.Application.Common.Dtos.CreatePaymentAgreementDtorequiredDescription
- paymentAgreementUIDstringrequiredExampleDescriptionDefaultMONPAG12345Pattern^[a-zA-Z0-9_-]{1,35}$
- subMerchantIdstringExampleDescriptionDefault93bf57eb1e2c42cf8101509b4356741ePattern^[ -~]{1,35}$
- payeeDetailsMandateManager.Application.Common.Dtos.PayeeDetailsDtoDescription
- payeeTypestringExampleDescriptionDefaultORGNPattern^(ORGN|PERS)$
- payeeLinkedBsbstringExampleDescriptionDefault062000Pattern^[0-9]{3}-?[0-9]{3}$
- payeeLinkedAccountstringExampleDescriptionDefault12345678Min Length1Max Length28Pattern^[0-9A-Za-z -]{1,28}$
- payeeLinkedPayIdstringExampleDescriptionDefaultPattern^[ -~]{1,256}$
- payeeLinkedPayIdTypestringExampleDescriptionDefaultEmailPattern^(PhoneNumber|Email|ABN|ACN|OrganisationId)$
- payeeAccountNamestringExampleDescriptionDefaultABC Corp Pty LtdMin Length1Max Length140Pattern^[ -~]{1,140}$
- ultimatePayeestringExampleDescriptionDefaultABC CorpMin Length1Max Length140Pattern^[ -~]{1,140}$
- payeeMCCCodestringExampleDescriptionDefault5968Pattern^([0-9]{4}|-)$
- ultimatePayeeMCCCodestringExampleDescriptionDefault5968Pattern^([0-9]{4}|-)$
- payerDetailsMandateManager.Application.Common.Dtos.PayerDetailsDtorequiredDescription
- payerTypestringrequiredExampleDescriptionDefaultPERSPattern^(ORGN|PERS)$
- linkedBsbstringExampleDescriptionDefault802950Pattern^[0-9]{3}-?[0-9]{3}$
- linkedAccountstringExampleDescriptionDefault22090100Min Length1Max Length28Pattern^[0-9A-Za-z -]{1,28}$
- linkedPayIdstringExampleDescriptionDefault+61-422020901Pattern^[ -~]{1,256}$
- linkedPayIdTypestringExampleDescriptionDefaultPhoneNumberPattern^(PhoneNumber|Email|ABN|ACN|OrganisationId)$
- payerstringrequiredExampleDescriptionDefaultMonoova Sample 1Min Length1Max Length140Pattern^[ -~]{1,140}$
- ultimatePayerstringrequiredExampleDescriptionDefaultMonoova Sample 1Min Length1Max Length140Pattern^[ -~]{1,140}$
- payerPartyReferencestringrequiredExampleDescriptionDefaultCUST-000123Min Length1Max Length35Pattern^[ -~]{1,35}$
- paymentTermsMandateManager.Application.Common.Dtos.PaymentTermsDtorequiredDescription
- numberOfTransactionsPermittedstringExampleDescriptionDefault1Pattern^([1-9][0-9]*|-)$
- frequencystringExampleDescriptionDefaultMNTHPattern^(ADHO|DAIL|FRTN|INDA|MIAN|MNTH|QURT|WEEK|YEAR)$
- pointInTimestringExampleDescriptionDefault15Max Length2Pattern^(0[1-9]|[12][0-9]|3[01]|-)$
- amountstringExampleDescriptionDefault50.00Pattern^(-|(?=.{1,19}$)(?=.*[0-9])[0-9]{0,18}(\.[0-9]{0,2})?)$
- maximumAmountstringExampleDescriptionDefault100.00Pattern^(-|(?=.{1,19}$)(?=.*[0-9])[0-9]{0,18}(\.[0-9]{0,2})?)$
- agreementTypestringExampleDescriptionDefaultVARIPattern^(BALN|FIXE|USGB|VARI)$
- paymentDetailsMandateManager.Application.Common.Dtos.PaymentDetailsDtorequiredDescription
- automaticRenewalbooleanrequiredDescriptionDefaultfalsePattern^(true|false)$
- descriptionstringExampleDescriptionDefaultMonthly subscription for ABC Corp servicesMin Length1Max Length140Pattern^[ -~]{1,140}$
- shortDescriptionstringExampleDescriptionDefaultABC Corp subscriptionMin Length1Max Length35Pattern^[ -~]{1,35}$
- purposestringExampleDescriptionDefaultRETLPattern^(MORT|UTIL|LOAN|DEPD|GAMP|RETL|SALA|PERS|GOVT|PENS|TAXS|OTHR)$
- respondByTimestringExampleDescriptionDefault2026-12-28T17:00:00+11:00Pattern^\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)?)$
- startDatestringrequiredExampleDescriptionDefault2027-01-01Pattern^\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$
- endDatestringExampleDescriptionDefault2027-12-31Pattern^\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$
Responses
202
- MandateManager.Application.Common.Dtos.AsyncResponseDescription
- traceIdstringExampleDescriptionDefault1dabfaa9-abe8-4d2d-a69a-b723079d84edPattern^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
- uniqueRequestIdstringExampleDescriptionDefault4834dba5-27b0-465c-aea7-aa530315c68cPattern^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
400
- MandateManager.Application.Common.Dtos.ErrorResponseExample
{ "traceId": "4ea61012-2d9b-413d-a5b4-90ad69a68741", "errors": [ { "errorCode": "PAM_STARTDATE_EARLY", "errorMessage": "paymentDetails.startDate must be future date" } ] }Description- traceIdstringExampleDescriptionDefault4ea61012-2d9b-413d-a5b4-90ad69a68741Pattern^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
- errorsMandateManager.Application.Common.Dtos.ErrorDto[]Description
- errorCodestringExampleDescriptionDefaultPAM_STARTDATE_EARLYPattern^[A-Z]{3}_[A-Z0-9_]+$
- errorMessagestringExampleDescriptionDefaultpaymentDetails.startDate must be future datePattern^.+$
401
403
- MandateManager.Application.Common.Dtos.ErrorResponseExample
{ "traceId": "4ea61012-2d9b-413d-a5b4-90ad69a68741", "errors": [ { "errorCode": "PAM_FORBIDDEN_ERROR", "errorMessage": "Not allowed to create payment agreement for account 6279059778044302" } ] }Description- traceIdstringExampleDescriptionDefault4ea61012-2d9b-413d-a5b4-90ad69a68741Pattern^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
- errorsMandateManager.Application.Common.Dtos.ErrorDto[]Description
- errorCodestringExampleDescriptionDefaultPAM_STARTDATE_EARLYPattern^[A-Z]{3}_[A-Z0-9_]+$
- errorMessagestringExampleDescriptionDefaultpaymentDetails.startDate must be future datePattern^.+$
404
- MandateManager.Application.Common.Dtos.ErrorResponseExample
{ "traceId": "4ea61012-2d9b-413d-a5b4-90ad69a68741", "errors": [ { "errorCode": "PAM_ACCT_NOT_FOUND_ERROR", "errorMessage": "Account not found for AccountId 6279059778044302" } ] }Description- traceIdstringExampleDescriptionDefault4ea61012-2d9b-413d-a5b4-90ad69a68741Pattern^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
- errorsMandateManager.Application.Common.Dtos.ErrorDto[]Description
- errorCodestringExampleDescriptionDefaultPAM_STARTDATE_EARLYPattern^[A-Z]{3}_[A-Z0-9_]+$
- errorMessagestringExampleDescriptionDefaultpaymentDetails.startDate must be future datePattern^.+$
500
- MandateManager.Application.Common.Dtos.ErrorResponseExample
{ "traceId": "4ea61012-2d9b-413d-a5b4-90ad69a68741", "errors": [ { "errorCode": "PAM_UNEXPECTED_ERROR", "errorMessage": "Internal server error. Please contact Monoova support." } ] }Description- traceIdstringExampleDescriptionDefault4ea61012-2d9b-413d-a5b4-90ad69a68741Pattern^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
- errorsMandateManager.Application.Common.Dtos.ErrorDto[]Description
- errorCodestringExampleDescriptionDefaultPAM_STARTDATE_EARLYPattern^[A-Z]{3}_[A-Z0-9_]+$
- errorMessagestringExampleDescriptionDefaultpaymentDetails.startDate must be future datePattern^.+$
502
- MandateManager.Application.Common.Dtos.ErrorResponseExample
{ "traceId": "4ea61012-2d9b-413d-a5b4-90ad69a68741", "errors": [ { "errorCode": "PAM_NPP_GATEWAY_ERROR", "errorMessage": "Error returned from NPP gateway - service unavailable" } ] }Description- traceIdstringExampleDescriptionDefault4ea61012-2d9b-413d-a5b4-90ad69a68741Pattern^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
- errorsMandateManager.Application.Common.Dtos.ErrorDto[]Description
- errorCodestringExampleDescriptionDefaultPAM_STARTDATE_EARLYPattern^[A-Z]{3}_[A-Z0-9_]+$
- errorMessagestringExampleDescriptionDefaultpaymentDetails.startDate must be future datePattern^.+$
504
- MandateManager.Application.Common.Dtos.ErrorResponseExample
{ "traceId": "4ea61012-2d9b-413d-a5b4-90ad69a68741", "errors": [ { "errorCode": "PAM_NPP_GATEWAY_TIMEOUT", "errorMessage": "Timeout from NPP gateway" } ] }Description- traceIdstringExampleDescriptionDefault4ea61012-2d9b-413d-a5b4-90ad69a68741Pattern^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
- errorsMandateManager.Application.Common.Dtos.ErrorDto[]Description
- errorCodestringExampleDescriptionDefaultPAM_STARTDATE_EARLYPattern^[A-Z]{3}_[A-Z0-9_]+$
- errorMessagestringExampleDescriptionDefaultpaymentDetails.startDate must be future datePattern^.+$
curl
curl --request POST \
--url https://beta-api.monoova.com/au/payto/pam-v1/PaymentAgreementAsync \
--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"
}
}'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var raw = JSON.stringify({
"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"
}
});
var requestOptions = {
method: 'POST',
headers: myHeaders,
body: raw,
redirect: 'follow'
};
fetch("https://beta-api.monoova.com/au/payto/pam-v1/PaymentAgreementAsync", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("https://beta-api.monoova.com/au/payto/pam-v1/PaymentAgreementAsync")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
"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"
}
})
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://beta-api.monoova.com/au/payto/pam-v1/PaymentAgreementAsync"
payload = json.dumps({
"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"
}
})
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
202
// Accepted. The request was validated and accepted for background processing. Use uniqueRequestId to check its status.
{
"traceId": "1dabfaa9-abe8-4d2d-a69a-b723079d84ed",
"uniqueRequestId": "4834dba5-27b0-465c-aea7-aa530315c68c"
}400
// Bad Request. The request failed validation. See errors for details.
{
"traceId": "4ea61012-2d9b-413d-a5b4-90ad69a68741",
"errors": [
{
"errorCode": "PAM_STARTDATE_EARLY",
"errorMessage": "paymentDetails.startDate must be future date"
}
]
}401
// Unauthorized. The bearer token is missing, invalid or expired. Bearer tokens are valid for 24 hours; generate a new token and retry.
403
// Forbidden. Your account is not permitted to perform this operation.
{
"traceId": "4ea61012-2d9b-413d-a5b4-90ad69a68741",
"errors": [
{
"errorCode": "PAM_STARTDATE_EARLY",
"errorMessage": "paymentDetails.startDate must be future date"
}
]
}404
// Not Found. The account could not be found.
{
"traceId": "4ea61012-2d9b-413d-a5b4-90ad69a68741",
"errors": [
{
"errorCode": "PAM_STARTDATE_EARLY",
"errorMessage": "paymentDetails.startDate must be future date"
}
]
}500
// Internal Server Error. An unexpected error occurred. Contact Monoova support if the problem persists.
{
"traceId": "4ea61012-2d9b-413d-a5b4-90ad69a68741",
"errors": [
{
"errorCode": "PAM_STARTDATE_EARLY",
"errorMessage": "paymentDetails.startDate must be future date"
}
]
}502
// Bad Gateway. An upstream service, such as the NPP gateway, returned an error. Retry the request later.
{
"traceId": "4ea61012-2d9b-413d-a5b4-90ad69a68741",
"errors": [
{
"errorCode": "PAM_STARTDATE_EARLY",
"errorMessage": "paymentDetails.startDate must be future date"
}
]
}504
// Gateway Timeout. An upstream service, such as the NPP gateway, did not respond in time. Retry the request later.
{
"traceId": "4ea61012-2d9b-413d-a5b4-90ad69a68741",
"errors": [
{
"errorCode": "PAM_STARTDATE_EARLY",
"errorMessage": "paymentDetails.startDate must be future date"
}
]
}