Creates a Confirmation of Payee account validation.
\nSubmit the BSB, account number and the account name you hold for the payee. The service compares the supplied name against the name registered with the recipient's financial institution and returns a match result, a customer-facing message and an icon code you can surface in your own UI.
\nKeep the accountValidationUniqueId you send — it is the key used to retrieve this validation later through Get Account Validation by Id.
Required — Your own identifier for this Confirmation of Payee validation, unique across your account. It is echoed back in the response and is the value used to retrieve the validation through Get Account Validation by Id. Up to 40 characters: letters, digits, hyphen and underscore.
", "example": "AV-2026-0923-000185", "default": "AV-2026-0923-000185", "maxLength": 40, "pattern": "^[a-zA-Z0-9_-]{1,40}$" }, { "name": "subMerchantId", "kind": "optional", "type": "string", "nullable": true, "description": "Conditional — Monoova submerchant Id the validation is recorded against — supply it in Production when your account is configured with submerchants, as it is the value the filter search and reporting group by. Not required in Sandbox. Up to 36 characters: letters, digits, hyphen and underscore.
", "example": "SUBM-0001234", "default": "SUBM-0001234", "maxLength": 36, "pattern": "^[a-zA-Z0-9_-]{1,36}$" }, { "name": "bsb", "kind": "required", "type": "string", "description": "Required — BSB of the account being validated, written as six digits with a hyphen after the third (NNN-NNN). Send it exactly in that format — an unhyphenated BSB is rejected with PAY_BSB_INVALID.
Required — Account number for the COP validation, as held for the payee and paired with the BSB above. Up to 28 characters: letters, digits, hyphen and underscore. Keep any leading zeros — send it as text, not as a number.
", "example": "123456789", "default": "123456789", "maxLength": 28, "pattern": "^[a-zA-Z0-9_-]{1,28}$" }, { "name": "accountName", "kind": "required", "type": "string", "description": "Required — Account name for the COP validation — the payee name you hold, which is compared against the name registered with the recipient's financial institution. 2 to 140 printable characters, and it cannot begin or end with a space.
", "example": "Monoova Payments Pty Ltd", "default": "Monoova Payments Pty Ltd", "minLength": 2, "maxLength": 140, "pattern": "^[!-~][ -~]{0,138}[!-~]$" }, { "name": "requestPurposeCode", "kind": "required", "type": "string", "description": "Required — Purpose of the COP validation, as a four-letter code. Accepted values are PAYE, VADR, PYMT, MAND, PIRQ and INVN. Use VADR for the Verify Address Book feature. Omitting the field returns PAY_PURPOSE_CODE_REQUIRED; a value outside the accepted list returns PAY_PURPOSE_CODE_INVALID.
Bearer token authentication for API endpoints. Send the token in the Authorization header as Bearer <token>. To generate the token: https://developer.monoova.com/api/generate-a-bearer-token
200 OK. The validation was processed. Read resultData.resultCode for the machine outcome and resultData.cxResultMessage for the wording to show the payer. A 200 confirms the request was accepted and answered — it does not by itself mean the name matched.
Optional — Unique id for logging, generated per request. Store it against your own record and quote it when raising a support ticket — it is how Monoova locates this exact call.
", "example": "0HN7GQ2L4K9AB-00000001", "default": "0HN7GQ2L4K9AB-00000001", "maxLength": 100, "pattern": "^[a-zA-Z0-9_.:-]{1,100}$" }, { "name": "resultData", "kind": "optional", "type": "object", "description": "Optional — The validation outcome. Present on a successful call; absent or null when the request could not be processed, in which case read the errors array of the error response instead.
Optional — The CX icon result of the name validation matching process, for display alongside cxResultMessage in your own UI. One of TICK, EXCM, CROS or DASH.
Optional — Message for the result, already worded for the payer. Show it as supplied rather than composing your own text from resultCode.
Optional — Display account name for the result — the name safe to show the payer, which may differ from the accountName that was submitted. Returned only where the recipient's institution permits the registered name to be displayed.
Optional — The result code of the name validation matching process — the value to branch your own logic on. One of MTCH (match), CMTC (close match), NMTC (no match), NFND (account not found) or CLSD (account closed).
Optional — Account Validation Unique Id supplied in the request, echoed back so the result can be matched to your own record.
", "example": "AV-2026-0923-000185", "default": "AV-2026-0923-000185", "maxLength": 40, "pattern": "^[a-zA-Z0-9_-]{1,40}$" }, { "name": "subMerchantId", "kind": "optional", "type": "string", "nullable": true, "description": "Optional — Sub Merchant Id for the result. Returned when a submerchant was supplied on the create request, or when the validation was recorded against one.
", "example": "SUBM-0001234", "default": "SUBM-0001234", "maxLength": 36, "pattern": "^[a-zA-Z0-9_-]{1,36}$" } ] } ], "modelRef": "#/components/schemas/AccountValidationResponse", "isExpanded": true } ] }, { "statusCode": "400", "description": "400 Bad Request. The request failed validation before it reached the name-matching service. The errors array names each failing field through errorCode, with a human-readable errorMessage. Correct the values and resend — retrying the identical request returns the same 400.
The body returned with a 400, 401 or 500 response.
", "customType": "ErrorResponse", "schema": [ { "name": "traceId", "kind": "optional", "type": "string", "nullable": true, "description": "Optional — Unique id for logging, generated per request. Always log it on a failure — it is the fastest way for Monoova support to find the failing call.
", "example": "0HN7GQ2L4K9AB-00000003", "default": "0HN7GQ2L4K9AB-00000003", "maxLength": 100, "pattern": "^[a-zA-Z0-9_.:-]{1,100}$" }, { "name": "errors", "kind": "optional", "type": "array", "nullable": true, "description": "Optional — One entry per problem found with the request. A single call can fail several validations at once, so handle the array rather than only its first entry.
", "modelRef": "#/components/schemas/ErrorDetail", "customType": "ErrorDetail[]", "schema": [ { "name": "errorCode", "kind": "optional", "type": "string", "nullable": true, "description": "Optional — Monoova error code — a stable, uppercase, PAY_-prefixed token to branch your error handling on. Do not parse errorMessage instead; its wording can change.
Request and format errors: PAY_REQ_BODY_INVALID, PAY_REQUEST_EMPTY, PAY_VERSION_INVALID, PAY_VERSION_UNSUPPORTED, PAY_VALIDATION_ERROR, PAY_INPUT_INJECTION_DETECTED.
Field errors: PAY_BSB_REQUIRED, PAY_BSB_INVALID, PAY_ACCOUNT_NUMBER_REQUIRED, PAY_ACCOUNT_NUMBER_INVALID, PAY_ACCOUNT_NAME_REQUIRED, PAY_ACCOUNT_NAME_INVALID, PAY_BSB_AND_ACCOUNT_REQUIRED, PAY_ACCOUNT_VALIDATION_UNIQUE_ID_REQUIRED, PAY_ACCOUNT_VALIDATION_UNIQUE_ID_INVALID, PAY_ACCOUNT_VALIDATION_UNIQUE_ID_IN_USE, PAY_ACCOUNT_LOOKUP_ID_INVALID, PAY_SUBMERCHANT_ID_INVALID, PAY_ACCTID_REQUIRED, PAY_ACCTID_INVALID, PAY_PURPOSE_CODE_REQUIRED, PAY_PURPOSE_CODE_INVALID, PAY_ALIAS_TYPE_REQUIRED, PAY_ALIAS_TYPE_INVALID, PAY_ALIAS_VALUE_REQUIRED, PAY_ALIAS_VALUE_INVALID, PAY_PAYID_TYPE_REQUIRED, PAY_PAYID_TYPE_INVALID, PAY_PAYID_VALUE_REQUIRED, PAY_PAYID_VALUE_INVALID, PAY_PAYID_NOT_FOUND.
Filter and paging errors: PAY_CRTD_STARTDATE_INVALID, PAY_CRTD_ENDDATE_INVALID, PAY_MDFD_STARTDATE_INVALID, PAY_MDFD_ENDDATE_INVALID, PAY_PG_SZ_INVALID, PAY_PG_NUM_INVALID, PAY_ORDER_BY_INVALID.
Configuration and limit errors: PAY_ACCOUNT_VALIDATION_NOT_ENABLED, PAY_ACCOUNT_VALIDATION_NOT_CONFIGURED, PAY_ACCOUNT_VALIDATION_SUBMERCHANT_NOT_ASSOCIATED, PAY_ACCOUNT_VALIDATION_NOT_FOUND_ERROR, PAY_ACCOUNT_VALIDATION_NOT_SUCCESSFUL_ERROR, PAY_ACCOUNT_VALIDATION_TOO_MANY_REQUESTS, PAY_ACCOUNT_VALIDATION_TOO_MANY_REQUESTS_FOR_PAYEE, PAY_ACCOUNT_VALIDATION_NO_MATCH_THRESHOLD_EXCEEDED, PAY_ENUM_DAILY_LIMIT_PURPOSE_CODE_INVALID, PAY_ENUM_DAILY_LIMIT_PER_PAYEE_INVALID, PAY_ENUM_NO_MATCH_THRESHOLD_INVALID, PAY_ENUM_CHECK_NO_MATCH_THRESHOLD_AFTER_INVALID, PAY_BACKFILL_MAX_RECORD_COUNT_EXCEEDED.
System errors: PAY_NPP_GATEWAY_ERROR, PAY_NPP_GATEWAY_TIMEOUT, PAY_CPL_GATEWAY_TIMEOUT, PAY_OBJ_CREATE_ERROR, PAY_UNEXPECTED_ERROR.
Optional — More detailed description of the specific error which may include information from the specific request. Intended for logs and developer troubleshooting — show cxResultMessage to end users, not this text.
401 Unauthorized. The bearer token is missing, malformed, or has expired. Generate a new token from the Monoova developer portal and send it in the Authorization header as Bearer <token>. Do not retry with the same token.
The body returned with a 400, 401 or 500 response.
", "customType": "ErrorResponse", "schema": [ { "name": "traceId", "kind": "optional", "type": "string", "nullable": true, "description": "Optional — Unique id for logging, generated per request. Always log it on a failure — it is the fastest way for Monoova support to find the failing call.
", "example": "0HN7GQ2L4K9AB-00000003", "default": "0HN7GQ2L4K9AB-00000003", "maxLength": 100, "pattern": "^[a-zA-Z0-9_.:-]{1,100}$" }, { "name": "errors", "kind": "optional", "type": "array", "nullable": true, "description": "Optional — One entry per problem found with the request. A single call can fail several validations at once, so handle the array rather than only its first entry.
", "modelRef": "#/components/schemas/ErrorDetail", "customType": "ErrorDetail[]", "schema": [ { "name": "errorCode", "kind": "optional", "type": "string", "nullable": true, "description": "Optional — Monoova error code — a stable, uppercase, PAY_-prefixed token to branch your error handling on. Do not parse errorMessage instead; its wording can change.
Request and format errors: PAY_REQ_BODY_INVALID, PAY_REQUEST_EMPTY, PAY_VERSION_INVALID, PAY_VERSION_UNSUPPORTED, PAY_VALIDATION_ERROR, PAY_INPUT_INJECTION_DETECTED.
Field errors: PAY_BSB_REQUIRED, PAY_BSB_INVALID, PAY_ACCOUNT_NUMBER_REQUIRED, PAY_ACCOUNT_NUMBER_INVALID, PAY_ACCOUNT_NAME_REQUIRED, PAY_ACCOUNT_NAME_INVALID, PAY_BSB_AND_ACCOUNT_REQUIRED, PAY_ACCOUNT_VALIDATION_UNIQUE_ID_REQUIRED, PAY_ACCOUNT_VALIDATION_UNIQUE_ID_INVALID, PAY_ACCOUNT_VALIDATION_UNIQUE_ID_IN_USE, PAY_ACCOUNT_LOOKUP_ID_INVALID, PAY_SUBMERCHANT_ID_INVALID, PAY_ACCTID_REQUIRED, PAY_ACCTID_INVALID, PAY_PURPOSE_CODE_REQUIRED, PAY_PURPOSE_CODE_INVALID, PAY_ALIAS_TYPE_REQUIRED, PAY_ALIAS_TYPE_INVALID, PAY_ALIAS_VALUE_REQUIRED, PAY_ALIAS_VALUE_INVALID, PAY_PAYID_TYPE_REQUIRED, PAY_PAYID_TYPE_INVALID, PAY_PAYID_VALUE_REQUIRED, PAY_PAYID_VALUE_INVALID, PAY_PAYID_NOT_FOUND.
Filter and paging errors: PAY_CRTD_STARTDATE_INVALID, PAY_CRTD_ENDDATE_INVALID, PAY_MDFD_STARTDATE_INVALID, PAY_MDFD_ENDDATE_INVALID, PAY_PG_SZ_INVALID, PAY_PG_NUM_INVALID, PAY_ORDER_BY_INVALID.
Configuration and limit errors: PAY_ACCOUNT_VALIDATION_NOT_ENABLED, PAY_ACCOUNT_VALIDATION_NOT_CONFIGURED, PAY_ACCOUNT_VALIDATION_SUBMERCHANT_NOT_ASSOCIATED, PAY_ACCOUNT_VALIDATION_NOT_FOUND_ERROR, PAY_ACCOUNT_VALIDATION_NOT_SUCCESSFUL_ERROR, PAY_ACCOUNT_VALIDATION_TOO_MANY_REQUESTS, PAY_ACCOUNT_VALIDATION_TOO_MANY_REQUESTS_FOR_PAYEE, PAY_ACCOUNT_VALIDATION_NO_MATCH_THRESHOLD_EXCEEDED, PAY_ENUM_DAILY_LIMIT_PURPOSE_CODE_INVALID, PAY_ENUM_DAILY_LIMIT_PER_PAYEE_INVALID, PAY_ENUM_NO_MATCH_THRESHOLD_INVALID, PAY_ENUM_CHECK_NO_MATCH_THRESHOLD_AFTER_INVALID, PAY_BACKFILL_MAX_RECORD_COUNT_EXCEEDED.
System errors: PAY_NPP_GATEWAY_ERROR, PAY_NPP_GATEWAY_TIMEOUT, PAY_CPL_GATEWAY_TIMEOUT, PAY_OBJ_CREATE_ERROR, PAY_UNEXPECTED_ERROR.
Optional — More detailed description of the specific error which may include information from the specific request. Intended for logs and developer troubleshooting — show cxResultMessage to end users, not this text.
403 Forbidden. The token was accepted, but the account behind it is not permitted to perform this call — Confirmation of Payee is not enabled on the account, is not yet configured, or the subMerchantId supplied is not associated with it. This is an entitlement problem, not a data problem: the same request will keep returning 403 until Monoova updates the account configuration. Do not retry automatically.
The body returned with a 400, 401 or 500 response.
", "customType": "ErrorResponse", "schema": [ { "name": "traceId", "kind": "optional", "type": "string", "nullable": true, "description": "Optional — Unique id for logging, generated per request. Always log it on a failure — it is the fastest way for Monoova support to find the failing call.
", "example": "0HN7GQ2L4K9AB-00000003", "default": "0HN7GQ2L4K9AB-00000003", "maxLength": 100, "pattern": "^[a-zA-Z0-9_.:-]{1,100}$" }, { "name": "errors", "kind": "optional", "type": "array", "nullable": true, "description": "Optional — One entry per problem found with the request. A single call can fail several validations at once, so handle the array rather than only its first entry.
", "modelRef": "#/components/schemas/ErrorDetail", "customType": "ErrorDetail[]", "schema": [ { "name": "errorCode", "kind": "optional", "type": "string", "nullable": true, "description": "Optional — Monoova error code — a stable, uppercase, PAY_-prefixed token to branch your error handling on. Do not parse errorMessage instead; its wording can change.
Request and format errors: PAY_REQ_BODY_INVALID, PAY_REQUEST_EMPTY, PAY_VERSION_INVALID, PAY_VERSION_UNSUPPORTED, PAY_VALIDATION_ERROR, PAY_INPUT_INJECTION_DETECTED.
Field errors: PAY_BSB_REQUIRED, PAY_BSB_INVALID, PAY_ACCOUNT_NUMBER_REQUIRED, PAY_ACCOUNT_NUMBER_INVALID, PAY_ACCOUNT_NAME_REQUIRED, PAY_ACCOUNT_NAME_INVALID, PAY_BSB_AND_ACCOUNT_REQUIRED, PAY_ACCOUNT_VALIDATION_UNIQUE_ID_REQUIRED, PAY_ACCOUNT_VALIDATION_UNIQUE_ID_INVALID, PAY_ACCOUNT_VALIDATION_UNIQUE_ID_IN_USE, PAY_ACCOUNT_LOOKUP_ID_INVALID, PAY_SUBMERCHANT_ID_INVALID, PAY_ACCTID_REQUIRED, PAY_ACCTID_INVALID, PAY_PURPOSE_CODE_REQUIRED, PAY_PURPOSE_CODE_INVALID, PAY_ALIAS_TYPE_REQUIRED, PAY_ALIAS_TYPE_INVALID, PAY_ALIAS_VALUE_REQUIRED, PAY_ALIAS_VALUE_INVALID, PAY_PAYID_TYPE_REQUIRED, PAY_PAYID_TYPE_INVALID, PAY_PAYID_VALUE_REQUIRED, PAY_PAYID_VALUE_INVALID, PAY_PAYID_NOT_FOUND.
Filter and paging errors: PAY_CRTD_STARTDATE_INVALID, PAY_CRTD_ENDDATE_INVALID, PAY_MDFD_STARTDATE_INVALID, PAY_MDFD_ENDDATE_INVALID, PAY_PG_SZ_INVALID, PAY_PG_NUM_INVALID, PAY_ORDER_BY_INVALID.
Configuration and limit errors: PAY_ACCOUNT_VALIDATION_NOT_ENABLED, PAY_ACCOUNT_VALIDATION_NOT_CONFIGURED, PAY_ACCOUNT_VALIDATION_SUBMERCHANT_NOT_ASSOCIATED, PAY_ACCOUNT_VALIDATION_NOT_FOUND_ERROR, PAY_ACCOUNT_VALIDATION_NOT_SUCCESSFUL_ERROR, PAY_ACCOUNT_VALIDATION_TOO_MANY_REQUESTS, PAY_ACCOUNT_VALIDATION_TOO_MANY_REQUESTS_FOR_PAYEE, PAY_ACCOUNT_VALIDATION_NO_MATCH_THRESHOLD_EXCEEDED, PAY_ENUM_DAILY_LIMIT_PURPOSE_CODE_INVALID, PAY_ENUM_DAILY_LIMIT_PER_PAYEE_INVALID, PAY_ENUM_NO_MATCH_THRESHOLD_INVALID, PAY_ENUM_CHECK_NO_MATCH_THRESHOLD_AFTER_INVALID, PAY_BACKFILL_MAX_RECORD_COUNT_EXCEEDED.
System errors: PAY_NPP_GATEWAY_ERROR, PAY_NPP_GATEWAY_TIMEOUT, PAY_CPL_GATEWAY_TIMEOUT, PAY_OBJ_CREATE_ERROR, PAY_UNEXPECTED_ERROR.
Optional — More detailed description of the specific error which may include information from the specific request. Intended for logs and developer troubleshooting — show cxResultMessage to end users, not this text.
404 Not Found. No validation matches the id in the path — either it was never created, or it belongs to a different account. Check the value against the accountValidationUniqueId sent on the create request. A filter search that matches nothing returns 200 with an empty resultData array instead of a 404.
The body returned with a 400, 401 or 500 response.
", "customType": "ErrorResponse", "schema": [ { "name": "traceId", "kind": "optional", "type": "string", "nullable": true, "description": "Optional — Unique id for logging, generated per request. Always log it on a failure — it is the fastest way for Monoova support to find the failing call.
", "example": "0HN7GQ2L4K9AB-00000003", "default": "0HN7GQ2L4K9AB-00000003", "maxLength": 100, "pattern": "^[a-zA-Z0-9_.:-]{1,100}$" }, { "name": "errors", "kind": "optional", "type": "array", "nullable": true, "description": "Optional — One entry per problem found with the request. A single call can fail several validations at once, so handle the array rather than only its first entry.
", "modelRef": "#/components/schemas/ErrorDetail", "customType": "ErrorDetail[]", "schema": [ { "name": "errorCode", "kind": "optional", "type": "string", "nullable": true, "description": "Optional — Monoova error code — a stable, uppercase, PAY_-prefixed token to branch your error handling on. Do not parse errorMessage instead; its wording can change.
Request and format errors: PAY_REQ_BODY_INVALID, PAY_REQUEST_EMPTY, PAY_VERSION_INVALID, PAY_VERSION_UNSUPPORTED, PAY_VALIDATION_ERROR, PAY_INPUT_INJECTION_DETECTED.
Field errors: PAY_BSB_REQUIRED, PAY_BSB_INVALID, PAY_ACCOUNT_NUMBER_REQUIRED, PAY_ACCOUNT_NUMBER_INVALID, PAY_ACCOUNT_NAME_REQUIRED, PAY_ACCOUNT_NAME_INVALID, PAY_BSB_AND_ACCOUNT_REQUIRED, PAY_ACCOUNT_VALIDATION_UNIQUE_ID_REQUIRED, PAY_ACCOUNT_VALIDATION_UNIQUE_ID_INVALID, PAY_ACCOUNT_VALIDATION_UNIQUE_ID_IN_USE, PAY_ACCOUNT_LOOKUP_ID_INVALID, PAY_SUBMERCHANT_ID_INVALID, PAY_ACCTID_REQUIRED, PAY_ACCTID_INVALID, PAY_PURPOSE_CODE_REQUIRED, PAY_PURPOSE_CODE_INVALID, PAY_ALIAS_TYPE_REQUIRED, PAY_ALIAS_TYPE_INVALID, PAY_ALIAS_VALUE_REQUIRED, PAY_ALIAS_VALUE_INVALID, PAY_PAYID_TYPE_REQUIRED, PAY_PAYID_TYPE_INVALID, PAY_PAYID_VALUE_REQUIRED, PAY_PAYID_VALUE_INVALID, PAY_PAYID_NOT_FOUND.
Filter and paging errors: PAY_CRTD_STARTDATE_INVALID, PAY_CRTD_ENDDATE_INVALID, PAY_MDFD_STARTDATE_INVALID, PAY_MDFD_ENDDATE_INVALID, PAY_PG_SZ_INVALID, PAY_PG_NUM_INVALID, PAY_ORDER_BY_INVALID.
Configuration and limit errors: PAY_ACCOUNT_VALIDATION_NOT_ENABLED, PAY_ACCOUNT_VALIDATION_NOT_CONFIGURED, PAY_ACCOUNT_VALIDATION_SUBMERCHANT_NOT_ASSOCIATED, PAY_ACCOUNT_VALIDATION_NOT_FOUND_ERROR, PAY_ACCOUNT_VALIDATION_NOT_SUCCESSFUL_ERROR, PAY_ACCOUNT_VALIDATION_TOO_MANY_REQUESTS, PAY_ACCOUNT_VALIDATION_TOO_MANY_REQUESTS_FOR_PAYEE, PAY_ACCOUNT_VALIDATION_NO_MATCH_THRESHOLD_EXCEEDED, PAY_ENUM_DAILY_LIMIT_PURPOSE_CODE_INVALID, PAY_ENUM_DAILY_LIMIT_PER_PAYEE_INVALID, PAY_ENUM_NO_MATCH_THRESHOLD_INVALID, PAY_ENUM_CHECK_NO_MATCH_THRESHOLD_AFTER_INVALID, PAY_BACKFILL_MAX_RECORD_COUNT_EXCEEDED.
System errors: PAY_NPP_GATEWAY_ERROR, PAY_NPP_GATEWAY_TIMEOUT, PAY_CPL_GATEWAY_TIMEOUT, PAY_OBJ_CREATE_ERROR, PAY_UNEXPECTED_ERROR.
Optional — More detailed description of the specific error which may include information from the specific request. Intended for logs and developer troubleshooting — show cxResultMessage to end users, not this text.
500 Internal Server Error. An unexpected error occurred while processing an otherwise valid request. The request may or may not have been recorded, so re-send it with the same accountValidationUniqueId rather than a new one. Quote the traceId when contacting Monoova support.
The body returned with a 400, 401 or 500 response.
", "customType": "ErrorResponse", "schema": [ { "name": "traceId", "kind": "optional", "type": "string", "nullable": true, "description": "Optional — Unique id for logging, generated per request. Always log it on a failure — it is the fastest way for Monoova support to find the failing call.
", "example": "0HN7GQ2L4K9AB-00000003", "default": "0HN7GQ2L4K9AB-00000003", "maxLength": 100, "pattern": "^[a-zA-Z0-9_.:-]{1,100}$" }, { "name": "errors", "kind": "optional", "type": "array", "nullable": true, "description": "Optional — One entry per problem found with the request. A single call can fail several validations at once, so handle the array rather than only its first entry.
", "modelRef": "#/components/schemas/ErrorDetail", "customType": "ErrorDetail[]", "schema": [ { "name": "errorCode", "kind": "optional", "type": "string", "nullable": true, "description": "Optional — Monoova error code — a stable, uppercase, PAY_-prefixed token to branch your error handling on. Do not parse errorMessage instead; its wording can change.
Request and format errors: PAY_REQ_BODY_INVALID, PAY_REQUEST_EMPTY, PAY_VERSION_INVALID, PAY_VERSION_UNSUPPORTED, PAY_VALIDATION_ERROR, PAY_INPUT_INJECTION_DETECTED.
Field errors: PAY_BSB_REQUIRED, PAY_BSB_INVALID, PAY_ACCOUNT_NUMBER_REQUIRED, PAY_ACCOUNT_NUMBER_INVALID, PAY_ACCOUNT_NAME_REQUIRED, PAY_ACCOUNT_NAME_INVALID, PAY_BSB_AND_ACCOUNT_REQUIRED, PAY_ACCOUNT_VALIDATION_UNIQUE_ID_REQUIRED, PAY_ACCOUNT_VALIDATION_UNIQUE_ID_INVALID, PAY_ACCOUNT_VALIDATION_UNIQUE_ID_IN_USE, PAY_ACCOUNT_LOOKUP_ID_INVALID, PAY_SUBMERCHANT_ID_INVALID, PAY_ACCTID_REQUIRED, PAY_ACCTID_INVALID, PAY_PURPOSE_CODE_REQUIRED, PAY_PURPOSE_CODE_INVALID, PAY_ALIAS_TYPE_REQUIRED, PAY_ALIAS_TYPE_INVALID, PAY_ALIAS_VALUE_REQUIRED, PAY_ALIAS_VALUE_INVALID, PAY_PAYID_TYPE_REQUIRED, PAY_PAYID_TYPE_INVALID, PAY_PAYID_VALUE_REQUIRED, PAY_PAYID_VALUE_INVALID, PAY_PAYID_NOT_FOUND.
Filter and paging errors: PAY_CRTD_STARTDATE_INVALID, PAY_CRTD_ENDDATE_INVALID, PAY_MDFD_STARTDATE_INVALID, PAY_MDFD_ENDDATE_INVALID, PAY_PG_SZ_INVALID, PAY_PG_NUM_INVALID, PAY_ORDER_BY_INVALID.
Configuration and limit errors: PAY_ACCOUNT_VALIDATION_NOT_ENABLED, PAY_ACCOUNT_VALIDATION_NOT_CONFIGURED, PAY_ACCOUNT_VALIDATION_SUBMERCHANT_NOT_ASSOCIATED, PAY_ACCOUNT_VALIDATION_NOT_FOUND_ERROR, PAY_ACCOUNT_VALIDATION_NOT_SUCCESSFUL_ERROR, PAY_ACCOUNT_VALIDATION_TOO_MANY_REQUESTS, PAY_ACCOUNT_VALIDATION_TOO_MANY_REQUESTS_FOR_PAYEE, PAY_ACCOUNT_VALIDATION_NO_MATCH_THRESHOLD_EXCEEDED, PAY_ENUM_DAILY_LIMIT_PURPOSE_CODE_INVALID, PAY_ENUM_DAILY_LIMIT_PER_PAYEE_INVALID, PAY_ENUM_NO_MATCH_THRESHOLD_INVALID, PAY_ENUM_CHECK_NO_MATCH_THRESHOLD_AFTER_INVALID, PAY_BACKFILL_MAX_RECORD_COUNT_EXCEEDED.
System errors: PAY_NPP_GATEWAY_ERROR, PAY_NPP_GATEWAY_TIMEOUT, PAY_CPL_GATEWAY_TIMEOUT, PAY_OBJ_CREATE_ERROR, PAY_UNEXPECTED_ERROR.
Optional — More detailed description of the specific error which may include information from the specific request. Intended for logs and developer troubleshooting — show cxResultMessage to end users, not this text.
502 Bad Gateway. The request was valid, but an upstream service — the NPP gateway that performs the name match — returned an error, so no result could be produced. The validation was not completed. Retry with the same accountValidationUniqueId after a short delay, and escalate with the traceId if it persists.
The body returned with a 400, 401 or 500 response.
", "customType": "ErrorResponse", "schema": [ { "name": "traceId", "kind": "optional", "type": "string", "nullable": true, "description": "Optional — Unique id for logging, generated per request. Always log it on a failure — it is the fastest way for Monoova support to find the failing call.
", "example": "0HN7GQ2L4K9AB-00000003", "default": "0HN7GQ2L4K9AB-00000003", "maxLength": 100, "pattern": "^[a-zA-Z0-9_.:-]{1,100}$" }, { "name": "errors", "kind": "optional", "type": "array", "nullable": true, "description": "Optional — One entry per problem found with the request. A single call can fail several validations at once, so handle the array rather than only its first entry.
", "modelRef": "#/components/schemas/ErrorDetail", "customType": "ErrorDetail[]", "schema": [ { "name": "errorCode", "kind": "optional", "type": "string", "nullable": true, "description": "Optional — Monoova error code — a stable, uppercase, PAY_-prefixed token to branch your error handling on. Do not parse errorMessage instead; its wording can change.
Request and format errors: PAY_REQ_BODY_INVALID, PAY_REQUEST_EMPTY, PAY_VERSION_INVALID, PAY_VERSION_UNSUPPORTED, PAY_VALIDATION_ERROR, PAY_INPUT_INJECTION_DETECTED.
Field errors: PAY_BSB_REQUIRED, PAY_BSB_INVALID, PAY_ACCOUNT_NUMBER_REQUIRED, PAY_ACCOUNT_NUMBER_INVALID, PAY_ACCOUNT_NAME_REQUIRED, PAY_ACCOUNT_NAME_INVALID, PAY_BSB_AND_ACCOUNT_REQUIRED, PAY_ACCOUNT_VALIDATION_UNIQUE_ID_REQUIRED, PAY_ACCOUNT_VALIDATION_UNIQUE_ID_INVALID, PAY_ACCOUNT_VALIDATION_UNIQUE_ID_IN_USE, PAY_ACCOUNT_LOOKUP_ID_INVALID, PAY_SUBMERCHANT_ID_INVALID, PAY_ACCTID_REQUIRED, PAY_ACCTID_INVALID, PAY_PURPOSE_CODE_REQUIRED, PAY_PURPOSE_CODE_INVALID, PAY_ALIAS_TYPE_REQUIRED, PAY_ALIAS_TYPE_INVALID, PAY_ALIAS_VALUE_REQUIRED, PAY_ALIAS_VALUE_INVALID, PAY_PAYID_TYPE_REQUIRED, PAY_PAYID_TYPE_INVALID, PAY_PAYID_VALUE_REQUIRED, PAY_PAYID_VALUE_INVALID, PAY_PAYID_NOT_FOUND.
Filter and paging errors: PAY_CRTD_STARTDATE_INVALID, PAY_CRTD_ENDDATE_INVALID, PAY_MDFD_STARTDATE_INVALID, PAY_MDFD_ENDDATE_INVALID, PAY_PG_SZ_INVALID, PAY_PG_NUM_INVALID, PAY_ORDER_BY_INVALID.
Configuration and limit errors: PAY_ACCOUNT_VALIDATION_NOT_ENABLED, PAY_ACCOUNT_VALIDATION_NOT_CONFIGURED, PAY_ACCOUNT_VALIDATION_SUBMERCHANT_NOT_ASSOCIATED, PAY_ACCOUNT_VALIDATION_NOT_FOUND_ERROR, PAY_ACCOUNT_VALIDATION_NOT_SUCCESSFUL_ERROR, PAY_ACCOUNT_VALIDATION_TOO_MANY_REQUESTS, PAY_ACCOUNT_VALIDATION_TOO_MANY_REQUESTS_FOR_PAYEE, PAY_ACCOUNT_VALIDATION_NO_MATCH_THRESHOLD_EXCEEDED, PAY_ENUM_DAILY_LIMIT_PURPOSE_CODE_INVALID, PAY_ENUM_DAILY_LIMIT_PER_PAYEE_INVALID, PAY_ENUM_NO_MATCH_THRESHOLD_INVALID, PAY_ENUM_CHECK_NO_MATCH_THRESHOLD_AFTER_INVALID, PAY_BACKFILL_MAX_RECORD_COUNT_EXCEEDED.
System errors: PAY_NPP_GATEWAY_ERROR, PAY_NPP_GATEWAY_TIMEOUT, PAY_CPL_GATEWAY_TIMEOUT, PAY_OBJ_CREATE_ERROR, PAY_UNEXPECTED_ERROR.
Optional — More detailed description of the specific error which may include information from the specific request. Intended for logs and developer troubleshooting — show cxResultMessage to end users, not this text.
504 Gateway Timeout. An upstream service did not respond in time. Unlike a 502, the outcome is genuinely unknown — the validation may still have been recorded. Re-send with the same accountValidationUniqueId rather than a new one so the original record is reused, or call Get Account Validation by Id first to see whether a result already exists.
The body returned with a 400, 401 or 500 response.
", "customType": "ErrorResponse", "schema": [ { "name": "traceId", "kind": "optional", "type": "string", "nullable": true, "description": "Optional — Unique id for logging, generated per request. Always log it on a failure — it is the fastest way for Monoova support to find the failing call.
", "example": "0HN7GQ2L4K9AB-00000003", "default": "0HN7GQ2L4K9AB-00000003", "maxLength": 100, "pattern": "^[a-zA-Z0-9_.:-]{1,100}$" }, { "name": "errors", "kind": "optional", "type": "array", "nullable": true, "description": "Optional — One entry per problem found with the request. A single call can fail several validations at once, so handle the array rather than only its first entry.
", "modelRef": "#/components/schemas/ErrorDetail", "customType": "ErrorDetail[]", "schema": [ { "name": "errorCode", "kind": "optional", "type": "string", "nullable": true, "description": "Optional — Monoova error code — a stable, uppercase, PAY_-prefixed token to branch your error handling on. Do not parse errorMessage instead; its wording can change.
Request and format errors: PAY_REQ_BODY_INVALID, PAY_REQUEST_EMPTY, PAY_VERSION_INVALID, PAY_VERSION_UNSUPPORTED, PAY_VALIDATION_ERROR, PAY_INPUT_INJECTION_DETECTED.
Field errors: PAY_BSB_REQUIRED, PAY_BSB_INVALID, PAY_ACCOUNT_NUMBER_REQUIRED, PAY_ACCOUNT_NUMBER_INVALID, PAY_ACCOUNT_NAME_REQUIRED, PAY_ACCOUNT_NAME_INVALID, PAY_BSB_AND_ACCOUNT_REQUIRED, PAY_ACCOUNT_VALIDATION_UNIQUE_ID_REQUIRED, PAY_ACCOUNT_VALIDATION_UNIQUE_ID_INVALID, PAY_ACCOUNT_VALIDATION_UNIQUE_ID_IN_USE, PAY_ACCOUNT_LOOKUP_ID_INVALID, PAY_SUBMERCHANT_ID_INVALID, PAY_ACCTID_REQUIRED, PAY_ACCTID_INVALID, PAY_PURPOSE_CODE_REQUIRED, PAY_PURPOSE_CODE_INVALID, PAY_ALIAS_TYPE_REQUIRED, PAY_ALIAS_TYPE_INVALID, PAY_ALIAS_VALUE_REQUIRED, PAY_ALIAS_VALUE_INVALID, PAY_PAYID_TYPE_REQUIRED, PAY_PAYID_TYPE_INVALID, PAY_PAYID_VALUE_REQUIRED, PAY_PAYID_VALUE_INVALID, PAY_PAYID_NOT_FOUND.
Filter and paging errors: PAY_CRTD_STARTDATE_INVALID, PAY_CRTD_ENDDATE_INVALID, PAY_MDFD_STARTDATE_INVALID, PAY_MDFD_ENDDATE_INVALID, PAY_PG_SZ_INVALID, PAY_PG_NUM_INVALID, PAY_ORDER_BY_INVALID.
Configuration and limit errors: PAY_ACCOUNT_VALIDATION_NOT_ENABLED, PAY_ACCOUNT_VALIDATION_NOT_CONFIGURED, PAY_ACCOUNT_VALIDATION_SUBMERCHANT_NOT_ASSOCIATED, PAY_ACCOUNT_VALIDATION_NOT_FOUND_ERROR, PAY_ACCOUNT_VALIDATION_NOT_SUCCESSFUL_ERROR, PAY_ACCOUNT_VALIDATION_TOO_MANY_REQUESTS, PAY_ACCOUNT_VALIDATION_TOO_MANY_REQUESTS_FOR_PAYEE, PAY_ACCOUNT_VALIDATION_NO_MATCH_THRESHOLD_EXCEEDED, PAY_ENUM_DAILY_LIMIT_PURPOSE_CODE_INVALID, PAY_ENUM_DAILY_LIMIT_PER_PAYEE_INVALID, PAY_ENUM_NO_MATCH_THRESHOLD_INVALID, PAY_ENUM_CHECK_NO_MATCH_THRESHOLD_AFTER_INVALID, PAY_BACKFILL_MAX_RECORD_COUNT_EXCEEDED.
System errors: PAY_NPP_GATEWAY_ERROR, PAY_NPP_GATEWAY_TIMEOUT, PAY_CPL_GATEWAY_TIMEOUT, PAY_OBJ_CREATE_ERROR, PAY_UNEXPECTED_ERROR.
Optional — More detailed description of the specific error which may include information from the specific request. Intended for logs and developer troubleshooting — show cxResultMessage to end users, not this text.