{"_id":"5632a5ea49e16d0d001224a0","__v":0,"project":"55b933b3146ef121002158d3","user":"55b932ba8fd1a02b00f496c8","githubsync":"","version":{"_id":"5632a5e549e16d0d00122443","__v":6,"project":"55b933b3146ef121002158d3","createdAt":"2015-10-29T23:04:05.701Z","releaseDate":"2015-10-29T23:04:05.701Z","categories":["5632a5e749e16d0d00122444","5632a5e749e16d0d00122445","5632a5e749e16d0d00122446","5632a5e749e16d0d00122447","5632a5e749e16d0d00122448","5632a5e749e16d0d00122449","5632a5e749e16d0d0012244a","5632a5e749e16d0d0012244b","5632a5e749e16d0d0012244c","5632a5e749e16d0d0012244d","5632a5e749e16d0d0012244e","5632a5e749e16d0d0012244f","5632a5e749e16d0d00122450","5632b179df556c0d00cd095b","564e13053b2b4a19000cd69b","59caa9df65accc001a489c95","59cab50965accc001a489d28","59cadd464ab7b70024378e74"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.1.0","version":"1.1"},"category":{"_id":"5632a5e749e16d0d0012244d","__v":1,"pages":["5632a5ea49e16d0d00122481","5632a5ea49e16d0d00122482","5632a5ea49e16d0d00122483","5632a5ea49e16d0d00122484","5632a5ea49e16d0d00122485","5632a5ea49e16d0d00122486","5632a5ea49e16d0d00122487","5632a5ea49e16d0d00122488","5632a5ea49e16d0d00122489","5632a5ea49e16d0d0012248a","5632a5ea49e16d0d0012248b","5632a5ea49e16d0d0012248c","5632a5ea49e16d0d0012248d","5632a5ea49e16d0d0012248e","5632a5ea49e16d0d0012248f","5632a5ea49e16d0d00122490","5632a5ea49e16d0d00122491","5632a5ea49e16d0d00122492","5632a5ea49e16d0d00122493","5632a5ea49e16d0d00122494","5632a5ea49e16d0d00122495","5632a5ea49e16d0d00122496","5632a5ea49e16d0d00122497","5632a5ea49e16d0d00122498","5632a5ea49e16d0d00122499","5632a5ea49e16d0d0012249a","5632a5ea49e16d0d0012249b","5632a5ea49e16d0d0012249c","5632a5ea49e16d0d0012249d","5632a5ea49e16d0d0012249e","5632a5ea49e16d0d0012249f","5632a5ea49e16d0d001224a0","5632a5ea49e16d0d001224a1","5632a5ea49e16d0d001224a2","5632a5ea49e16d0d001224a3","5632a5ea49e16d0d001224a4","5632a5ea49e16d0d001224a5","5632a5ea49e16d0d001224a6","5632a5ea49e16d0d001224a7"],"project":"55b933b3146ef121002158d3","version":"5632a5e549e16d0d00122443","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-08-04T17:34:02.800Z","from_sync":false,"order":12,"slug":"objects","title":"Objects"},"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-04T17:58:54.775Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":30,"body":"Contains details on the result of a processed transaction.\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Description\"\n}\n[/block]\nThis object contains the results which are displayed upon successful completion of a given transaction. Includes transaction result (approved, declined, error) and authorization codes and details.\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Properties\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Type\",\n    \"h-1\": \"Name\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"integer\",\n    \"0-1\": \"RefNum\",\n    \"0-2\": \"Transaction Reference Number\",\n    \"1-0\": \"integer\",\n    \"1-1\": \"BatchRefNum\",\n    \"1-2\": \"Batch Reference Number assigned by Gateway.\",\n    \"2-0\": \"integer\",\n    \"2-1\": \"BatchNum\",\n    \"2-2\": \"Batch Sequence Number\",\n    \"3-0\": \"string\",\n    \"3-1\": \"Result\",\n    \"3-2\": \"Transaction Result (Approved, Declined, Error, etc)\",\n    \"4-0\": \"string\",\n    \"4-1\": \"ResultCode\",\n    \"4-2\": \"Single character result code (A, D, or E)\",\n    \"5-0\": \"string\",\n    \"5-1\": \"AuthCode\",\n    \"5-2\": \"Authorization Code\",\n    \"6-0\": \"double\",\n    \"6-1\": \"AuthAmount\",\n    \"6-2\": \"Amount that was authorized. Could be less that Amount requested if AllowPartialAuth was true (see Partial Authorizations)\",\n    \"7-0\": \"double\",\n    \"7-1\": \"RemainingBalance\",\n    \"7-2\": \"Returns the balance remaining on some prepaid and stored value cards\",\n    \"8-0\": \"string\",\n    \"8-1\": \"AvsResultCode\",\n    \"8-2\": \"AVS Result Code (1-3 characters)\",\n    \"9-0\": \"string\",\n    \"9-1\": \"AvsResult\",\n    \"9-2\": \"Text Description of AvsResultCode\",\n    \"10-0\": \"string\",\n    \"10-1\": \"CardCodeResultCode\",\n    \"10-2\": \"Card Code (CVV2) Verification Result Code (1 character)\",\n    \"11-0\": \"string\",\n    \"11-1\": \"CardCodeResult\",\n    \"11-2\": \"Text Description of Card Code Result\",\n    \"12-0\": \"string\",\n    \"12-1\": \"CardLevelResultCode\",\n    \"13-0\": \"string\",\n    \"13-1\": \"CardLevelResult\",\n    \"13-2\": \"Text Description of Card Level Result\",\n    \"14-0\": \"integer\",\n    \"14-1\": \"ErrorCode\",\n    \"14-2\": \"Error Code (if transaction resulted in error)\",\n    \"15-0\": \"integer\",\n    \"15-1\": \"CustNum\",\n    \"15-2\": \"System assigned CustNum of stored customer record if one was used or created\",\n    \"16-0\": \"string\",\n    \"16-1\": \"Error\",\n    \"16-2\": \"Text Description of Error Code\",\n    \"17-0\": \"string\",\n    \"17-1\": \"AcsUrl\",\n    \"17-2\": \"ACS Url for Verified by Visa or Mastercard Secure Code.\",\n    \"18-0\": \"string\",\n    \"18-1\": \"Payload\",\n    \"18-2\": \"Payload for Verified by Visa or Mastercard Secure Code.\",\n    \"19-0\": \"string\",\n    \"19-1\": \"VpasResultCode\",\n    \"19-2\": \"Vpas Result Code.\",\n    \"20-0\": \"boolean\",\n    \"20-1\": \"isDuplicate\",\n    \"20-2\": \"If true, a duplicate transaction was detected and the response data returned is from original transaction.\",\n    \"21-0\": \"double\",\n    \"21-1\": \"ConvertedAmount\",\n    \"21-2\": \"Transaction amount converted to new currency.\",\n    \"22-0\": \"string\",\n    \"22-1\": \"ConvertedAmountCurrency\",\n    \"22-2\": \"Currency code for new currency.\",\n    \"23-0\": \"double\",\n    \"23-1\": \"ConversionRate\",\n    \"23-2\": \"Rate used to convert transaction amount.\",\n    \"24-0\": \"string\",\n    \"24-1\": \"Status\",\n    \"24-2\": \"Description of transaction status\",\n    \"25-0\": \"string\",\n    \"25-1\": \"StatusCode\",\n    \"25-2\": \"Single character code for transaction status\",\n    \"26-0\": \"string\",\n    \"26-1\": \"ProfilerScore\",\n    \"26-2\": \"Score generated by fraud profiler.\",\n    \"27-0\": \"string\",\n    \"27-1\": \"ProfilerResponse\",\n    \"27-2\": \"Fraud profiler result: pass, warn, review. Based on score thresholds\",\n    \"28-0\": \"string\",\n    \"28-1\": \"ProfilerReason\",\n    \"28-2\": \"Comma separated list of reason codes that contributed to the score.\"\n  },\n  \"cols\": 3,\n  \"rows\": 29\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Examples\"\n}\n[/block]\n## Visual Basic (.Net) \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"eBizCharge.TransactionResponse response = new eBizCharge.TransactionResponse();\\ntry\\n{\\n   response = client.runTransaction(token, tran);\\n   if (response.ResultCode == \\\"A\\\")\\n   {\\n       MessageBox.Show(string.Concat(\\\"Transaction Approved, RefNum: \\\",\\n               response.RefNum));\\n   }\\n   else\\n   {\\n       MessageBox.Show(string.Concat(\\\"Transaction Failed: \\\",\\n               response.Error));\\n   }\",\n      \"language\": \"asp\"\n    }\n  ]\n}\n[/block]\n## C Sharp (.Net)\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"eBizCharge.TransactionResponse response = new eBizCharge.TransactionResponse();\\ntry\\n{\\n   response = client.runTransaction(token, tran);\\n   if (response.ResultCode == \\\"A\\\")\\n   {\\n       MessageBox.Show(string.Concat(\\\"Transaction Approved, RefNum: \\\",\\n               response.RefNum));\\n   }\\n   else\\n   {\\n       MessageBox.Show(string.Concat(\\\"Transaction Failed: \\\",\\n               response.Error));\\n   }\\n}\",\n      \"language\": \"csharp\"\n    }\n  ]\n}\n[/block]\n## XML \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<Response xsi:type=\\\"ns1:TransactionResponse\\\">\\n       <AcsUrl xsi:nil=\\\"true\\\"/>\\n       <AuthCode xsi:type=\\\"xsd:string\\\">021730</AuthCode>\\n       <AvsResult xsi:type=\\\"xsd:string\\\">Address: Match &amp; 5 Digit Zip: Match</AvsResult>\\n       <AvsResultCode xsi:type=\\\"xsd:string\\\">YYY</AvsResultCode>\\n       <BatchRefNum xsi:type=\\\"xsd:integer\\\">445979</BatchRefNum>\\n       <BatchNum xsi:type=\\\"xsd:integer\\\">979</BatchNum>\\n       <CardCodeResult xsi:type=\\\"xsd:string\\\">Not Processed</CardCodeResult>\\n       <CardCodeResultCode xsi:type=\\\"xsd:string\\\">P</CardCodeResultCode>\\n       <ConversionRate xsi:type=\\\"xsd:double\\\">0</ConversionRate>\\n       <ConvertedAmount xsi:type=\\\"xsd:double\\\">0</ConvertedAmount>\\n       <ConvertedAmountCurrency xsi:type=\\\"xsd:string\\\">0</ConvertedAmountCurrency>\\n       <CustNum xsi:type=\\\"xsd:integer\\\">0</CustNum>\\n       <Error xsi:type=\\\"xsd:string\\\">Approved</Error>\\n       <ErrorCode xsi:type=\\\"xsd:integer\\\">0</ErrorCode>\\n       <isDuplicate xsi:type=\\\"xsd:boolean\\\">false</isDuplicate>\\n       <Payload xsi:nil=\\\"true\\\"/>\\n       <RefNum xsi:type=\\\"xsd:integer\\\">1175354</RefNum>\\n       <Result xsi:type=\\\"xsd:string\\\">Approved</Result>\\n       <ResultCode xsi:type=\\\"xsd:string\\\">A</ResultCode>\\n       <Status xsi:type=\\\"xsd:string\\\">Pending</Status>\\n       <StatusCode xsi:type=\\\"xsd:string\\\">P</StatusCode>\\n       <VpasResultCode xsi:nil=\\\"true\\\"/>\\n</Response>\",\n      \"language\": \"xml\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"transactionresponse","type":"basic","title":"TransactionResponse"}

TransactionResponse


Contains details on the result of a processed transaction. [block:api-header] { "type": "basic", "title": "Description" } [/block] This object contains the results which are displayed upon successful completion of a given transaction. Includes transaction result (approved, declined, error) and authorization codes and details. [block:api-header] { "type": "basic", "title": "Properties" } [/block] [block:parameters] { "data": { "h-0": "Type", "h-1": "Name", "h-2": "Description", "0-0": "integer", "0-1": "RefNum", "0-2": "Transaction Reference Number", "1-0": "integer", "1-1": "BatchRefNum", "1-2": "Batch Reference Number assigned by Gateway.", "2-0": "integer", "2-1": "BatchNum", "2-2": "Batch Sequence Number", "3-0": "string", "3-1": "Result", "3-2": "Transaction Result (Approved, Declined, Error, etc)", "4-0": "string", "4-1": "ResultCode", "4-2": "Single character result code (A, D, or E)", "5-0": "string", "5-1": "AuthCode", "5-2": "Authorization Code", "6-0": "double", "6-1": "AuthAmount", "6-2": "Amount that was authorized. Could be less that Amount requested if AllowPartialAuth was true (see Partial Authorizations)", "7-0": "double", "7-1": "RemainingBalance", "7-2": "Returns the balance remaining on some prepaid and stored value cards", "8-0": "string", "8-1": "AvsResultCode", "8-2": "AVS Result Code (1-3 characters)", "9-0": "string", "9-1": "AvsResult", "9-2": "Text Description of AvsResultCode", "10-0": "string", "10-1": "CardCodeResultCode", "10-2": "Card Code (CVV2) Verification Result Code (1 character)", "11-0": "string", "11-1": "CardCodeResult", "11-2": "Text Description of Card Code Result", "12-0": "string", "12-1": "CardLevelResultCode", "13-0": "string", "13-1": "CardLevelResult", "13-2": "Text Description of Card Level Result", "14-0": "integer", "14-1": "ErrorCode", "14-2": "Error Code (if transaction resulted in error)", "15-0": "integer", "15-1": "CustNum", "15-2": "System assigned CustNum of stored customer record if one was used or created", "16-0": "string", "16-1": "Error", "16-2": "Text Description of Error Code", "17-0": "string", "17-1": "AcsUrl", "17-2": "ACS Url for Verified by Visa or Mastercard Secure Code.", "18-0": "string", "18-1": "Payload", "18-2": "Payload for Verified by Visa or Mastercard Secure Code.", "19-0": "string", "19-1": "VpasResultCode", "19-2": "Vpas Result Code.", "20-0": "boolean", "20-1": "isDuplicate", "20-2": "If true, a duplicate transaction was detected and the response data returned is from original transaction.", "21-0": "double", "21-1": "ConvertedAmount", "21-2": "Transaction amount converted to new currency.", "22-0": "string", "22-1": "ConvertedAmountCurrency", "22-2": "Currency code for new currency.", "23-0": "double", "23-1": "ConversionRate", "23-2": "Rate used to convert transaction amount.", "24-0": "string", "24-1": "Status", "24-2": "Description of transaction status", "25-0": "string", "25-1": "StatusCode", "25-2": "Single character code for transaction status", "26-0": "string", "26-1": "ProfilerScore", "26-2": "Score generated by fraud profiler.", "27-0": "string", "27-1": "ProfilerResponse", "27-2": "Fraud profiler result: pass, warn, review. Based on score thresholds", "28-0": "string", "28-1": "ProfilerReason", "28-2": "Comma separated list of reason codes that contributed to the score." }, "cols": 3, "rows": 29 } [/block] [block:api-header] { "type": "basic", "title": "Examples" } [/block] ## Visual Basic (.Net) [block:code] { "codes": [ { "code": "eBizCharge.TransactionResponse response = new eBizCharge.TransactionResponse();\ntry\n{\n response = client.runTransaction(token, tran);\n if (response.ResultCode == \"A\")\n {\n MessageBox.Show(string.Concat(\"Transaction Approved, RefNum: \",\n response.RefNum));\n }\n else\n {\n MessageBox.Show(string.Concat(\"Transaction Failed: \",\n response.Error));\n }", "language": "asp" } ] } [/block] ## C Sharp (.Net) [block:code] { "codes": [ { "code": "eBizCharge.TransactionResponse response = new eBizCharge.TransactionResponse();\ntry\n{\n response = client.runTransaction(token, tran);\n if (response.ResultCode == \"A\")\n {\n MessageBox.Show(string.Concat(\"Transaction Approved, RefNum: \",\n response.RefNum));\n }\n else\n {\n MessageBox.Show(string.Concat(\"Transaction Failed: \",\n response.Error));\n }\n}", "language": "csharp" } ] } [/block] ## XML [block:code] { "codes": [ { "code": "<Response xsi:type=\"ns1:TransactionResponse\">\n <AcsUrl xsi:nil=\"true\"/>\n <AuthCode xsi:type=\"xsd:string\">021730</AuthCode>\n <AvsResult xsi:type=\"xsd:string\">Address: Match &amp; 5 Digit Zip: Match</AvsResult>\n <AvsResultCode xsi:type=\"xsd:string\">YYY</AvsResultCode>\n <BatchRefNum xsi:type=\"xsd:integer\">445979</BatchRefNum>\n <BatchNum xsi:type=\"xsd:integer\">979</BatchNum>\n <CardCodeResult xsi:type=\"xsd:string\">Not Processed</CardCodeResult>\n <CardCodeResultCode xsi:type=\"xsd:string\">P</CardCodeResultCode>\n <ConversionRate xsi:type=\"xsd:double\">0</ConversionRate>\n <ConvertedAmount xsi:type=\"xsd:double\">0</ConvertedAmount>\n <ConvertedAmountCurrency xsi:type=\"xsd:string\">0</ConvertedAmountCurrency>\n <CustNum xsi:type=\"xsd:integer\">0</CustNum>\n <Error xsi:type=\"xsd:string\">Approved</Error>\n <ErrorCode xsi:type=\"xsd:integer\">0</ErrorCode>\n <isDuplicate xsi:type=\"xsd:boolean\">false</isDuplicate>\n <Payload xsi:nil=\"true\"/>\n <RefNum xsi:type=\"xsd:integer\">1175354</RefNum>\n <Result xsi:type=\"xsd:string\">Approved</Result>\n <ResultCode xsi:type=\"xsd:string\">A</ResultCode>\n <Status xsi:type=\"xsd:string\">Pending</Status>\n <StatusCode xsi:type=\"xsd:string\">P</StatusCode>\n <VpasResultCode xsi:nil=\"true\"/>\n</Response>", "language": "xml" } ] } [/block]