Get Payment Agreement by Id
GET
https://sand-api.monoova.com/au/payto/pam-v1/PaymentAgreement/{paymentAgreementUID}
Path Parameters
- paymentAgreementUIDstringrequiredExampleDescriptionDefaultMONPAG12345Pattern^[a-zA-Z0-9_-]{1,35}$
Responses
200
- MandateManager.Application.Common.Dtos.GetPaymentAgreementByIdResponseDescription
- 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}$
- paymentAgreementDetailsMandateManager.Application.Common.Dtos.PaymentAgreementDtoDescription
- createdDateTimestringExampleDescriptionDefault2026-10-16T04:25:46.183ZPattern^\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)?)?$
- lastModifiedDateTimestringExampleDescriptionDefault2026-11-02T01:14:09.457ZPattern^\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)?)?$
- paymentAgreementUIDstringExampleDescriptionDefaultMONPAG12345Pattern^[a-zA-Z0-9_-]{1,35}$
- mmsIdstringExampleDescriptionDefaulta9ba56f64baa1dee9ac2d7f87c2621faPattern^[a-f0-9]{32}$
- registrationDateTimestringExampleDescriptionDefault2026-10-16T04:25:47.031ZPattern^\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)?)?$
- paymentAgreementStatusstringExampleDescriptionDefaultActivePattern^(InProgress|Created|Active|Paused|Cancelled|Rejected|Expired)$
- statusReasonCodestringExampleDescriptionDefaultM011Pattern^[A-Z0-9]{4}$
- statusReasonDescriptionstringExampleDescriptionDefaultContract AmendedPattern^.+$
- 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}$
- payerDetailsMandateManager.Application.Common.Dtos.PayerDetailsDtoDescription
- 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.PaymentTermsDtoDescription
- 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]{1,18}(\.[0-9]{1,2})?)$
- maximumAmountstringExampleDescriptionDefault100.00Pattern^(-|(?=.{1,19}$)[0-9]{1,18}(\.[0-9]{1,2})?)$
- agreementTypestringExampleDescriptionDefaultVARIPattern^(BALN|FIXE|USGB|VARI)$
- paymentDetailsMandateManager.Application.Common.Dtos.PaymentDetailsDtoDescription
- automaticRenewalstringrequiredExampleDescriptionDefaultfalsePattern^(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])$
- pendingActionsMandateManager.Application.Common.Dtos.PaymentAgreementActionSummary[]Description
- actionIdstringExampleDescriptionDefaulteea687ee114eae368ca066aa62bae488Pattern^[a-f0-9]{32}$
- actionTypestringExampleDescriptionDefaultAmendPattern^[A-Za-z]+$
- bilateralstringExampleDescriptionDefaulttruePattern^(true|false)$
- statusstringExampleDescriptionDefaultPendingApprovalPattern^[A-Za-z]+$
- scheduleDetailsMandateManager.Application.PaymentSchedules.Dto.PaymentScheduleDtoOutDescription
- createdDateTimestringExampleDescriptionDefault2026-10-16T04:40:12.512ZPattern^\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)?)?$
- lastModifiedDateTimestringExampleDescriptionDefault2027-01-14T22:00:03.118ZPattern^\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)?)?$
- scheduleIdstringExampleDescriptionDefaultMONSCH12345Pattern^[a-zA-Z0-9_-]{1,36}$
- entityIdstringExampleDescriptionDefaultMONPAG12345Pattern^[a-zA-Z0-9_-]{1,35}$
- entityTypestringExampleDescriptionDefaultPaymentAgreementPattern^(PaymentAgreement)$
- startDatestringExampleDescriptionDefault2027-01-15Pattern^\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$
- endDatestringExampleDescriptionDefault2027-12-15Pattern^\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$
- executionTimestringExampleDescriptionDefault09:00:00Pattern^([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]$
- frequencystringExampleDescriptionDefaultMNTHPattern^(ADHO|DAIL|FRTN|INDA|MIAN|MNTH|QURT|WEEK|YEAR)$
- scheduledAmountnumber<double>ExampleDescriptionDefault50FormatdoublePattern^[0-9]{1,16}(\.[0-9]{1,2})?$
- totalInstancesinteger<int32>ExampleDescriptionDefault12Formatint32Pattern^[1-9][0-9]*$
- totalAmountnumber<double>ExampleDescriptionDefault600FormatdoublePattern^[0-9]{1,16}(\.[0-9]{1,2})?$
- lastExecutionDateTimestringExampleDescriptionDefault2027-01-14T22:00:00ZPattern^\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)?)?$
- nextExecutionDateTimestringExampleDescriptionDefault2027-02-14T22:00:00ZPattern^\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)?)?$
- statusstringExampleDescriptionDefaultActivePattern^(Pending|Active|Paused|Cancelled)$
- statusDescriptionstringExampleDescriptionDefaultActivePattern^.+$
- statusReasonCodestringExampleDescriptionDefaultCustReqPattern^(CustReq|CreateError|Expired|AgreementStatusChanged|InvalidPayeeDetails|BilateralAmendmentInitiated|MaxedOutTotalInstanceLimit|MaxedOutTotalAmountLimit|ExceededScheduleEndDate|FinalPaymentInitiated|SchedulingDisabled)$
- statusReasonDescriptionstringExampleDescriptionDefaultRequested by customerPattern^.+$
- paymentReferencestringExampleDescriptionDefaultABC Corp monthly subscriptionPattern^[ -~]{1,280}$
400
- MandateManager.Application.Common.Dtos.ErrorResponseExample
{ "traceId": "4ea61012-2d9b-413d-a5b4-90ad69a68741", "errors": [ { "errorCode": "PAM_PAGID_INVALID", "errorMessage": "paymentAgreementUID MONPAG#12345 must match ^[a-zA-Z0-9_-]{1,35}$" } ] }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 get 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_PAG_NOT_FOUND_ERROR", "errorMessage": "PaymentAgreement not found for PaymentAgreementUID MONPAG12345" } ] }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 GET \
--url https://sand-api.monoova.com/au/payto/pam-v1/PaymentAgreement/{paymentAgreementUID} \
--header 'accept: application/json'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var requestOptions = {
method: 'GET',
headers: myHeaders,
redirect: 'follow'
};
fetch("https://sand-api.monoova.com/au/payto/pam-v1/PaymentAgreement/{paymentAgreementUID}", 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://sand-api.monoova.com/au/payto/pam-v1/PaymentAgreement/{paymentAgreementUID}")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://sand-api.monoova.com/au/payto/pam-v1/PaymentAgreement/{paymentAgreementUID}"
payload = {}
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
200
// OK. Returns the payment agreement.
{
"traceId": "1dabfaa9-abe8-4d2d-a69a-b723079d84ed",
"paymentAgreementDetails": {
"createdDateTime": "2026-10-16T04:25:46.183Z",
"lastModifiedDateTime": "2026-11-02T01:14:09.457Z",
"paymentAgreementUID": "MONPAG12345",
"mmsId": "a9ba56f64baa1dee9ac2d7f87c2621fa",
"registrationDateTime": "2026-10-16T04:25:47.031Z",
"paymentAgreementStatus": "Active",
"statusReasonCode": "M011",
"statusReasonDescription": "Contract Amended",
"payeeDetails": {
"payeeType": "ORGN",
"payeeLinkedBsb": "062000",
"payeeLinkedAccount": "12345678",
"payeeLinkedPayId": "[email protected]",
"payeeLinkedPayIdType": "Email",
"payeeAccountName": "ABC Corp Pty Ltd",
"ultimatePayee": "ABC Corp"
},
"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"
},
"pendingActions": [
{
"actionId": "eea687ee114eae368ca066aa62bae488",
"actionType": "Amend",
"bilateral": "true",
"status": "PendingApproval"
}
],
"scheduleDetails": {
"createdDateTime": "2026-10-16T04:40:12.512Z",
"lastModifiedDateTime": "2027-01-14T22:00:03.118Z",
"scheduleId": "MONSCH12345",
"entityId": "MONPAG12345",
"entityType": "PaymentAgreement",
"startDate": "2027-01-15",
"endDate": "2027-12-15",
"executionTime": "09:00:00",
"frequency": "MNTH",
"scheduledAmount": 50,
"totalInstances": 12,
"totalAmount": 600,
"lastExecutionDateTime": "2027-01-14T22:00:00Z",
"nextExecutionDateTime": "2027-02-14T22:00:00Z",
"status": "Active",
"statusDescription": "Active",
"statusReasonCode": "CustReq",
"statusReasonDescription": "Requested by customer",
"paymentReference": "ABC Corp monthly subscription"
}
}
}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 payment agreement 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"
}
]
}