--- title: Create Payment Agreement Async slug: r10-integration/create-payment-agreement-async createdAt: 2026-10-29T06:44:31.903Z --- { "id": "uBjdjLxISMp26miM2H4ei", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://api-beta.monoova.com/au/payto/pam-v1/PaymentAgreementAsync", "servers": [ { "url": "https://api-beta.monoova.com/au/payto/pam-v1/PaymentAgreementAsync", "description": "Beta Sandbox URL" } ], "name": "Create Payment Agreement Async", "description": "The purpose of this endpoint is to asynchronously create a payment agreement. The API returns as soon as the creation request has been captured and validated for background processing.", "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 agreement to create.", "customType": "MandateManager.Application.Common.Dtos.CreatePaymentAgreementDto", "schema": [ { "name": "paymentAgreementUID", "kind": "required", "type": "string", "description": "

Your unique ID for the payment agreement, from 1 to 35 characters: letters, numbers, hyphens and underscores only.

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

Optional. ID of the sub-merchant related to this payment agreement, from 1 to 35 characters. The subMerchantId must have been assigned by Monoova.

\n

If not provided, defaults to the value configured for your mAccount.

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

Optional. Details of the payee (the party that receives the payments). If they are not provided here, payee details must be provided when payments are initiated.

", "modelRef": "#/components/schemas/MandateManager.Application.Common.Dtos.PayeeDetailsDto", "customType": "MandateManager.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.

\n

When creating a payment agreement, 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", "minLength": 1, "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. Allowed external account names may also be whitelisted in your account configuration.

", "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. Allowed external ultimate payee names may also be whitelisted in your account configuration.

", "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 agreement purpose is OTHR, PERS, UTIL, GAMP or RETL.

\n

When amending, set to - to clear the field.

", "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 agreement purpose is OTHR, PERS, UTIL, GAMP or RETL.

\n

When amending, set to - to clear the field.

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

Details of the payer (the party whose account is debited).

", "modelRef": "#/components/schemas/MandateManager.Application.Common.Dtos.PayerDetailsDto", "customType": "MandateManager.Application.Common.Dtos.PayerDetailsDto", "schema": [ { "name": "payerType", "kind": "required", "type": "string", "description": "

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

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

Conditional. BSB number of the payer's account, with or without a hyphen.

\n

When creating a payment agreement, required if linkedPayId and linkedPayIdType are not provided. Prohibited if linkedPayId is provided.

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

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

\n

Required if linkedPayId and linkedPayIdType are not provided. Prohibited if linkedPayId is provided.

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

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

\n

Required if linkedBsb and linkedAccount are not provided. Prohibited if linkedAccount is provided.

", "example": "+61-422020901", "default": "+61-422020901", "pattern": "^[ -~]{1,256}$" }, { "name": "linkedPayIdType", "kind": "optional", "type": "string", "nullable": true, "description": "

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

\n

Required if linkedBsb and linkedAccount are not provided. Prohibited if linkedAccount is provided.

", "example": "PhoneNumber", "default": "PhoneNumber", "pattern": "^(PhoneNumber|Email|ABN|ACN|OrganisationId)$" }, { "name": "payer", "kind": "required", "type": "string", "description": "

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

", "example": "Monoova Sample 1", "default": "Monoova Sample 1", "minLength": 1, "maxLength": 140, "pattern": "^[ -~]{1,140}$" }, { "name": "ultimatePayer", "kind": "required", "type": "string", "description": "

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

", "example": "Monoova Sample 1", "default": "Monoova Sample 1", "minLength": 1, "maxLength": 140, "pattern": "^[ -~]{1,140}$" }, { "name": "payerPartyReference", "kind": "required", "type": "string", "description": "

Your reference for the payer, from 1 to 35 characters. It is shown to the payer in the agreement details view and can be used to group payment initiations associated with a payment agreement.

\n

Must contain at least one letter or number and must not be all zeros or spaces.

", "example": "CUST-000123", "default": "CUST-000123", "minLength": 1, "maxLength": 35, "pattern": "^[ -~]{1,35}$" } ] }, { "name": "paymentTerms", "kind": "required", "type": "object", "description": "

Payment terms of the agreement, such as frequency, amounts and agreement type.

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

Conditional. Number of transactions allowed per frequency period, as a whole number of 1 or more.

\n

Required when creating a payment agreement, unless frequency is ADHO or pointInTime is provided. Prohibited if pointInTime is provided. When amending, set to - to clear the field.

", "example": "1", "default": "1", "pattern": "^([1-9][0-9]*|-)$" }, { "name": "frequency", "kind": "optional", "type": "string", "nullable": true, "description": "

Conditional. Specifies how often payments can be made. Required when creating a payment agreement.

\n

Accepted values: ADHO (ad hoc), DAIL (daily), FRTN (fortnightly), INDA (intraday), MIAN (semi-annual), MNTH (monthly), QURT (quarterly), WEEK (weekly), YEAR (annual).

", "example": "MNTH", "default": "MNTH", "pattern": "^(ADHO|DAIL|FRTN|INDA|MIAN|MNTH|QURT|WEEK|YEAR)$" }, { "name": "pointInTime", "kind": "optional", "type": "string", "nullable": true, "description": "

Conditional. Exact point in time within the frequency period, as a two-digit value from 01 to 31 (for example, the day of the month).

\n

Can only be provided when frequency is MNTH, and must not be provided with numberOfTransactionsPermitted. When amending, set to - to clear the field.

", "example": "15", "default": "15", "maxLength": 2, "pattern": "^(0[1-9]|[12][0-9]|3[01]|-)$" }, { "name": "amount", "kind": "optional", "type": "string", "nullable": true, "description": "

Conditional. Exact amount that may be paid from the payer's account per instruction, in dollars with up to 2 decimal places. Required when agreementType is FIXE. If maximumAmount is also provided, amount must be less than maximumAmount. When amending, set to - to clear the field.

\n

In Sandbox, the cents value decides the test outcome of a new agreement; for example, amounts ending in .00 are approved. If both amount and maximumAmount are provided, amount decides.

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

Optional. Maximum amount that may be paid from the payer's account per instruction, in dollars with up to 2 decimal places. Recommended when agreementType is USGB or VARI; must not be provided when agreementType is FIXE. When amending, set to - to clear the field.

\n

In Sandbox, the cents value decides the test outcome of a new agreement; for example, amounts ending in .00 are approved. If both amount and maximumAmount are provided, amount decides.

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

Conditional. Identifies the payment arrangement of the agreement. Required when creating a payment agreement.

\n

Accepted values: BALN (balloon), FIXE (fixed), USGB (usage based), VARI (variable). For FIXE, provide amount only.

", "example": "VARI", "default": "VARI", "pattern": "^(BALN|FIXE|USGB|VARI)$" } ] }, { "name": "paymentDetails", "kind": "required", "type": "object", "description": "

Details of the agreement, such as start and end dates, renewal, purpose and description.

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

Determines whether the payment agreement automatically renews at the end of the defined period. Accepted values: true or false.

\n

endDate must not be provided when automaticRenewal is true, and must be provided when automaticRenewal is false.

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

Conditional. Reason for the mandate setup, as narrative text, from 1 to 140 characters.

\n

Either description or shortDescription must be provided.

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

Conditional. Short reason for the mandate setup, as narrative text, from 1 to 35 characters.

\n

Either description or shortDescription must be provided.

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

Optional. Payment purpose code. The default value and the allowed values are configured for each client account.

\n

Accepted values: MORT (mortgage), UTIL (utility), LOAN (loan), DEPD (dependant support), GAMP (gambling), RETL (retail), SALA (salary), PERS (personal), GOVT (government), PENS (pension), TAXS (tax), OTHR (other).

", "example": "RETL", "default": "RETL", "pattern": "^(MORT|UTIL|LOAN|DEPD|GAMP|RETL|SALA|PERS|GOVT|PENS|TAXS|OTHR)$" }, { "name": "respondByTime", "kind": "optional", "type": "string", "nullable": true, "description": "

Optional. Time by which the payer is asked to respond. It is included in any notification sent to the counterparty and is for information only; it does not affect the expiry time imposed by the MMS.

\n

Must be a future date-time less than 5 days away, in ISO 8601 format including a time zone. If not provided, defaults to the agreement creation date-time + 5 days.

", "example": "2026-12-28T17:00:00+11:00", "default": "2026-12-28T17:00:00+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": "startDate", "kind": "required", "type": "string", "nullable": true, "description": "

Start date of the validity of the mandate, in YYYY-MM-DD format. The mandate is valid from 00:00

.000 Sydney time on this date. Must be a future date.

", "example": "2027-01-01", "default": "2027-01-01", "pattern": "^\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$" }, { "name": "endDate", "kind": "optional", "type": "string", "nullable": true, "description": "

Conditional. End date of the validity of the mandate, in YYYY-MM-DD format. If specified, the mandate is valid until 23:59

.999 Sydney time on this date.

\n

Required if automaticRenewal is false; prohibited if automaticRenewal is true. Cannot be earlier than startDate.

", "example": "2027-12-31", "default": "2027-12-31", "pattern": "^\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$" } ] } ], "modelRef": "#/components/schemas/MandateManager.Application.Common.Dtos.CreatePaymentAgreementDto", "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": "202", "description": "

Accepted. The request was validated and accepted for background processing. Use uniqueRequestId to check its status.

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "Confirmation that an asynchronous request was accepted for background processing.", "customType": "MandateManager.Application.Common.Dtos.AsyncResponse", "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": "uniqueRequestId", "kind": "optional", "type": "string", "nullable": true, "description": "

Server-generated unique ID of the async request. Use it with the Get Async Payment Agreement Request Status endpoint to check progress.

", "example": "4834dba5-27b0-465c-aea7-aa530315c68c", "default": "4834dba5-27b0-465c-aea7-aa530315c68c", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } ], "modelRef": "#/components/schemas/MandateManager.Application.Common.Dtos.AsyncResponse", "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\":\"PAM_STARTDATE_EARLY\",\"errorMessage\":\"paymentDetails.startDate must be future date\"}]}", "description": "Error response returned when a request fails.", "customType": "MandateManager.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/MandateManager.Application.Common.Dtos.ErrorDto", "customType": "MandateManager.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": "PAM_STARTDATE_EARLY", "default": "PAM_STARTDATE_EARLY", "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.startDate must be future date", "default": "paymentDetails.startDate must be future date", "pattern": "^.+$" } ] } ], "modelRef": "#/components/schemas/MandateManager.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\":\"PAM_FORBIDDEN_ERROR\",\"errorMessage\":\"Not allowed to create payment agreement for account 6279059778044302\"}]}", "description": "Error response returned when a request fails.", "customType": "MandateManager.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/MandateManager.Application.Common.Dtos.ErrorDto", "customType": "MandateManager.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": "PAM_STARTDATE_EARLY", "default": "PAM_STARTDATE_EARLY", "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.startDate must be future date", "default": "paymentDetails.startDate must be future date", "pattern": "^.+$" } ] } ], "modelRef": "#/components/schemas/MandateManager.Application.Common.Dtos.ErrorResponse", "isExpanded": true } ] }, { "statusCode": "404", "description": "Not Found. The account could not be found.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"traceId\":\"4ea61012-2d9b-413d-a5b4-90ad69a68741\",\"errors\":[{\"errorCode\":\"PAM_ACCT_NOT_FOUND_ERROR\",\"errorMessage\":\"Account not found for AccountId 6279059778044302\"}]}", "description": "Error response returned when a request fails.", "customType": "MandateManager.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/MandateManager.Application.Common.Dtos.ErrorDto", "customType": "MandateManager.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": "PAM_STARTDATE_EARLY", "default": "PAM_STARTDATE_EARLY", "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.startDate must be future date", "default": "paymentDetails.startDate must be future date", "pattern": "^.+$" } ] } ], "modelRef": "#/components/schemas/MandateManager.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\":\"PAM_UNEXPECTED_ERROR\",\"errorMessage\":\"Internal server error. Please contact Monoova support.\"}]}", "description": "Error response returned when a request fails.", "customType": "MandateManager.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/MandateManager.Application.Common.Dtos.ErrorDto", "customType": "MandateManager.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": "PAM_STARTDATE_EARLY", "default": "PAM_STARTDATE_EARLY", "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.startDate must be future date", "default": "paymentDetails.startDate must be future date", "pattern": "^.+$" } ] } ], "modelRef": "#/components/schemas/MandateManager.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\":\"PAM_NPP_GATEWAY_ERROR\",\"errorMessage\":\"Error returned from NPP gateway - service unavailable\"}]}", "description": "Error response returned when a request fails.", "customType": "MandateManager.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/MandateManager.Application.Common.Dtos.ErrorDto", "customType": "MandateManager.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": "PAM_STARTDATE_EARLY", "default": "PAM_STARTDATE_EARLY", "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.startDate must be future date", "default": "paymentDetails.startDate must be future date", "pattern": "^.+$" } ] } ], "modelRef": "#/components/schemas/MandateManager.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\":\"PAM_NPP_GATEWAY_TIMEOUT\",\"errorMessage\":\"Timeout from NPP gateway\"}]}", "description": "Error response returned when a request fails.", "customType": "MandateManager.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/MandateManager.Application.Common.Dtos.ErrorDto", "customType": "MandateManager.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": "PAM_STARTDATE_EARLY", "default": "PAM_STARTDATE_EARLY", "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.startDate must be future date", "default": "paymentDetails.startDate must be future date", "pattern": "^.+$" } ] } ], "modelRef": "#/components/schemas/MandateManager.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/pam-v1/PaymentAgreementAsync \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data-raw '{\n \"paymentAgreementUID\": \"MONPAG12345\",\n \"subMerchantId\": \"93bf57eb1e2c42cf8101509b4356741e\",\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 \"payerDetails\": {\n \"payerType\": \"PERS\",\n \"linkedBsb\": \"802950\",\n \"linkedAccount\": \"22090100\",\n \"linkedPayId\": \"+61-422020901\",\n \"linkedPayIdType\": \"PhoneNumber\",\n \"payer\": \"Monoova Sample 1\",\n \"ultimatePayer\": \"Monoova Sample 1\",\n \"payerPartyReference\": \"CUST-000123\"\n },\n \"paymentTerms\": {\n \"numberOfTransactionsPermitted\": \"1\",\n \"frequency\": \"MNTH\",\n \"pointInTime\": \"15\",\n \"amount\": \"50.00\",\n \"maximumAmount\": \"100.00\",\n \"agreementType\": \"VARI\"\n },\n \"paymentDetails\": {\n \"automaticRenewal\": \"false\",\n \"description\": \"Monthly subscription for ABC Corp services\",\n \"shortDescription\": \"ABC Corp subscription\",\n \"purpose\": \"RETL\",\n \"respondByTime\": \"2026-12-28T17:00:00+11:00\",\n \"startDate\": \"2027-01-01\",\n \"endDate\": \"2027-12-31\"\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 \"subMerchantId\": \"93bf57eb1e2c42cf8101509b4356741e\",\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 \"payerDetails\": {\n \"payerType\": \"PERS\",\n \"linkedBsb\": \"802950\",\n \"linkedAccount\": \"22090100\",\n \"linkedPayId\": \"+61-422020901\",\n \"linkedPayIdType\": \"PhoneNumber\",\n \"payer\": \"Monoova Sample 1\",\n \"ultimatePayer\": \"Monoova Sample 1\",\n \"payerPartyReference\": \"CUST-000123\"\n },\n \"paymentTerms\": {\n \"numberOfTransactionsPermitted\": \"1\",\n \"frequency\": \"MNTH\",\n \"pointInTime\": \"15\",\n \"amount\": \"50.00\",\n \"maximumAmount\": \"100.00\",\n \"agreementType\": \"VARI\"\n },\n \"paymentDetails\": {\n \"automaticRenewal\": \"false\",\n \"description\": \"Monthly subscription for ABC Corp services\",\n \"shortDescription\": \"ABC Corp subscription\",\n \"purpose\": \"RETL\",\n \"respondByTime\": \"2026-12-28T17:00:00+11:00\",\n \"startDate\": \"2027-01-01\",\n \"endDate\": \"2027-12-31\"\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/pam-v1/PaymentAgreementAsync\", 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/pam-v1/PaymentAgreementAsync\")\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 \"subMerchantId\": \"93bf57eb1e2c42cf8101509b4356741e\",\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 \"payerDetails\": {\n \"payerType\": \"PERS\",\n \"linkedBsb\": \"802950\",\n \"linkedAccount\": \"22090100\",\n \"linkedPayId\": \"+61-422020901\",\n \"linkedPayIdType\": \"PhoneNumber\",\n \"payer\": \"Monoova Sample 1\",\n \"ultimatePayer\": \"Monoova Sample 1\",\n \"payerPartyReference\": \"CUST-000123\"\n },\n \"paymentTerms\": {\n \"numberOfTransactionsPermitted\": \"1\",\n \"frequency\": \"MNTH\",\n \"pointInTime\": \"15\",\n \"amount\": \"50.00\",\n \"maximumAmount\": \"100.00\",\n \"agreementType\": \"VARI\"\n },\n \"paymentDetails\": {\n \"automaticRenewal\": \"false\",\n \"description\": \"Monthly subscription for ABC Corp services\",\n \"shortDescription\": \"ABC Corp subscription\",\n \"purpose\": \"RETL\",\n \"respondByTime\": \"2026-12-28T17:00:00+11:00\",\n \"startDate\": \"2027-01-01\",\n \"endDate\": \"2027-12-31\"\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/pam-v1/PaymentAgreementAsync\"\n\npayload = json.dumps({\n \"paymentAgreementUID\": \"MONPAG12345\",\n \"subMerchantId\": \"93bf57eb1e2c42cf8101509b4356741e\",\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 \"payerDetails\": {\n \"payerType\": \"PERS\",\n \"linkedBsb\": \"802950\",\n \"linkedAccount\": \"22090100\",\n \"linkedPayId\": \"+61-422020901\",\n \"linkedPayIdType\": \"PhoneNumber\",\n \"payer\": \"Monoova Sample 1\",\n \"ultimatePayer\": \"Monoova Sample 1\",\n \"payerPartyReference\": \"CUST-000123\"\n },\n \"paymentTerms\": {\n \"numberOfTransactionsPermitted\": \"1\",\n \"frequency\": \"MNTH\",\n \"pointInTime\": \"15\",\n \"amount\": \"50.00\",\n \"maximumAmount\": \"100.00\",\n \"agreementType\": \"VARI\"\n },\n \"paymentDetails\": {\n \"automaticRenewal\": \"false\",\n \"description\": \"Monthly subscription for ABC Corp services\",\n \"shortDescription\": \"ABC Corp subscription\",\n \"purpose\": \"RETL\",\n \"respondByTime\": \"2026-12-28T17:00:00+11:00\",\n \"startDate\": \"2027-01-01\",\n \"endDate\": \"2027-12-31\"\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-202", "language": "202", "code": "// Accepted. The request was validated and accepted for background processing. Use uniqueRequestId to check its status.\n{\n \"traceId\": \"1dabfaa9-abe8-4d2d-a69a-b723079d84ed\",\n \"uniqueRequestId\": \"4834dba5-27b0-465c-aea7-aa530315c68c\"\n}" }, { "id": "response-1-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\": \"PAM_STARTDATE_EARLY\",\n \"errorMessage\": \"paymentDetails.startDate must be future date\"\n }\n ]\n}" }, { "id": "response-2-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-3-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\": \"PAM_STARTDATE_EARLY\",\n \"errorMessage\": \"paymentDetails.startDate must be future date\"\n }\n ]\n}" }, { "id": "response-4-404", "language": "404", "code": "// Not Found. The account could not be found.\n{\n \"traceId\": \"4ea61012-2d9b-413d-a5b4-90ad69a68741\",\n \"errors\": [\n {\n \"errorCode\": \"PAM_STARTDATE_EARLY\",\n \"errorMessage\": \"paymentDetails.startDate must be future date\"\n }\n ]\n}" }, { "id": "response-5-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\": \"PAM_STARTDATE_EARLY\",\n \"errorMessage\": \"paymentDetails.startDate must be future date\"\n }\n ]\n}" }, { "id": "response-6-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\": \"PAM_STARTDATE_EARLY\",\n \"errorMessage\": \"paymentDetails.startDate must be future date\"\n }\n ]\n}" }, { "id": "response-7-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\": \"PAM_STARTDATE_EARLY\",\n \"errorMessage\": \"paymentDetails.startDate must be future date\"\n }\n ]\n}" } ], "selectedLanguageId": "response-0-202" } }, "children": [ { "text": "" } ] }