--- title: Retail authorization update slug: public-apis/retail-authorization-update createdAt: 2026-08-28T21:38:58.682Z --- { "id": "JyOI_gAQ2pizk_HYBJ0yY", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://api.accertify.net/api/v1/unified-risk/retail/authorizationUpdate", "name": "Retail authorization update", "description": "

Reports the authorization result and optional 3DS/SCA details for a previously scored transaction's payment methods.

", "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": [ { "kind": "required", "name": "authorizationUpdate", "type": "object", "example": "{\"transactionID\":\"ABC123456\",\"authStatus\":true,\"paymentMethods\":[{\"paymentType\":\"creditCard\",\"paymentMethodID\":\"2ljr9vxsdfew\",\"avsResult\":\"matched\",\"cvvResult\":\"matched\",\"cardAuthorizationCode\":\"A1B2C3\",\"cardAuthorizationDateTime\":\"2022-03-11T17:07:25-07:00\",\"totalFailedAttempts\":0,\"sca3DSFlow\":\"frictionless\",\"sca3DSVersion\":\"2.2.0\",\"eciIndicator\":\"successful\",\"isSCASoftDecline\":false,\"sca3DSChallengeRequestType\":\"02\",\"sca3DSTransactionStatus\":\"Y\",\"scaAuthorizationStatus\":\"approve\"}]}", "description": "", "schema": [ { "name": "transactionID", "kind": "required", "type": "string", "description": "

[Required] Unique transaction identifier (max 40 chars).

", "example": "ABC123456" }, { "name": "authStatus", "kind": "required", "type": "boolean", "description": "

[Required] Whether the authorization was approved.

", "example": true }, { "name": "paymentMethods", "kind": "optional", "type": "array", "description": "", "example": "[{\"paymentType\":\"creditCard\",\"paymentMethodID\":\"2ljr9vxsdfew\",\"avsResult\":\"matched\",\"cvvResult\":\"matched\",\"cardAuthorizationCode\":\"A1B2C3\",\"cardAuthorizationDateTime\":\"2022-03-11T17:07:25-07:00\",\"totalFailedAttempts\":0,\"sca3DSFlow\":\"frictionless\",\"sca3DSVersion\":\"2.2.0\",\"eciIndicator\":\"successful\",\"isSCASoftDecline\":false,\"sca3DSChallengeRequestType\":\"02\",\"sca3DSTransactionStatus\":\"Y\",\"scaAuthorizationStatus\":\"approve\"}]", "itemType": "object", "customType": "object[]", "schema": [ { "name": "paymentType", "kind": "optional", "type": "string", "description": "

[Optional] Type of payment instrument.

", "example": "creditCard", "enum": [ "bankAccount", "cash", "check", "creditCard", "cryptoCurrency", "digitalWallet", "electronicFundTransfer", "giftCard", "invoice", "loan", "loyaltyPoints", "moneyOrder", "secCard", "storeCredit", "thirdParty", "voucher" ] }, { "name": "paymentMethodID", "kind": "optional", "type": "string", "description": "

[Optional] Merchant-assigned identifier for the payment method; used as the detail match key.

", "example": "2ljr9vxsdfew" }, { "name": "avsResult", "kind": "optional", "type": "string", "description": "

[Optional] Address Verification Service result.

", "example": "matched", "enum": [ "matched", "partialMatch", "notMatched", "notChecked", "systemError", "other" ] }, { "name": "cvvResult", "kind": "optional", "type": "string", "description": "

[Optional] Card Verification Value result.

", "example": "matched", "enum": [ "matched", "notMatched" ] }, { "name": "cardAuthorizationCode", "kind": "optional", "type": "string", "description": "

[Optional] Authorization approval code returned by the card network.

", "example": "A1B2C3" }, { "name": "cardAuthorizationDateTime", "kind": "optional", "type": "string", "description": "

[Optional] ISO 8601 timestamp of when the authorization was issued.

", "example": "2022-03-11T17:07:25-07:00", "format": "date-time" }, { "name": "postAuthorizationRejectReason", "kind": "optional", "type": "string", "description": "

[Optional] Reason for authorization rejection.

", "example": "creditReject", "enum": [ "creditReject", "fraudReject", "otherReject" ] }, { "name": "totalFailedAttempts", "kind": "optional", "type": "integer", "description": "

[Optional] Number of failed authorization attempts for this payment method.

", "example": 0, "minimum": 0 }, { "name": "eciIndicator", "kind": "optional", "type": "string", "description": "

[Conditional] E-Commerce Indicator from the 3DS process; required when sca3DSFlow is present.

", "example": "successful", "enum": [ "successful", "unsuccessfulOrNotAttempted", "attemptedButNotCompleted", "other" ] }, { "name": "isSCASoftDecline", "kind": "optional", "type": "boolean", "description": "

[Conditional] Whether the authorization received a soft decline requiring SCA; required when sca3DSFlow is present.

", "example": false }, { "name": "sca3DSFlow", "kind": "optional", "type": "string", "description": "

[Optional] 3DS authentication flow that was applied.

", "example": "frictionless", "enum": [ "challenge", "frictionless", "dataOnly" ] }, { "name": "sca3DSVersion", "kind": "optional", "type": "string", "description": "

[Conditional] 3DS protocol version used; required when sca3DSFlow is present.

", "example": "2.2.0" }, { "name": "sca3DSChallengeRequestType", "kind": "optional", "type": "string<02 | 03 | 04 | 05 | 06 | 10 | 11>", "description": "

[Conditional] Type of 3DS challenge initiated; required when sca3DSFlow is present.

", "example": "02", "enum": [ "02", "03", "04", "05", "06", "10", "11" ] }, { "name": "sca3DSTransactionStatus", "kind": "optional", "type": "string", "description": "

[Conditional] 3DS transaction status returned by the issuer; required when sca3DSFlow is present.

", "example": "Y", "enum": [ "Y", "N", "U", "A", "I" ] }, { "name": "scaAuthorizationStatus", "kind": "optional", "type": "string", "description": "

[Conditional] SCA authorization outcome; required when sca3DSFlow is present.

", "example": "approve", "enum": [ "approve", "decline" ] }, { "name": "scaAuthorizationError", "kind": "optional", "type": "string", "description": "

[Conditional] Reason for a declined SCA authorization; required when scaAuthorizationStatus is decline.

", "example": "decline", "enum": [ "decline", "fraudReject", "insufficientFunds", "invalidCard", "incorrectInformation", "lostOrStolen", "withdrawalAmountExceeded", "technicalError", "other" ] } ] } ], "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "oauthBearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

OAuth 2.0 Bearer token, e.g. 'Bearer '.

", "in": "header" } ] }, "responses": [ { "statusCode": "200", "description": "Successful response.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "Successful response.", "customType": "notScoredResult", "schema": [ { "name": "eventID", "kind": "optional", "type": "string", "description": "" }, { "name": "messages", "kind": "optional", "type": "object", "description": "", "modelRef": "#/definitions/apiMessages", "customType": "apiMessages", "schema": [ { "name": "error", "kind": "optional", "type": "array", "description": "", "modelRef": "#/definitions/apiMessage", "customType": "apiMessage[]", "schema": [ { "name": "code", "kind": "required", "type": "string", "description": "

Machine-readable message code

", "example": "FIELD_REQUIRED_MISSING" }, { "name": "message", "kind": "required", "type": "string", "description": "

Human-readable message

", "example": "transactionID is required and was not provided" }, { "name": "field", "kind": "optional", "type": "string", "description": "Name of the field this message applies to", "example": "transactionID" }, { "name": "details", "kind": "optional", "type": "map", "description": "Structured detail keys.", "example": "", "customType": "map", "schema": [] } ] }, { "name": "warning", "kind": "optional", "type": "array", "description": "", "modelRef": "#/definitions/apiMessage", "customType": "apiMessage[]", "schema": [ { "name": "code", "kind": "required", "type": "string", "description": "

Machine-readable message code

", "example": "FIELD_REQUIRED_MISSING" }, { "name": "message", "kind": "required", "type": "string", "description": "

Human-readable message

", "example": "transactionID is required and was not provided" }, { "name": "field", "kind": "optional", "type": "string", "description": "Name of the field this message applies to", "example": "transactionID" }, { "name": "details", "kind": "optional", "type": "map", "description": "Structured detail keys.", "example": "", "customType": "map", "schema": [] } ] }, { "name": "info", "kind": "optional", "type": "array", "description": "", "modelRef": "#/definitions/apiMessage", "customType": "apiMessage[]", "schema": [ { "name": "code", "kind": "required", "type": "string", "description": "

Machine-readable message code

", "example": "FIELD_REQUIRED_MISSING" }, { "name": "message", "kind": "required", "type": "string", "description": "

Human-readable message

", "example": "transactionID is required and was not provided" }, { "name": "field", "kind": "optional", "type": "string", "description": "Name of the field this message applies to", "example": "transactionID" }, { "name": "details", "kind": "optional", "type": "map", "description": "Structured detail keys.", "example": "", "customType": "map", "schema": [] } ] } ] }, { "name": "status", "kind": "required", "type": "boolean", "description": "true when there are no errors" } ], "modelRef": "#/definitions/notScoredResult", "isExpanded": true } ] }, { "statusCode": "400", "description": "Error response for invalid or missing request inputs. Returned when one or more required fields are absent or fail validation.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "Error response for invalid or missing request inputs. Returned when one or more required fields are absent or fail validation.", "customType": "validationFailedError", "schema": [ { "name": "errorCode", "kind": "optional", "type": "integer", "description": "HTTP status code for the validation error.", "example": 400 }, { "name": "errorMessage", "kind": "optional", "type": "string", "description": "

Human-readable summary of the validation error.

", "example": "Validation Failed" }, { "name": "errors", "kind": "optional", "type": "array", "description": "Validation error details for the request.", "example": "[\"Missing required field: transactionID\"]", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" } ], "modelRef": "#/definitions/validationFailedError", "isExpanded": true } ] }, { "statusCode": "401", "description": "Error response for authentication or authorization failures. Returned when credentials are invalid or the authenticated user has no matching API configuration for this endpoint.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "Error response for authentication or authorization failures. Returned when credentials are invalid or the authenticated user has no matching API configuration for this endpoint.", "customType": "notAuthorizedError", "schema": [ { "name": "errorCode", "kind": "optional", "type": "integer", "description": "HTTP status code for the authentication or authorization error.", "example": 401 }, { "name": "errorMessage", "kind": "optional", "type": "string", "description": "

Human-readable summary of the authentication or authorization error.

", "example": "Not Authorized" } ], "modelRef": "#/definitions/notAuthorizedError", "isExpanded": true } ] }, { "statusCode": "429", "description": "Error response when the request rate limit has been exceeded for the API user or API configuration.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "Error response when the request rate limit has been exceeded for the API user or API configuration.", "customType": "rateLimitError", "schema": [ { "name": "errorCode", "kind": "optional", "type": "integer", "description": "

HTTP status code for the rate-limit error.

", "example": 429 }, { "name": "errorMessage", "kind": "optional", "type": "string", "description": "

Human-readable summary of the rate-limit error.

", "example": "Rate Limit Exceeded" } ], "modelRef": "#/definitions/rateLimitError", "isExpanded": true } ] }, { "statusCode": "500", "description": "Error response when the request cannot be processed due to an unexpected internal error.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "Error response when the request cannot be processed due to an unexpected internal error.", "customType": "internalServerError", "schema": [ { "name": "errorCode", "kind": "optional", "type": "integer", "description": "HTTP status code for the internal server error.", "example": 500 }, { "name": "errorMessage", "kind": "optional", "type": "string", "description": "

Human-readable summary of the internal server error.

", "example": "Internal Server Error" } ], "modelRef": "#/definitions/internalServerError", "isExpanded": true } ] } ], "examples": { "languages": [ { "id": "example-0-curl", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://api.accertify.net/api/v1/unified-risk/retail/authorizationUpdate \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data '{\n \"transactionID\": \"ABC123456\",\n \"authStatus\": true\n }'" }, { "id": "example-1-javascript", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar raw = JSON.stringify({\n \"transactionID\": \"ABC123456\",\n \"authStatus\": true\n});\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://api.accertify.net/api/v1/unified-risk/retail/authorizationUpdate\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "example-2-ruby", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.accertify.net/api/v1/unified-risk/retail/authorizationUpdate\")\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\"\nrequest.body = JSON.dump({\n \"transactionID\": \"ABC123456\",\n \"authStatus\": true\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "example-3-python", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.accertify.net/api/v1/unified-risk/retail/authorizationUpdate\"\n\npayload = json.dumps({\n \"transactionID\": \"ABC123456\",\n \"authStatus\": True\n})\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": "example-0-curl" }, "results": { "languages": [ { "id": "response-0-200", "language": "200", "code": "// Successful response.\n{\n \"eventID\": \"\",\n \"messages\": {\n \"error\": [\n {\n \"code\": \"FIELD_REQUIRED_MISSING\",\n \"message\": \"transactionID is required and was not provided\",\n \"field\": \"transactionID\",\n \"details\": \"\"\n }\n ],\n \"warning\": [\n {\n \"code\": \"FIELD_REQUIRED_MISSING\",\n \"message\": \"transactionID is required and was not provided\",\n \"field\": \"transactionID\",\n \"details\": \"\"\n }\n ],\n \"info\": [\n {\n \"code\": \"FIELD_REQUIRED_MISSING\",\n \"message\": \"transactionID is required and was not provided\",\n \"field\": \"transactionID\",\n \"details\": \"\"\n }\n ]\n },\n \"status\": false\n}" }, { "id": "response-1-400", "language": "400", "code": "// Error response for invalid or missing request inputs. Returned when one or more required fields are absent or fail validation.\n{\n \"errorCode\": 400,\n \"errorMessage\": \"Validation Failed\",\n \"errors\": [\n \"\"\n ]\n}" }, { "id": "response-2-401", "language": "401", "code": "// Error response for authentication or authorization failures. Returned when credentials are invalid or the authenticated user has no matching API configuration for this endpoint.\n{\n \"errorCode\": 401,\n \"errorMessage\": \"Not Authorized\"\n}" }, { "id": "response-3-429", "language": "429", "code": "// Error response when the request rate limit has been exceeded for the API user or API configuration.\n{\n \"errorCode\": 429,\n \"errorMessage\": \"Rate Limit Exceeded\"\n}" }, { "id": "response-4-500", "language": "500", "code": "// Error response when the request cannot be processed due to an unexpected internal error.\n{\n \"errorCode\": 500,\n \"errorMessage\": \"Internal Server Error\"\n}" } ], "selectedLanguageId": "response-0-200" } }, "children": [ { "text": "" } ] }