Updates an existing verification record. The request payload for this operation is not defined in the source specification - confirm the payload with the API team before publishing.
", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [], "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 record was updated successfully.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "Response returned when a verification record is updated.", "customType": "verifyAccountUpdateResponse_V1", "schema": [ { "name": "durationMs", "kind": "optional", "type": "integerRequired. This value represents the total time in milliseconds that the Platform took to process the request.
", "example": 61, "default": 61, "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/verifyAccountUpdateResponse_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.
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": "integerRequired. 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": "integerRequired. 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": "RxD5q5lKv-LlgYbtMlrvs", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://api.mpay.com.au/verify/v1/aba/update \\\n --header 'accept: application/json'" }, { "id": "Nbq-I3L5v3YnN2qzKlfsS", "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: 'POST',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.mpay.com.au/verify/v1/aba/update\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "0Hy4WdGXRWbNHzYHbb2Hi", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.mpay.com.au/verify/v1/aba/update\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "SINugajSXJvx1JACeBx2n", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.mpay.com.au/verify/v1/aba/update\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "RxD5q5lKv-LlgYbtMlrvs" }, "results": { "languages": [ { "id": "response-0-200", "language": "200", "code": "// Success. The verification record was updated successfully.\n{\n \"durationMs\": 61,\n \"status\": \"Ok\",\n \"statusDescription\": \"Operation completed successfully\"\n}" }, { "id": "response-1-400", "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": "response-2-401", "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": "response-3-500", "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": "response-0-200" } }, "children": [ { "text": "" } ] }