--- title: Get Account Validation by Filter slug: api/get-account-validation-by-filter docTags: createdAt: 2026-09-24T03:48:25.702Z --- { "id": "X05mUMCmYqItOOVM3qvlG", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://sand-api.monoova.com/au/cop/payman-v2/AccountValidation", "servers": [ { "url": "https://sand-api.monoova.com/au/cop/payman-v2/AccountValidation", "description": "Sandbox URL" }, { "url": "https://api.monoova.com/au/cop/payman-v2/AccountValidation", "description": "Production URL" } ], "name": "Get Account Validation by Filter", "description": "

Returns a paged list of Confirmation of Payee validations that match the supplied filters.

\n

All filters are combined with AND. Omit every filter to return the most recent validations for your account. Results are split into pages using pageNumber and pageSize, and the paging object in the response reports the totals.

", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [], "queryParameters": [ { "kind": "optional", "name": "createdStartDate", "type": "string", "example": "2026-09-01T00:00:00+10:00", "description": "

Optional — Start of the creation-date window. Enter a full ISO 8601 date-time including the UTC offset, for example 2026-09-01T00:00:00+10:00. Cannot be a future date. Validations created on or after this point are returned.

", "default": "2026-09-01T00:00:00+10:00", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,7})?(Z|[+-]\\d{2}:\\d{2})?$" }, { "kind": "optional", "name": "createdEndDate", "type": "string", "example": "2026-09-23T23:59:59+10:00", "description": "

Conditional — End of the creation-date window. Enter a full ISO 8601 date-time including the UTC offset, for example 2026-09-23T23:59:59+10:00. Set the time to the end of the day to include everything recorded on that date. Cannot be earlier than createdStartDate, so supply it together with createdStartDate when bounding a range.

", "default": "2026-09-23T23:59:59+10:00", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,7})?(Z|[+-]\\d{2}:\\d{2})?$" }, { "kind": "optional", "name": "lastModifiedStartDate", "type": "string", "example": "2026-09-01T00:00:00+10:00", "description": "

Optional — Start of the last-modified window. Enter a full ISO 8601 date-time including the UTC offset, for example 2026-09-01T00:00:00+10:00. Cannot be a future date. Use it to pick up validations whose result has changed since your last poll.

", "default": "2026-09-01T00:00:00+10:00", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,7})?(Z|[+-]\\d{2}:\\d{2})?$" }, { "kind": "optional", "name": "lastModifiedEndDate", "type": "string", "example": "2026-09-23T23:59:59+10:00", "description": "

Conditional — End of the last-modified window. Enter a full ISO 8601 date-time including the UTC offset, for example 2026-09-23T23:59:59+10:00. Set the time to the end of the day to include everything recorded on that date. Cannot be earlier than lastModifiedStartDate, so supply it together with lastModifiedStartDate when bounding a range.

", "default": "2026-09-23T23:59:59+10:00", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,7})?(Z|[+-]\\d{2}:\\d{2})?$" }, { "kind": "optional", "name": "subMerchantId", "type": "string", "example": "SUBM-0001234", "description": "

Optional — Monoova submerchant Id to filter on. Returns only the validations recorded against that submerchant. Up to 36 characters: letters, digits, hyphen and underscore.

", "default": "SUBM-0001234", "maxLength": 36, "pattern": "^[a-zA-Z0-9_-]{1,36}$" }, { "kind": "optional", "name": "pageNumber", "type": "integer", "example": 1, "description": "

Optional — Page to be returned after records are split as per pageSize. Whole number, minimum 1. Falls back to 1 when omitted.

", "default": 1, "format": "int32", "minimum": 1, "pattern": "^[1-9][0-9]{0,8}$" }, { "kind": "optional", "name": "pageSize", "type": "integer", "example": 50, "description": "

Optional — Number of records per page. Whole number between 1 and 500. Falls back to 50 when omitted.

", "default": 50, "format": "int32", "minimum": 1, "maximum": 500, "pattern": "^([1-9]|[1-9][0-9]|[1-4][0-9]{2}|500)$" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "BearerAuth", "name": "BearerAuth", "kind": "optional", "type": "http", "description": "

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

", "scheme": "bearer" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "

200 OK. A page of validations matching the filters, plus a paging object describing the position in the result set. An empty resultData array means no validation matched the filters — it is not an error.

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"traceId\":\"0HN7GQ2L4K9AB-00000002\",\"resultData\":[{\"cxResultIconCode\":\"TICK\",\"cxResultMessage\":\"The account name matches the account details provided.\",\"cxResultDisplayAccountName\":\"Monoova Payments Pty Ltd\",\"resultCode\":\"MTCH\",\"accountValidationUniqueId\":\"AV-2026-0923-000185\",\"subMerchantId\":\"SUBM-0001234\"},{\"cxResultIconCode\":\"EXCM\",\"cxResultMessage\":\"The account name is a close match to the details provided.\",\"cxResultDisplayAccountName\":\"Monoova Payments Pty Limited\",\"resultCode\":\"CMTC\",\"accountValidationUniqueId\":\"AV-2026-0923-000186\",\"subMerchantId\":\"SUBM-0001234\"}],\"paging\":{\"currentPage\":1,\"pageSize\":50,\"totalItems\":2,\"totalPages\":1}}", "description": "

A page of Confirmation of Payee validation results, with paging metadata.

", "customType": "AccountValidationByFilterResponse", "schema": [ { "name": "traceId", "kind": "optional", "type": "string", "nullable": true, "description": "

Optional — Unique id for logging, generated per request. Quote it when raising a support ticket about this search.

", "example": "0HN7GQ2L4K9AB-00000002", "default": "0HN7GQ2L4K9AB-00000002", "maxLength": 100, "pattern": "^[a-zA-Z0-9_.:-]{1,100}$" }, { "name": "resultData", "kind": "optional", "type": "array", "nullable": true, "description": "

Optional — The validations on the requested page, each in the same shape as the single result returned by Get Account Validation by Id. An empty array means nothing matched the filters.

", "modelRef": "#/components/schemas/AccountValidationResultData", "customType": "AccountValidationResultData[]", "schema": [ { "name": "cxResultIconCode", "kind": "optional", "type": "string", "nullable": true, "description": "

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.

", "example": "TICK", "default": "TICK", "maxLength": 4, "pattern": "^(TICK|EXCM|CROS|DASH)$" }, { "name": "cxResultMessage", "kind": "optional", "type": "string", "nullable": true, "description": "

Optional — Message for the result, already worded for the payer. Show it as supplied rather than composing your own text from resultCode.

", "example": "The account name matches the account details provided.", "default": "The account name matches the account details provided.", "maxLength": 255, "pattern": "^[ -~]{1,255}$" }, { "name": "cxResultDisplayAccountName", "kind": "optional", "type": "string", "nullable": true, "description": "

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.

", "example": "Monoova Payments Pty Ltd", "default": "Monoova Payments Pty Ltd", "minLength": 2, "maxLength": 140, "pattern": "^[!-~][ -~]{0,138}[!-~]$" }, { "name": "resultCode", "kind": "optional", "type": "string", "nullable": true, "description": "

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).

", "example": "MTCH", "default": "MTCH", "maxLength": 4, "pattern": "^(MTCH|CMTC|NMTC|NFND|CLSD)$" }, { "name": "accountValidationUniqueId", "kind": "optional", "type": "string", "nullable": true, "description": "

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}$" } ] }, { "name": "paging", "kind": "optional", "type": "object", "description": "

Optional — Position of this page within the full result set. Use totalPages to decide whether to request a further page.

", "modelRef": "#/components/schemas/PagingMetadata", "customType": "PagingMetadata", "schema": [ { "name": "currentPage", "kind": "optional", "type": "integer", "description": "

Optional — Page to be returned after records are split as per pageSize — echoes the pageNumber requested, or 1 when none was supplied.

", "example": 1, "default": 1, "format": "int32", "minimum": 1, "pattern": "^[1-9][0-9]{0,8}$" }, { "name": "pageSize", "kind": "optional", "type": "integer", "description": "

Optional — Number of records per page — echoes the pageSize requested, or 50 when none was supplied.

", "example": 50, "default": 50, "format": "int32", "minimum": 1, "maximum": 500, "pattern": "^([1-9]|[1-9][0-9]|[1-4][0-9]{2}|500)$" }, { "name": "totalItems", "kind": "optional", "type": "integer", "description": "

Optional — Number of total records matching the filters across every page, not the number returned on this page.

", "example": 2, "default": 2, "format": "int32", "minimum": 0, "pattern": "^[0-9]{1,9}$" }, { "name": "totalPages", "kind": "optional", "type": "integer", "description": "

Optional — Number of pages the matching records are split into at the current pageSize. Stop paging once currentPage reaches this value.

", "example": 1, "default": 1, "format": "int32", "minimum": 0, "pattern": "^[0-9]{1,9}$" } ] } ], "modelRef": "#/components/schemas/AccountValidationByFilterResponse", "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.

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"traceId\":\"0HN7GQ2L4K9AB-00000003\",\"errors\":[{\"errorCode\":\"PAY_BSB_INVALID\",\"errorMessage\":\"The field bsb must match the pattern ^[0-9]{3}-[0-9]{3}$.\"},{\"errorCode\":\"PAY_ACCOUNT_NAME_REQUIRED\",\"errorMessage\":\"The field accountName is required.\"}]}", "description": "

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.

\n

Request and format errors: PAY_REQ_BODY_INVALID, PAY_REQUEST_EMPTY, PAY_VERSION_INVALID, PAY_VERSION_UNSUPPORTED, PAY_VALIDATION_ERROR, PAY_INPUT_INJECTION_DETECTED.

\n

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.

\n

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.

\n

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.

\n

System errors: PAY_NPP_GATEWAY_ERROR, PAY_NPP_GATEWAY_TIMEOUT, PAY_CPL_GATEWAY_TIMEOUT, PAY_OBJ_CREATE_ERROR, PAY_UNEXPECTED_ERROR.

", "example": "PAY_BSB_INVALID", "default": "PAY_BSB_INVALID", "maxLength": 80, "pattern": "^PAY_[A-Z0-9_]{1,76}$" }, { "name": "errorMessage", "kind": "optional", "type": "string", "nullable": true, "description": "

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.

", "example": "The field bsb must match the pattern ^[0-9]{3}-[0-9]{3}$.", "default": "The field bsb must match the pattern ^[0-9]{3}-[0-9]{3}$.", "maxLength": 500, "pattern": "^[ -~]{1,500}$" } ] } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] }, { "statusCode": "401", "description": "

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.

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"traceId\":\"0HN7GQ2L4K9AB-00000004\",\"errors\":[{\"errorCode\":\"PAY_UNAUTHORIZED\",\"errorMessage\":\"Authorization has been denied for this request.\"}]}", "description": "

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.

\n

Request and format errors: PAY_REQ_BODY_INVALID, PAY_REQUEST_EMPTY, PAY_VERSION_INVALID, PAY_VERSION_UNSUPPORTED, PAY_VALIDATION_ERROR, PAY_INPUT_INJECTION_DETECTED.

\n

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.

\n

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.

\n

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.

\n

System errors: PAY_NPP_GATEWAY_ERROR, PAY_NPP_GATEWAY_TIMEOUT, PAY_CPL_GATEWAY_TIMEOUT, PAY_OBJ_CREATE_ERROR, PAY_UNEXPECTED_ERROR.

", "example": "PAY_BSB_INVALID", "default": "PAY_BSB_INVALID", "maxLength": 80, "pattern": "^PAY_[A-Z0-9_]{1,76}$" }, { "name": "errorMessage", "kind": "optional", "type": "string", "nullable": true, "description": "

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.

", "example": "The field bsb must match the pattern ^[0-9]{3}-[0-9]{3}$.", "default": "The field bsb must match the pattern ^[0-9]{3}-[0-9]{3}$.", "maxLength": 500, "pattern": "^[ -~]{1,500}$" } ] } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] }, { "statusCode": "403", "description": "

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.

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"traceId\":\"0HN7GQ2L4K9AB-00000006\",\"errors\":[{\"errorCode\":\"PAY_ACCOUNT_VALIDATION_NOT_ENABLED\",\"errorMessage\":\"Account validation is not enabled for this account.\"}]}", "description": "

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.

\n

Request and format errors: PAY_REQ_BODY_INVALID, PAY_REQUEST_EMPTY, PAY_VERSION_INVALID, PAY_VERSION_UNSUPPORTED, PAY_VALIDATION_ERROR, PAY_INPUT_INJECTION_DETECTED.

\n

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.

\n

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.

\n

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.

\n

System errors: PAY_NPP_GATEWAY_ERROR, PAY_NPP_GATEWAY_TIMEOUT, PAY_CPL_GATEWAY_TIMEOUT, PAY_OBJ_CREATE_ERROR, PAY_UNEXPECTED_ERROR.

", "example": "PAY_BSB_INVALID", "default": "PAY_BSB_INVALID", "maxLength": 80, "pattern": "^PAY_[A-Z0-9_]{1,76}$" }, { "name": "errorMessage", "kind": "optional", "type": "string", "nullable": true, "description": "

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.

", "example": "The field bsb must match the pattern ^[0-9]{3}-[0-9]{3}$.", "default": "The field bsb must match the pattern ^[0-9]{3}-[0-9]{3}$.", "maxLength": 500, "pattern": "^[ -~]{1,500}$" } ] } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] }, { "statusCode": "404", "description": "

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.

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"traceId\":\"0HN7GQ2L4K9AB-00000007\",\"errors\":[{\"errorCode\":\"PAY_ACCOUNT_VALIDATION_NOT_FOUND_ERROR\",\"errorMessage\":\"No account validation was found for the supplied id.\"}]}", "description": "

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.

\n

Request and format errors: PAY_REQ_BODY_INVALID, PAY_REQUEST_EMPTY, PAY_VERSION_INVALID, PAY_VERSION_UNSUPPORTED, PAY_VALIDATION_ERROR, PAY_INPUT_INJECTION_DETECTED.

\n

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.

\n

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.

\n

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.

\n

System errors: PAY_NPP_GATEWAY_ERROR, PAY_NPP_GATEWAY_TIMEOUT, PAY_CPL_GATEWAY_TIMEOUT, PAY_OBJ_CREATE_ERROR, PAY_UNEXPECTED_ERROR.

", "example": "PAY_BSB_INVALID", "default": "PAY_BSB_INVALID", "maxLength": 80, "pattern": "^PAY_[A-Z0-9_]{1,76}$" }, { "name": "errorMessage", "kind": "optional", "type": "string", "nullable": true, "description": "

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.

", "example": "The field bsb must match the pattern ^[0-9]{3}-[0-9]{3}$.", "default": "The field bsb must match the pattern ^[0-9]{3}-[0-9]{3}$.", "maxLength": 500, "pattern": "^[ -~]{1,500}$" } ] } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] }, { "statusCode": "500", "description": "

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.

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"traceId\":\"0HN7GQ2L4K9AB-00000005\",\"errors\":[{\"errorCode\":\"PAY_UNEXPECTED_ERROR\",\"errorMessage\":\"An unexpected error occurred while processing the request.\"}]}", "description": "

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.

\n

Request and format errors: PAY_REQ_BODY_INVALID, PAY_REQUEST_EMPTY, PAY_VERSION_INVALID, PAY_VERSION_UNSUPPORTED, PAY_VALIDATION_ERROR, PAY_INPUT_INJECTION_DETECTED.

\n

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.

\n

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.

\n

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.

\n

System errors: PAY_NPP_GATEWAY_ERROR, PAY_NPP_GATEWAY_TIMEOUT, PAY_CPL_GATEWAY_TIMEOUT, PAY_OBJ_CREATE_ERROR, PAY_UNEXPECTED_ERROR.

", "example": "PAY_BSB_INVALID", "default": "PAY_BSB_INVALID", "maxLength": 80, "pattern": "^PAY_[A-Z0-9_]{1,76}$" }, { "name": "errorMessage", "kind": "optional", "type": "string", "nullable": true, "description": "

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.

", "example": "The field bsb must match the pattern ^[0-9]{3}-[0-9]{3}$.", "default": "The field bsb must match the pattern ^[0-9]{3}-[0-9]{3}$.", "maxLength": 500, "pattern": "^[ -~]{1,500}$" } ] } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] }, { "statusCode": "502", "description": "

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.

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"traceId\":\"0HN7GQ2L4K9AB-00000008\",\"errors\":[{\"errorCode\":\"PAY_NPP_GATEWAY_ERROR\",\"errorMessage\":\"The upstream gateway returned an error while processing the validation.\"}]}", "description": "

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.

\n

Request and format errors: PAY_REQ_BODY_INVALID, PAY_REQUEST_EMPTY, PAY_VERSION_INVALID, PAY_VERSION_UNSUPPORTED, PAY_VALIDATION_ERROR, PAY_INPUT_INJECTION_DETECTED.

\n

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.

\n

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.

\n

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.

\n

System errors: PAY_NPP_GATEWAY_ERROR, PAY_NPP_GATEWAY_TIMEOUT, PAY_CPL_GATEWAY_TIMEOUT, PAY_OBJ_CREATE_ERROR, PAY_UNEXPECTED_ERROR.

", "example": "PAY_BSB_INVALID", "default": "PAY_BSB_INVALID", "maxLength": 80, "pattern": "^PAY_[A-Z0-9_]{1,76}$" }, { "name": "errorMessage", "kind": "optional", "type": "string", "nullable": true, "description": "

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.

", "example": "The field bsb must match the pattern ^[0-9]{3}-[0-9]{3}$.", "default": "The field bsb must match the pattern ^[0-9]{3}-[0-9]{3}$.", "maxLength": 500, "pattern": "^[ -~]{1,500}$" } ] } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] }, { "statusCode": "504", "description": "

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.

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"traceId\":\"0HN7GQ2L4K9AB-00000009\",\"errors\":[{\"errorCode\":\"PAY_NPP_GATEWAY_TIMEOUT\",\"errorMessage\":\"The upstream gateway did not respond within the expected time.\"}]}", "description": "

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.

\n

Request and format errors: PAY_REQ_BODY_INVALID, PAY_REQUEST_EMPTY, PAY_VERSION_INVALID, PAY_VERSION_UNSUPPORTED, PAY_VALIDATION_ERROR, PAY_INPUT_INJECTION_DETECTED.

\n

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.

\n

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.

\n

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.

\n

System errors: PAY_NPP_GATEWAY_ERROR, PAY_NPP_GATEWAY_TIMEOUT, PAY_CPL_GATEWAY_TIMEOUT, PAY_OBJ_CREATE_ERROR, PAY_UNEXPECTED_ERROR.

", "example": "PAY_BSB_INVALID", "default": "PAY_BSB_INVALID", "maxLength": 80, "pattern": "^PAY_[A-Z0-9_]{1,76}$" }, { "name": "errorMessage", "kind": "optional", "type": "string", "nullable": true, "description": "

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.

", "example": "The field bsb must match the pattern ^[0-9]{3}-[0-9]{3}$.", "default": "The field bsb must match the pattern ^[0-9]{3}-[0-9]{3}$.", "maxLength": 500, "pattern": "^[ -~]{1,500}$" } ] } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "OrS2lRieG0EbKS8u9qKHa", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url 'https://sand-api.monoova.com/au/cop/payman-v2/AccountValidation?createdStartDate=2026-09-01T00%3A00%3A00%2B10%3A00&createdEndDate=2026-09-23T23%3A59%3A59%2B10%3A00&lastModifiedStartDate=2026-09-01T00%3A00%3A00%2B10%3A00&lastModifiedEndDate=2026-09-23T23%3A59%3A59%2B10%3A00&subMerchantId=SUBM-0001234&pageNumber=1&pageSize=50' \\\n --header 'accept: application/json'" }, { "id": "05axgWqTsGSMYy2RMBCQc", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://sand-api.monoova.com/au/cop/payman-v2/AccountValidation?createdStartDate=2026-09-01T00:00:00+10:00&createdEndDate=2026-09-23T23:59:59+10:00&lastModifiedStartDate=2026-09-01T00:00:00+10:00&lastModifiedEndDate=2026-09-23T23:59:59+10:00&subMerchantId=SUBM-0001234&pageNumber=1&pageSize=50\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "miqHl9BlqDGjzJqJDnz2-", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://sand-api.monoova.com/au/cop/payman-v2/AccountValidation?createdStartDate=2026-09-01T00:00:00+10:00&createdEndDate=2026-09-23T23:59:59+10:00&lastModifiedStartDate=2026-09-01T00:00:00+10:00&lastModifiedEndDate=2026-09-23T23:59:59+10:00&subMerchantId=SUBM-0001234&pageNumber=1&pageSize=50\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "4vtmMmrVXv4Qt_MWkxF2S", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://sand-api.monoova.com/au/cop/payman-v2/AccountValidation?createdStartDate=2026-09-01T00:00:00+10:00&createdEndDate=2026-09-23T23:59:59+10:00&lastModifiedStartDate=2026-09-01T00:00:00+10:00&lastModifiedEndDate=2026-09-23T23:59:59+10:00&subMerchantId=SUBM-0001234&pageNumber=1&pageSize=50\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "OrS2lRieG0EbKS8u9qKHa" }, "results": { "languages": [ { "id": "response-0-200", "language": "200", "code": "// 200 OK. A page of validations matching the filters, plus a paging object describing the position in the result set. An empty resultData array means no validation matched the filters — it is not an error.\n{\n \"traceId\": \"0HN7GQ2L4K9AB-00000002\",\n \"resultData\": [\n {\n \"cxResultIconCode\": \"TICK\",\n \"cxResultMessage\": \"The account name matches the account details provided.\",\n \"cxResultDisplayAccountName\": \"Monoova Payments Pty Ltd\",\n \"resultCode\": \"MTCH\",\n \"accountValidationUniqueId\": \"AV-2026-0923-000185\",\n \"subMerchantId\": \"SUBM-0001234\"\n }\n ],\n \"paging\": {\n \"currentPage\": 1,\n \"pageSize\": 50,\n \"totalItems\": 2,\n \"totalPages\": 1\n }\n}" }, { "id": "response-1-400", "language": "400", "code": "// 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.\n{\n \"traceId\": \"0HN7GQ2L4K9AB-00000003\",\n \"errors\": [\n {\n \"errorCode\": \"PAY_BSB_INVALID\",\n \"errorMessage\": \"The field bsb must match the pattern ^[0-9]{3}-[0-9]{3}$.\"\n }\n ]\n}" }, { "id": "response-2-401", "language": "401", "code": "// 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.\n{\n \"traceId\": \"0HN7GQ2L4K9AB-00000003\",\n \"errors\": [\n {\n \"errorCode\": \"PAY_BSB_INVALID\",\n \"errorMessage\": \"The field bsb must match the pattern ^[0-9]{3}-[0-9]{3}$.\"\n }\n ]\n}" }, { "id": "response-3-403", "language": "403", "code": "// 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.\n{\n \"traceId\": \"0HN7GQ2L4K9AB-00000003\",\n \"errors\": [\n {\n \"errorCode\": \"PAY_BSB_INVALID\",\n \"errorMessage\": \"The field bsb must match the pattern ^[0-9]{3}-[0-9]{3}$.\"\n }\n ]\n}" }, { "id": "response-4-404", "language": "404", "code": "// 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.\n{\n \"traceId\": \"0HN7GQ2L4K9AB-00000003\",\n \"errors\": [\n {\n \"errorCode\": \"PAY_BSB_INVALID\",\n \"errorMessage\": \"The field bsb must match the pattern ^[0-9]{3}-[0-9]{3}$.\"\n }\n ]\n}" }, { "id": "response-5-500", "language": "500", "code": "// 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.\n{\n \"traceId\": \"0HN7GQ2L4K9AB-00000003\",\n \"errors\": [\n {\n \"errorCode\": \"PAY_BSB_INVALID\",\n \"errorMessage\": \"The field bsb must match the pattern ^[0-9]{3}-[0-9]{3}$.\"\n }\n ]\n}" }, { "id": "response-6-502", "language": "502", "code": "// 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.\n{\n \"traceId\": \"0HN7GQ2L4K9AB-00000003\",\n \"errors\": [\n {\n \"errorCode\": \"PAY_BSB_INVALID\",\n \"errorMessage\": \"The field bsb must match the pattern ^[0-9]{3}-[0-9]{3}$.\"\n }\n ]\n}" }, { "id": "response-7-504", "language": "504", "code": "// 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.\n{\n \"traceId\": \"0HN7GQ2L4K9AB-00000003\",\n \"errors\": [\n {\n \"errorCode\": \"PAY_BSB_INVALID\",\n \"errorMessage\": \"The field bsb must match the pattern ^[0-9]{3}-[0-9]{3}$.\"\n }\n ]\n}" } ], "selectedLanguageId": "response-0-200" } }, "children": [ { "text": "" } ] }