Get Account Validation by Id

GET

https://sand-api.monoova.com/au/cop/payman-v2/AccountValidation/{id}

Returns a single Confirmation of Payee validation.

The id in the path is the accountValidationUniqueId you supplied when the validation was created, so no Monoova-generated key needs to be stored on your side.

Path Parameters

idstringrequired
Example
AV-2026-0923-000185
Description
Required — Id to uniquely identify the COP validation. This is the accountValidationUniqueId supplied on the original create request. Up to 40 characters: letters, digits, hyphen and underscore.
Default
AV-2026-0923-000185
Max Length
40
Pattern
^[a-zA-Z0-9_-]{1,40}$

Responses

200

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.

AccountValidationResponse
Example
```
{
  "traceId": "0HN7GQ2L4K9AB-00000001",
  "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"
  }
}
```
Description
A single Confirmation of Payee validation result.
- traceIdstring
  Example
  0HN7GQ2L4K9AB-00000001
  Description
  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.
  Default
  0HN7GQ2L4K9AB-00000001
  Max Length
  100
  Pattern
  ^[a-zA-Z0-9_.:-]{1,100}$
- resultDataAccountValidationResultData
  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.
  - cxResultIconCodestring
    Example
    TICK
    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.
    Default
    TICK
    Max Length
    4
    Pattern
    ^(TICK|EXCM|CROS|DASH)$
  - cxResultMessagestring
    Example
    The account name matches the account details provided.
    Description
    Optional — Message for the result, already worded for the payer. Show it as supplied rather than composing your own text from resultCode.
    Default
    The account name matches the account details provided.
    Max Length
    255
    Pattern
    ^[ -~]{1,255}$
  - cxResultDisplayAccountNamestring
    Example
    Monoova Payments Pty Ltd
    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.
    Default
    Monoova Payments Pty Ltd
    Min Length
    2
    Max Length
    140
    Pattern
    ^[!-~][ -~]{0,138}[!-~]$
  - resultCodestring
    Example
    MTCH
    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).
    Default
    MTCH
    Max Length
    4
    Pattern
    ^(MTCH|CMTC|NMTC|NFND|CLSD)$
  - accountValidationUniqueIdstring
    Example
    AV-2026-0923-000185
    Description
    Optional — Account Validation Unique Id supplied in the request, echoed back so the result can be matched to your own record.
    Default
    AV-2026-0923-000185
    Max Length
    40
    Pattern
    ^[a-zA-Z0-9_-]{1,40}$
  - subMerchantIdstring
    Example
    SUBM-0001234
    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.
    Default
    SUBM-0001234
    Max Length
    36
    Pattern
    ^[a-zA-Z0-9_-]{1,36}$

400

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.

ErrorResponse
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.
- traceIdstring
  Example
  0HN7GQ2L4K9AB-00000003
  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.
  Default
  0HN7GQ2L4K9AB-00000003
  Max Length
  100
  Pattern
  ^[a-zA-Z0-9_.:-]{1,100}$
- errorsErrorDetail[]
  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.
  - errorCodestring
    Example
    PAY_BSB_INVALID
    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.
    Default
    PAY_BSB_INVALID
    Max Length
    80
    Pattern
    ^PAY_[A-Z0-9_]{1,76}$
  - errorMessagestring
    Example
    The field bsb must match the pattern ^[0-9]{3}-[0-9]{3}$.
    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.
    Default
    The field bsb must match the pattern ^[0-9]{3}-[0-9]{3}$.
    Max Length
    500
    Pattern
    ^[ -~]{1,500}$

401

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.

ErrorResponse
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.
- traceIdstring
  Example
  0HN7GQ2L4K9AB-00000003
  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.
  Default
  0HN7GQ2L4K9AB-00000003
  Max Length
  100
  Pattern
  ^[a-zA-Z0-9_.:-]{1,100}$
- errorsErrorDetail[]
  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.
  - errorCodestring
    Example
    PAY_BSB_INVALID
    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.
    Default
    PAY_BSB_INVALID
    Max Length
    80
    Pattern
    ^PAY_[A-Z0-9_]{1,76}$
  - errorMessagestring
    Example
    The field bsb must match the pattern ^[0-9]{3}-[0-9]{3}$.
    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.
    Default
    The field bsb must match the pattern ^[0-9]{3}-[0-9]{3}$.
    Max Length
    500
    Pattern
    ^[ -~]{1,500}$

403

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.

ErrorResponse
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.
- traceIdstring
  Example
  0HN7GQ2L4K9AB-00000003
  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.
  Default
  0HN7GQ2L4K9AB-00000003
  Max Length
  100
  Pattern
  ^[a-zA-Z0-9_.:-]{1,100}$
- errorsErrorDetail[]
  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.
  - errorCodestring
    Example
    PAY_BSB_INVALID
    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.
    Default
    PAY_BSB_INVALID
    Max Length
    80
    Pattern
    ^PAY_[A-Z0-9_]{1,76}$
  - errorMessagestring
    Example
    The field bsb must match the pattern ^[0-9]{3}-[0-9]{3}$.
    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.
    Default
    The field bsb must match the pattern ^[0-9]{3}-[0-9]{3}$.
    Max Length
    500
    Pattern
    ^[ -~]{1,500}$

404

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.

ErrorResponse
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.
- traceIdstring
  Example
  0HN7GQ2L4K9AB-00000003
  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.
  Default
  0HN7GQ2L4K9AB-00000003
  Max Length
  100
  Pattern
  ^[a-zA-Z0-9_.:-]{1,100}$
- errorsErrorDetail[]
  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.
  - errorCodestring
    Example
    PAY_BSB_INVALID
    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.
    Default
    PAY_BSB_INVALID
    Max Length
    80
    Pattern
    ^PAY_[A-Z0-9_]{1,76}$
  - errorMessagestring
    Example
    The field bsb must match the pattern ^[0-9]{3}-[0-9]{3}$.
    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.
    Default
    The field bsb must match the pattern ^[0-9]{3}-[0-9]{3}$.
    Max Length
    500
    Pattern
    ^[ -~]{1,500}$

500

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.

ErrorResponse
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.
- traceIdstring
  Example
  0HN7GQ2L4K9AB-00000003
  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.
  Default
  0HN7GQ2L4K9AB-00000003
  Max Length
  100
  Pattern
  ^[a-zA-Z0-9_.:-]{1,100}$
- errorsErrorDetail[]
  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.
  - errorCodestring
    Example
    PAY_BSB_INVALID
    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.
    Default
    PAY_BSB_INVALID
    Max Length
    80
    Pattern
    ^PAY_[A-Z0-9_]{1,76}$
  - errorMessagestring
    Example
    The field bsb must match the pattern ^[0-9]{3}-[0-9]{3}$.
    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.
    Default
    The field bsb must match the pattern ^[0-9]{3}-[0-9]{3}$.
    Max Length
    500
    Pattern
    ^[ -~]{1,500}$

502

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.

ErrorResponse
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.
- traceIdstring
  Example
  0HN7GQ2L4K9AB-00000003
  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.
  Default
  0HN7GQ2L4K9AB-00000003
  Max Length
  100
  Pattern
  ^[a-zA-Z0-9_.:-]{1,100}$
- errorsErrorDetail[]
  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.
  - errorCodestring
    Example
    PAY_BSB_INVALID
    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.
    Default
    PAY_BSB_INVALID
    Max Length
    80
    Pattern
    ^PAY_[A-Z0-9_]{1,76}$
  - errorMessagestring
    Example
    The field bsb must match the pattern ^[0-9]{3}-[0-9]{3}$.
    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.
    Default
    The field bsb must match the pattern ^[0-9]{3}-[0-9]{3}$.
    Max Length
    500
    Pattern
    ^[ -~]{1,500}$

504

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.

ErrorResponse
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.
- traceIdstring
  Example
  0HN7GQ2L4K9AB-00000003
  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.
  Default
  0HN7GQ2L4K9AB-00000003
  Max Length
  100
  Pattern
  ^[a-zA-Z0-9_.:-]{1,100}$
- errorsErrorDetail[]
  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.
  - errorCodestring
    Example
    PAY_BSB_INVALID
    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.
    Default
    PAY_BSB_INVALID
    Max Length
    80
    Pattern
    ^PAY_[A-Z0-9_]{1,76}$
  - errorMessagestring
    Example
    The field bsb must match the pattern ^[0-9]{3}-[0-9]{3}$.
    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.
    Default
    The field bsb must match the pattern ^[0-9]{3}-[0-9]{3}$.
    Max Length
    500
    Pattern
    ^[ -~]{1,500}$

curl

curl --request GET \
     --url https://sand-api.monoova.com/au/cop/payman-v2/AccountValidation/{id} \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://sand-api.monoova.com/au/cop/payman-v2/AccountValidation/{id}", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://sand-api.monoova.com/au/cop/payman-v2/AccountValidation/{id}")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://sand-api.monoova.com/au/cop/payman-v2/AccountValidation/{id}"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// 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.
{
  "traceId": "0HN7GQ2L4K9AB-00000001",
  "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"
  }
}

400

// 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.
{
  "traceId": "0HN7GQ2L4K9AB-00000003",
  "errors": [
    {
      "errorCode": "PAY_BSB_INVALID",
      "errorMessage": "The field bsb must match the pattern ^[0-9]{3}-[0-9]{3}$."
    }
  ]
}

401

// 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 &#x3C;token>. Do not retry with the same token.
{
  "traceId": "0HN7GQ2L4K9AB-00000003",
  "errors": [
    {
      "errorCode": "PAY_BSB_INVALID",
      "errorMessage": "The field bsb must match the pattern ^[0-9]{3}-[0-9]{3}$."
    }
  ]
}

403

// 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.
{
  "traceId": "0HN7GQ2L4K9AB-00000003",
  "errors": [
    {
      "errorCode": "PAY_BSB_INVALID",
      "errorMessage": "The field bsb must match the pattern ^[0-9]{3}-[0-9]{3}$."
    }
  ]
}

404

// 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.
{
  "traceId": "0HN7GQ2L4K9AB-00000003",
  "errors": [
    {
      "errorCode": "PAY_BSB_INVALID",
      "errorMessage": "The field bsb must match the pattern ^[0-9]{3}-[0-9]{3}$."
    }
  ]
}

500

// 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.
{
  "traceId": "0HN7GQ2L4K9AB-00000003",
  "errors": [
    {
      "errorCode": "PAY_BSB_INVALID",
      "errorMessage": "The field bsb must match the pattern ^[0-9]{3}-[0-9]{3}$."
    }
  ]
}

502

// 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.
{
  "traceId": "0HN7GQ2L4K9AB-00000003",
  "errors": [
    {
      "errorCode": "PAY_BSB_INVALID",
      "errorMessage": "The field bsb must match the pattern ^[0-9]{3}-[0-9]{3}$."
    }
  ]
}

504

// 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.
{
  "traceId": "0HN7GQ2L4K9AB-00000003",
  "errors": [
    {
      "errorCode": "PAY_BSB_INVALID",
      "errorMessage": "The field bsb must match the pattern ^[0-9]{3}-[0-9]{3}$."
    }
  ]
}