{"_id":"5632a5e849e16d0d00122470","project":"55b933b3146ef121002158d3","user":"55b932ba8fd1a02b00f496c8","category":{"_id":"5632a5e749e16d0d00122445","project":"55b933b3146ef121002158d3","version":"5632a5e549e16d0d00122443","__v":1,"pages":["5632a5e849e16d0d00122460","5632a5e849e16d0d00122461","5632a5e849e16d0d00122462","5632a5e849e16d0d00122463","5632a5e849e16d0d00122464","5632a5e849e16d0d00122465","5632a5e849e16d0d00122466","5632a5e849e16d0d00122467","5632a5e849e16d0d00122468","5632a5e849e16d0d00122469","5632a5e849e16d0d0012246a","5632a5e849e16d0d0012246b","5632a5e849e16d0d0012246c","5632a5e849e16d0d0012246d","5632a5e849e16d0d0012246e","5632a5e849e16d0d0012246f","5632a5e849e16d0d00122470","5632a5e849e16d0d00122471","5632a5e849e16d0d00122472","5632a5e849e16d0d00122473","5632a5e849e16d0d00122474","5632a5e849e16d0d00122475","5632a5e849e16d0d00122476","5632a5e849e16d0d00122477"],"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-07-31T23:43:21.882Z","from_sync":false,"order":3,"slug":"transactions","title":"Transactions"},"githubsync":"","__v":0,"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"},"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-03T17:52:43.543Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":16,"body":"Retrieves only selected details of a specified transaction.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Description\"\n}\n[/block]\nIf only a small subset of the transaction data is needed, use this method instead of the broader [getTransaction](/docs/get-transactions) retrieval method. This method returns only the data requested in the Fields parameters and is therefore more efficient than the [getTransaction](/docs/get-transactions) method.\nTo specify the transaction you would like to view, you must retrieve it using the reference number (RefNum) assigned to the transaction by the gateway. The RefNum is assigned by the gateway and returned when a transaction is processed. To find a missing RefNum, use the [searchTransactions](/docs/searchtransactions) method.\nSpecify which transaction fields you would like to retrieve data from by entering one or more of the following:\n\n  * Response.AuthCode\n  * Response.AvsResult\n  * Response.AvsResultCode\n  * Response.BatchNum\n  * Response.CardCodeResult\n  * Response.CardCodeResultCode\n  * Response.ConversionRate\n  * Response.ConvertedAmount\n  * Response.ConvertedAmountCurrency\n  * Response.Error\n  * Response.ErrorCode\n  * Response.RefNum\n  * Response.Result\n  * Response.ResultCode\n  * Response.Status\n  * Response.StatusCode\n  * CheckTrace.TrackingNum\n  * CheckTrace.Effective\n  * CheckTrace.Processed\n  * CheckTrace.Settled\n  * CheckTrace.Returned\n  * CheckTrace.BankNote\n  * DateTime\n  * AccountHolder\n  * Details.Invoice\n  * Details.PoNum\n  * Details.OrderID\n  * Details.Clerk\n  * Details.Terminal\n  * Details.Table\n  * Details.Description\n  * Details.Amount\n  * Details.Currency\n  * Details.Tax\n  * Details.Tip\n  * Details.NonTax\n  * Details.Shipping\n  * Details.Discount\n  * Details.Subtotal\n  * CreditCardData.CardType\n  * CreditCardData.CardNumber\n  * CreditCardData.CardExpiration\n  * CreditCardData.CardCode\n  * CreditCardData.AvsStreet\n  * CreditCardData.AvsZip\n  * CreditCardData.CardPresent\n  * CheckData.CheckNumber\n  * CheckData.Routing\n  * CheckData.Account\n  * CheckData.SSN\n  * CheckData.DriversLicense\n  * CheckData.DriversLicenseState\n  * CheckData.RecordType\n  * User\n  * Source\n  * ServerIP\n  * ClientIP\n  * CustomerID\n  * BillingAddress.FirstName\n  * BillingAddress.LastName\n  * BillingAddress.Company\n  * BillingAddress.Street\n  * BillingAddress.Street2\n  * BillingAddress.City\n  * BillingAddress.State\n  * BillingAddress.Zip\n  * BillingAddress.Country\n  * BillingAddress.Phone\n  * BillingAddress.Fax\n  * BillingAddress.Email\n  * ShippingAddress.FirstName\n  * ShippingAddress.LastName\n  * ShippingAddress.Company\n  * ShippingAddress.Street\n  * ShippingAddress.Street2\n  * ShippingAddress.City\n  * ShippingAddress.State\n  * ShippingAddress.Zip\n  * ShippingAddress.Country\n  * ShippingAddress.Phone\n  * ShippingAddress.Fax\n  * ShippingAddress.Email \n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Syntax\"\n}\n[/block]\n[FieldValue](/docs/fieldvalue) **getTransactionCustom** ( [ueSecurityToken](/docs/uesecuritytoken) Token, integer RefNum, string Fields )\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Arguments\"\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\": \"[ueSecurityToken](/docs/uesecuritytoken)\",\n    \"0-1\": \"Token\",\n    \"0-2\": \"Merchant security token: used to identify merchant and validate transaction.\",\n    \"1-0\": \"integer\",\n    \"1-1\": \"RefNum\",\n    \"1-2\": \"Transaction Reference number assigned by the gateway.\",\n    \"2-0\": \"string\",\n    \"2-1\": \"Fields\",\n    \"2-2\": \"An array listing the fields to be retrieved.\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Return Value\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-1\": \"Returns requested data from specified transaction. Possible values include transaction status, gateway response, date and time of transaction, credit card specific data, transaction amount, cardholder name and address, and any other transaction details entered in the request.\",\n    \"0-0\": \"[FieldValue](/docs/fieldvalue)\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Examples\"\n}\n[/block]\n## PHP \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<?php\\ntry {\\n $RefNum=1009411;\\n $Fields = array(\\n   'Details.Amount',\\n   'AccountHolder',  \\n   'CheckTrace.TrackingNum'\\n   );\\n $res=$client->getTransactionCustom($token, $RefNum, $Fields);  \\n print_r($res);\\n}\\ncatch (SoapFault $e) {\\n echo $client->__getLastResponse();\\n die(\\\"Get Transaction failed :\\\" .$e->getMessage());\\n }\\n?>\\t\",\n      \"language\": \"php\"\n    }\n  ]\n}\n[/block]\n## Java \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"try {\\n //Set RefNum to the Reference Number of transaction you\\n //want to retrieve fields from.\\n BigInteger RefNum = new BigInteger();\\n StringArray fields = new StringArray();\\n fields.add(new String(\\\"Details.Amount\\\"));\\n FieldValueArray Response;\\n Response = client.getTransactionCustom(token, refnum, fields);\\n} catch (Exception e) {\\n   System.out.println(\\\"Soap Exception: \\\" + e.getMessage());\\n}\",\n      \"language\": \"java\"\n    }\n  ]\n}\n[/block]\n## Visual Basic (.Net) \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Dim refnum As String\\n       refnum = 46976537\\n       Dim fields(0 To 2) As String\\n       fields(0) = \\\"Details.Amount\\\"\\n       fields(1) = \\\"AccountHolder\\\"\\n       fields(2) = \\\"CreditCardData.AvsStreet\\\"\\n       Dim tran(0 To 2) As eBizCharge.FieldValue\\n       For i As Integer = 0 To 2\\n           tran(i) = New eBizCharge.FieldValue()\\n       Next i\\n       tran = client.getTransactionCustom(token, refnum, fields)\\n       MsgBox(tran(0).Value & \\\" \\\" & tran(1).Value & \\\" \\\" & tran(2).Value)\",\n      \"language\": \"c\"\n    }\n  ]\n}\n[/block]\n## C Sharp (.Net)\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"string refnum;\\n           string[] fields = new string[3];\\n           fields[0] = \\\"Details.Amount\\\";\\n           fields[1] = \\\"AccountHolder\\\";\\n           fields[2] = \\\"CreditCardData.AvsStreet\\\";\\n           refnum = \\\"46976537\\\";\\n           eBizCharge.FieldValue[] tran = new eBizCharge.FieldValue[3];\\n           for (int i = 0; i < 3; i++)\\n           {\\n               tran[i] = new eBizCharge.FieldValue();\\n           }\\n           try\\n           {\\n               tran = client.getTransactionCustom(token, refnum,fields);\\n                   MessageBox.Show(string.Concat(\\\"Transaction Approved, RefNum: \\\",\\n                           tran[0].Field,\\\" = \\\",tran[0].Value, \\\" \\\",\\n                           tran[0].Field,\\\" = \\\",tran[1].Value, \\\" \\\",\\n                           tran[0].Field,\\\" = \\\",tran[2].Value));\\n           }\\n           catch (Exception err)\\n           {\\n               MessageBox.Show(err.Message);\\n           }\\t\",\n      \"language\": \"csharp\"\n    }\n  ]\n}\n[/block]\n## XML \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?>\\n<SOAP-ENV:Envelope xmlns:SOAP-ENV=\\\"http://schemas.xmlsoap.org/soap/envelope/\\\"\\nxmlns:ns1=\\\"urn:eBizCharge\\\" xmlns:xsd=\\\"http://www.w3.org/2001/XMLSchema\\\"\\nxmlns:xsi=\\\"http://www.w3.org/2001/XMLSchema-instance\\\"\\nxmlns:SOAP-ENC=\\\"http://schemas.xmlsoap.org/soap/encoding/\\\"\\nSOAP-ENV:encodingStyle=\\\"http://schemas.xmlsoap.org/soap/encoding/\\\">\\n<SOAP-ENV:Body>\\n<ns1:getTransactionCustom>\\n<Token xsi:type=\\\"ns1:ueSecurityToken\\\">\\n<ClientIP xsi:type=\\\"xsd:string\\\">192.168.0.1</ClientIP>\\n<PinHash xsi:type=\\\"ns1:ueHash\\\">\\n<HashValue xsi:type=\\\"xsd:string\\\">11ac55b0a0b59f8f028dbf85bc32266fa973dd0e</HashValue>\\n<Seed xsi:type=\\\"xsd:string\\\">12678150211876663375</Seed>\\n<Type xsi:type=\\\"xsd:string\\\">sha1</Type>\\n</PinHash>\\n<SourceKey xsi:type=\\\"xsd:string\\\">HB4P7C4K2w2ZCQQQXRqrxDj6agrS2NIT</SourceKey>\\n</Token>\\n<RefNum xsi:type=\\\"xsd:integer\\\">1118458</RefNum>\\n<Fields SOAP-ENC:arrayType=\\\"xsd:string[5]\\\" xsi:type=\\\"ns1:stringArray\\\">\\n<item xsi:type=\\\"xsd:string\\\">Response.AvsResult</item>\\n<item xsi:type=\\\"xsd:string\\\">Response.AvsResultCode</item>\\n<item xsi:type=\\\"xsd:string\\\">DateTime</item>\\n<item xsi:type=\\\"xsd:string\\\">Response.Error</item>\\n<item xsi:type=\\\"xsd:string\\\">Details.Invoice</item>\\n</Fields>\\n</ns1:getTransactionCustom>\\n</SOAP-ENV:Body>\\n</SOAP-ENV:Envelope>\",\n      \"language\": \"xml\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"gettransactioncustom","type":"basic","title":"getTransactionCustom"}

getTransactionCustom


Retrieves only selected details of a specified transaction. [block:api-header] { "type": "basic", "title": "Description" } [/block] If only a small subset of the transaction data is needed, use this method instead of the broader [getTransaction](/docs/get-transactions) retrieval method. This method returns only the data requested in the Fields parameters and is therefore more efficient than the [getTransaction](/docs/get-transactions) method. To specify the transaction you would like to view, you must retrieve it using the reference number (RefNum) assigned to the transaction by the gateway. The RefNum is assigned by the gateway and returned when a transaction is processed. To find a missing RefNum, use the [searchTransactions](/docs/searchtransactions) method. Specify which transaction fields you would like to retrieve data from by entering one or more of the following: * Response.AuthCode * Response.AvsResult * Response.AvsResultCode * Response.BatchNum * Response.CardCodeResult * Response.CardCodeResultCode * Response.ConversionRate * Response.ConvertedAmount * Response.ConvertedAmountCurrency * Response.Error * Response.ErrorCode * Response.RefNum * Response.Result * Response.ResultCode * Response.Status * Response.StatusCode * CheckTrace.TrackingNum * CheckTrace.Effective * CheckTrace.Processed * CheckTrace.Settled * CheckTrace.Returned * CheckTrace.BankNote * DateTime * AccountHolder * Details.Invoice * Details.PoNum * Details.OrderID * Details.Clerk * Details.Terminal * Details.Table * Details.Description * Details.Amount * Details.Currency * Details.Tax * Details.Tip * Details.NonTax * Details.Shipping * Details.Discount * Details.Subtotal * CreditCardData.CardType * CreditCardData.CardNumber * CreditCardData.CardExpiration * CreditCardData.CardCode * CreditCardData.AvsStreet * CreditCardData.AvsZip * CreditCardData.CardPresent * CheckData.CheckNumber * CheckData.Routing * CheckData.Account * CheckData.SSN * CheckData.DriversLicense * CheckData.DriversLicenseState * CheckData.RecordType * User * Source * ServerIP * ClientIP * CustomerID * BillingAddress.FirstName * BillingAddress.LastName * BillingAddress.Company * BillingAddress.Street * BillingAddress.Street2 * BillingAddress.City * BillingAddress.State * BillingAddress.Zip * BillingAddress.Country * BillingAddress.Phone * BillingAddress.Fax * BillingAddress.Email * ShippingAddress.FirstName * ShippingAddress.LastName * ShippingAddress.Company * ShippingAddress.Street * ShippingAddress.Street2 * ShippingAddress.City * ShippingAddress.State * ShippingAddress.Zip * ShippingAddress.Country * ShippingAddress.Phone * ShippingAddress.Fax * ShippingAddress.Email [block:api-header] { "type": "basic", "title": "Syntax" } [/block] [FieldValue](/docs/fieldvalue) **getTransactionCustom** ( [ueSecurityToken](/docs/uesecuritytoken) Token, integer RefNum, string Fields ) [block:api-header] { "type": "basic", "title": "Arguments" } [/block] [block:parameters] { "data": { "h-0": "Type", "h-1": "Name", "h-2": "Description", "0-0": "[ueSecurityToken](/docs/uesecuritytoken)", "0-1": "Token", "0-2": "Merchant security token: used to identify merchant and validate transaction.", "1-0": "integer", "1-1": "RefNum", "1-2": "Transaction Reference number assigned by the gateway.", "2-0": "string", "2-1": "Fields", "2-2": "An array listing the fields to be retrieved." }, "cols": 3, "rows": 3 } [/block] [block:api-header] { "type": "basic", "title": "Return Value" } [/block] [block:parameters] { "data": { "0-1": "Returns requested data from specified transaction. Possible values include transaction status, gateway response, date and time of transaction, credit card specific data, transaction amount, cardholder name and address, and any other transaction details entered in the request.", "0-0": "[FieldValue](/docs/fieldvalue)" }, "cols": 2, "rows": 1 } [/block] [block:api-header] { "type": "basic", "title": "Examples" } [/block] ## PHP [block:code] { "codes": [ { "code": "<?php\ntry {\n $RefNum=1009411;\n $Fields = array(\n 'Details.Amount',\n 'AccountHolder', \n 'CheckTrace.TrackingNum'\n );\n $res=$client->getTransactionCustom($token, $RefNum, $Fields); \n print_r($res);\n}\ncatch (SoapFault $e) {\n echo $client->__getLastResponse();\n die(\"Get Transaction failed :\" .$e->getMessage());\n }\n?>\t", "language": "php" } ] } [/block] ## Java [block:code] { "codes": [ { "code": "try {\n //Set RefNum to the Reference Number of transaction you\n //want to retrieve fields from.\n BigInteger RefNum = new BigInteger();\n StringArray fields = new StringArray();\n fields.add(new String(\"Details.Amount\"));\n FieldValueArray Response;\n Response = client.getTransactionCustom(token, refnum, fields);\n} catch (Exception e) {\n System.out.println(\"Soap Exception: \" + e.getMessage());\n}", "language": "java" } ] } [/block] ## Visual Basic (.Net) [block:code] { "codes": [ { "code": "Dim refnum As String\n refnum = 46976537\n Dim fields(0 To 2) As String\n fields(0) = \"Details.Amount\"\n fields(1) = \"AccountHolder\"\n fields(2) = \"CreditCardData.AvsStreet\"\n Dim tran(0 To 2) As eBizCharge.FieldValue\n For i As Integer = 0 To 2\n tran(i) = New eBizCharge.FieldValue()\n Next i\n tran = client.getTransactionCustom(token, refnum, fields)\n MsgBox(tran(0).Value & \" \" & tran(1).Value & \" \" & tran(2).Value)", "language": "c" } ] } [/block] ## C Sharp (.Net) [block:code] { "codes": [ { "code": "string refnum;\n string[] fields = new string[3];\n fields[0] = \"Details.Amount\";\n fields[1] = \"AccountHolder\";\n fields[2] = \"CreditCardData.AvsStreet\";\n refnum = \"46976537\";\n eBizCharge.FieldValue[] tran = new eBizCharge.FieldValue[3];\n for (int i = 0; i < 3; i++)\n {\n tran[i] = new eBizCharge.FieldValue();\n }\n try\n {\n tran = client.getTransactionCustom(token, refnum,fields);\n MessageBox.Show(string.Concat(\"Transaction Approved, RefNum: \",\n tran[0].Field,\" = \",tran[0].Value, \" \",\n tran[0].Field,\" = \",tran[1].Value, \" \",\n tran[0].Field,\" = \",tran[2].Value));\n }\n catch (Exception err)\n {\n MessageBox.Show(err.Message);\n }\t", "language": "csharp" } ] } [/block] ## XML [block:code] { "codes": [ { "code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<SOAP-ENV:Envelope xmlns:SOAP-ENV=\"http://schemas.xmlsoap.org/soap/envelope/\"\nxmlns:ns1=\"urn:eBizCharge\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\"\nxmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"\nxmlns:SOAP-ENC=\"http://schemas.xmlsoap.org/soap/encoding/\"\nSOAP-ENV:encodingStyle=\"http://schemas.xmlsoap.org/soap/encoding/\">\n<SOAP-ENV:Body>\n<ns1:getTransactionCustom>\n<Token xsi:type=\"ns1:ueSecurityToken\">\n<ClientIP xsi:type=\"xsd:string\">192.168.0.1</ClientIP>\n<PinHash xsi:type=\"ns1:ueHash\">\n<HashValue xsi:type=\"xsd:string\">11ac55b0a0b59f8f028dbf85bc32266fa973dd0e</HashValue>\n<Seed xsi:type=\"xsd:string\">12678150211876663375</Seed>\n<Type xsi:type=\"xsd:string\">sha1</Type>\n</PinHash>\n<SourceKey xsi:type=\"xsd:string\">HB4P7C4K2w2ZCQQQXRqrxDj6agrS2NIT</SourceKey>\n</Token>\n<RefNum xsi:type=\"xsd:integer\">1118458</RefNum>\n<Fields SOAP-ENC:arrayType=\"xsd:string[5]\" xsi:type=\"ns1:stringArray\">\n<item xsi:type=\"xsd:string\">Response.AvsResult</item>\n<item xsi:type=\"xsd:string\">Response.AvsResultCode</item>\n<item xsi:type=\"xsd:string\">DateTime</item>\n<item xsi:type=\"xsd:string\">Response.Error</item>\n<item xsi:type=\"xsd:string\">Details.Invoice</item>\n</Fields>\n</ns1:getTransactionCustom>\n</SOAP-ENV:Body>\n</SOAP-ENV:Envelope>", "language": "xml" } ] } [/block]