--- title: Get Verification Token Details slug: api/get-verification-token-details docTags: createdAt: 2026-09-15T06:22:27.331Z --- { "id": "MzbrqETKi5WXjJ_CpXptb", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://api.mpay.com.au/verify/v1/aba/get/{token}", "servers": [ { "url": "https://api.mpay.com.au/verify/v1/aba/get/{token}", "description": "Production URL" }, { "url": "https://api.m-pay.com.au/verify/v1/aba/get/{token}", "description": "Sandbox URL" } ], "name": "Get Verification Token Details", "description": "Return details for a specific verification token.", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "token", "type": "string", "example": "3f2504e0-4f89-11d3-9a0c-0305e82c3301", "description": "

Required. Generated Token from verify/v1/aba/initiate (Initiates a verification transaction).

", "default": "3f2504e0-4f89-11d3-9a0c-0305e82c3301", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "basicAuth", "name": "basicAuth", "kind": "optional", "type": "http", "description": "

To authenticate using basic authentication, generate an API key and pass it as the username. No password is required.

", "scheme": "basic" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Success. The verification token details were returned successfully.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "Response returned when the details of a single verification token are requested.", "customType": "verifyAccountGetResponse_V1", "schema": [ { "name": "details", "kind": "optional", "type": "object", "description": "

Required. A single bank account verification record, containing the account details, the verification status and the direct debit authority flags.

", "modelRef": "#/components/schemas/verifyAccountDetails", "customType": "verifyAccountDetails", "schema": [ { "name": "token", "kind": "optional", "type": "string", "description": "

Required. The text(GUID) that identifies the token.

", "example": "3f2504e0-4f89-11d3-9a0c-0305e82c3301", "default": "3f2504e0-4f89-11d3-9a0c-0305e82c3301", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, { "name": "created", "kind": "optional", "type": "string", "description": "

Required. Datetime that the request was created.

", "example": "2026-01-15T09:30:00+11:00", "default": "2026-01-15T09:30:00+11:00", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?([Zz]|[+-]\\d{2}:\\d{2})?$" }, { "name": "updated", "kind": "optional", "type": "string", "nullable": true, "description": "

Optional. Datetime that the direct debit authority flag was last updated. Returned as Null when the record has never been updated.

", "example": "2026-01-16T14:05:22+11:00", "default": "2026-01-16T14:05:22+11:00", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?([Zz]|[+-]\\d{2}:\\d{2})?$" }, { "name": "lastSystemBSBValidation", "kind": "optional", "type": "string", "nullable": true, "description": "

Optional. System bsb validation timestamp. Returned as Null when the BSB has not been validated by the Platform.

", "example": "2026-01-15T09:30:05+11:00", "default": "2026-01-15T09:30:05+11:00", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?([Zz]|[+-]\\d{2}:\\d{2})?$" }, { "name": "comment", "kind": "optional", "type": "string", "nullable": true, "description": "

Optional. Your comment submitted when initiating the verify request.

", "example": "Verification for new supplier onboarding", "default": "Verification for new supplier onboarding", "maxLength": 256, "pattern": "^.{0,256}$" }, { "name": "bsb", "kind": "optional", "type": "string", "description": "

Required. BSB number of associated bank account. BSB format is '000-000'.

", "example": "032-001", "default": "032-001", "pattern": "^\\d{3}-\\d{3}$" }, { "name": "bankAccountNumber", "kind": "optional", "type": "string", "description": "

Required. Account number of associated bank account.

", "example": "123456789", "default": "123456789", "pattern": "^\\d{5,10}$" }, { "name": "bankAccountTitle", "kind": "optional", "type": "string", "description": "

Required. Bank account title or name of associated bank account.

", "example": "Acme Pty Ltd", "default": "Acme Pty Ltd", "maxLength": 32, "pattern": "^[A-Za-z0-9 .,'&\\-\\/]{1,32}$" }, { "name": "remitter", "kind": "optional", "type": "string", "nullable": true, "description": "

Optional. The code contained in the remitter name field.

", "example": "ACME PTY LTD", "default": "ACME PTY LTD", "maxLength": 16, "pattern": "^[A-Za-z0-9 .,'&\\-]{0,16}$" }, { "name": "isBlacklisted", "kind": "optional", "type": "boolean", "description": "

Required. Blacklisted accounts cannot be transacted on.

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

Required. Flag that can be used to track which account you have direct debit authority for.

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

Optional. Datetime that the direct debit authority flag was last modified. Returned as Null when the flag has never been modified.

", "example": "2026-01-16T14:05:22+11:00", "default": "2026-01-16T14:05:22+11:00", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?([Zz]|[+-]\\d{2}:\\d{2})?$" }, { "name": "ddAuthorityChangedBy", "kind": "optional", "type": "string", "nullable": true, "description": "

Optional. The user that last modified the direct debit authority flag. Returned as Null when the flag has never been modified.

", "example": "operations@example.com", "default": "operations@example.com", "maxLength": 128, "pattern": "^.{0,128}$" }, { "name": "verificationIdentifier", "kind": "optional", "type": "string", "nullable": true, "description": "

Optional. Name of the verification token.

", "example": "SUPPLIER-ONBOARD-4821", "default": "SUPPLIER-ONBOARD-4821", "maxLength": 128, "pattern": "^.{0,128}$" }, { "name": "verificationStatus", "kind": "optional", "type": "string", "description": "

Required. Status of the verification token.

", "example": "Verified", "default": "Verified", "pattern": "^[A-Za-z]{1,32}$" }, { "name": "verificationSignonMerchant", "kind": "optional", "type": "string", "description": "

Required. mAccount which owns the verification token.

", "example": "4212345678", "default": "4212345678", "maxLength": 32, "pattern": "^[A-Za-z0-9\\-]{1,32}$" }, { "name": "verificationRetryCount", "kind": "optional", "type": "integer", "description": "

Required. Number of times verification has been retried.

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

Required. Threshold number of verification failures that triggers a lockout. Note the spelling of this field name is part of the API contract.

", "example": 3, "default": 3, "format": "int32", "minimum": 0, "pattern": "^[0-9]{1,10}$" }, { "name": "verificationLastRetryTimestamp", "kind": "optional", "type": "string", "nullable": true, "description": "

Optional. Last verification attempt datetime. Returned as Null when no retry has been attempted.

", "example": "2026-01-16T10:12:44+11:00", "default": "2026-01-16T10:12:44+11:00", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?([Zz]|[+-]\\d{2}:\\d{2})?$" }, { "name": "verificationLastRetryLockoutMinutes", "kind": "optional", "type": "integer", "description": "

Required. Lockout time after verification failure threshold has been reached.

", "example": 30, "default": 30, "format": "int32", "minimum": 0, "pattern": "^[0-9]{1,10}$" }, { "name": "verificationDEJobId", "kind": "optional", "type": "integer", "nullable": true, "description": "

Optional. DE Job ID for the verification transaction. Returned as Null when no direct entry job has been raised.

", "example": 884213, "default": 884213, "format": "int64", "minimum": 0, "pattern": "^[0-9]{1,19}$" }, { "name": "verificationRootId", "kind": "optional", "type": "integer", "description": "

Required. Unique verification root ID.

", "example": 55219, "default": 55219, "format": "int64", "minimum": 0, "pattern": "^[0-9]{1,19}$" } ] }, { "name": "durationMs", "kind": "optional", "type": "integer", "description": "

Required. This value represents the total time in milliseconds that the Platform took to process the request.

", "example": 58, "default": 58, "format": "int32", "minimum": 0, "pattern": "^[0-9]{1,10}$" }, { "name": "status", "kind": "optional", "type": "string", "description": "

Required. This is the status of the request. A code of 'Ok' indicates no errors.

", "example": "Ok", "default": "Ok", "pattern": "^[A-Za-z0-9]{1,32}$" }, { "name": "statusDescription", "kind": "optional", "type": "string", "description": "

Required. This is a description of the status. If an 'Ok' status is returned, then this will be 'Operation completed successfully'.

", "example": "Operation completed successfully", "default": "Operation completed successfully", "pattern": "^.{0,512}$" } ], "modelRef": "#/components/schemas/verifyAccountGetResponse_V1", "isExpanded": true } ] }, { "statusCode": "400", "description": "

Bad Request. The request could not be processed because one or more fields are missing, malformed, or failed validation. Check statusDescription for the specific field or rule that failed.

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"durationMs\":12,\"status\":\"Error\",\"statusDescription\":\"Validation failed: 'bsb' must be in the format '000-000'.\"}", "description": "Standard error envelope returned by every Account Verification endpoint.", "customType": "errorResponse", "schema": [ { "name": "durationMs", "kind": "optional", "type": "integer", "description": "

Required. This value represents the total time in milliseconds that the Platform took to process the request.

", "example": 12, "default": 12, "format": "int32", "minimum": 0, "pattern": "^[0-9]{1,10}$" }, { "name": "status", "kind": "optional", "type": "string", "description": "

Required. This is the status of the request. A code of 'Ok' indicates no errors. Any other code indicates that the request failed.

", "example": "Error", "default": "Error", "pattern": "^[A-Za-z0-9]{1,32}$" }, { "name": "statusDescription", "kind": "optional", "type": "string", "description": "

Required. This is a description of the status. When the request fails, this explains which field or rule caused the failure.

", "example": "Validation failed: 'bsb' must be in the format '000-000'.", "default": "Validation failed: 'bsb' must be in the format '000-000'.", "pattern": "^.{0,512}$" } ], "modelRef": "#/components/schemas/errorResponse", "isExpanded": true } ] }, { "statusCode": "401", "description": "

Unauthorized. The API key was missing, malformed, or is not valid for this environment. Pass your API key as the basic authentication username with no password.

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"durationMs\":4,\"status\":\"Unauthorized\",\"statusDescription\":\"Authentication failed. Supply a valid API key as the basic authentication username.\"}", "description": "Standard error envelope returned by every Account Verification endpoint.", "customType": "errorResponse", "schema": [ { "name": "durationMs", "kind": "optional", "type": "integer", "description": "

Required. This value represents the total time in milliseconds that the Platform took to process the request.

", "example": 12, "default": 12, "format": "int32", "minimum": 0, "pattern": "^[0-9]{1,10}$" }, { "name": "status", "kind": "optional", "type": "string", "description": "

Required. This is the status of the request. A code of 'Ok' indicates no errors. Any other code indicates that the request failed.

", "example": "Error", "default": "Error", "pattern": "^[A-Za-z0-9]{1,32}$" }, { "name": "statusDescription", "kind": "optional", "type": "string", "description": "

Required. This is a description of the status. When the request fails, this explains which field or rule caused the failure.

", "example": "Validation failed: 'bsb' must be in the format '000-000'.", "default": "Validation failed: 'bsb' must be in the format '000-000'.", "pattern": "^.{0,512}$" } ], "modelRef": "#/components/schemas/errorResponse", "isExpanded": true } ] }, { "statusCode": "500", "description": "Internal Server Error. An unexpected error occurred while processing the request. The request was not completed and can be safely retried.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"durationMs\":1503,\"status\":\"Error\",\"statusDescription\":\"An unexpected error occurred while processing the request. Please try again later.\"}", "description": "Standard error envelope returned by every Account Verification endpoint.", "customType": "errorResponse", "schema": [ { "name": "durationMs", "kind": "optional", "type": "integer", "description": "

Required. This value represents the total time in milliseconds that the Platform took to process the request.

", "example": 12, "default": 12, "format": "int32", "minimum": 0, "pattern": "^[0-9]{1,10}$" }, { "name": "status", "kind": "optional", "type": "string", "description": "

Required. This is the status of the request. A code of 'Ok' indicates no errors. Any other code indicates that the request failed.

", "example": "Error", "default": "Error", "pattern": "^[A-Za-z0-9]{1,32}$" }, { "name": "statusDescription", "kind": "optional", "type": "string", "description": "

Required. This is a description of the status. When the request fails, this explains which field or rule caused the failure.

", "example": "Validation failed: 'bsb' must be in the format '000-000'.", "default": "Validation failed: 'bsb' must be in the format '000-000'.", "pattern": "^.{0,512}$" } ], "modelRef": "#/components/schemas/errorResponse", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "gYO87H_yLQeJcZXtcwlGt", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://api.mpay.com.au/verify/v1/aba/get/{token} \\\n --header 'accept: application/json'" }, { "id": "ybPZixF4ZDuBelT2bKf-t", "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://api.mpay.com.au/verify/v1/aba/get/{token}\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "9QCin_2XFzgjJ_Dfqhz8F", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.mpay.com.au/verify/v1/aba/get/{token}\")\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": "UYDifAmWfWoknrEBcFUzW", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.mpay.com.au/verify/v1/aba/get/{token}\"\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": "gYO87H_yLQeJcZXtcwlGt" }, "results": { "languages": [ { "id": "bKI1gb80QkAvdNZoHV83s", "language": "200", "code": "// Success. The verification token details were returned successfully.\n{\n \"details\": {\n \"token\": \"3f2504e0-4f89-11d3-9a0c-0305e82c3301\",\n \"created\": \"2026-01-15T09:30:00+11:00\",\n \"updated\": \"2026-01-16T14:05:22+11:00\",\n \"lastSystemBSBValidation\": \"2026-01-15T09:30:05+11:00\",\n \"comment\": \"Verification for new supplier onboarding\",\n \"bsb\": \"032-001\",\n \"bankAccountNumber\": \"123456789\",\n \"bankAccountTitle\": \"Acme Pty Ltd\",\n \"remitter\": \"ACME PTY LTD\",\n \"isBlacklisted\": false,\n \"hasDDAuthority\": true,\n \"ddAuthorityChangedTimestamp\": \"2026-01-16T14:05:22+11:00\",\n \"ddAuthorityChangedBy\": \"operations@example.com\",\n \"verificationIdentifier\": \"SUPPLIER-ONBOARD-4821\",\n \"verificationStatus\": \"Verified\",\n \"verificationSignonMerchant\": \"4212345678\",\n \"verificationRetryCount\": 1,\n \"verificationRetyCountBeforeLockout\": 3,\n \"verificationLastRetryTimestamp\": \"2026-01-16T10:12:44+11:00\",\n \"verificationLastRetryLockoutMinutes\": 30,\n \"verificationDEJobId\": 884213,\n \"verificationRootId\": 55219\n },\n \"durationMs\": 58,\n \"status\": \"Ok\",\n \"statusDescription\": \"Operation completed successfully\"\n}" }, { "id": "ZHSy8GOI0Wv_DHKJ7_o12", "language": "400", "code": "// Bad Request. The request could not be processed because one or more fields are missing, malformed, or failed validation. Check statusDescription for the specific field or rule that failed.\n{\n \"durationMs\": 12,\n \"status\": \"Error\",\n \"statusDescription\": \"Validation failed: 'bsb' must be in the format '000-000'.\"\n}" }, { "id": "cbvm2lzNLRdu_QkH3Cs-V", "language": "401", "code": "// Unauthorized. The API key was missing, malformed, or is not valid for this environment. Pass your API key as the basic authentication username with no password.\n{\n \"durationMs\": 12,\n \"status\": \"Error\",\n \"statusDescription\": \"Validation failed: 'bsb' must be in the format '000-000'.\"\n}" }, { "id": "AMN2myjZK327Cv4JvQYVc", "language": "500", "code": "// Internal Server Error. An unexpected error occurred while processing the request. The request was not completed and can be safely retried.\n{\n \"durationMs\": 12,\n \"status\": \"Error\",\n \"statusDescription\": \"Validation failed: 'bsb' must be in the format '000-000'.\"\n}" } ], "selectedLanguageId": "bKI1gb80QkAvdNZoHV83s" } }, "children": [ { "text": "" } ] }