{"_id":"5632a5ea49e16d0d0012249f","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"},"__v":0,"githubsync":"","project":"55b933b3146ef121002158d3","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"},"user":"55b932ba8fd1a02b00f496c8","parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-04T17:58:43.145Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":29,"body":"Used to run a new transaction.\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Description\"\n}\n[/block]\nThis object contains the data needed to run a new transaction, including sale, credit, void and authonly.\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\": \"string\",\n    \"0-1\": \"Command\",\n    \"0-2\": \"Processing Command. Possible values are: sale, credit, void, creditvoid, authonly, capture, postauth, check and checkcredit. Default is sale.\",\n    \"1-0\": \"boolean\",\n    \"1-1\": \"IgnoreDuplicate\",\n    \"1-2\": \"Do not check for duplicate transaction. Set to “true” if you would like to override the duplicate transaction handling.\",\n    \"2-0\": \"string\",\n    \"2-1\": \"AuthCode\",\n    \"2-2\": \"Original Authorization Code. Authorization Code obtained “offline” (ie telephone authorization). Only required for PostAuth.\",\n    \"3-0\": \"string\",\n    \"3-1\": \"RefNum\",\n    \"3-2\": \"Original Transaction Reference Number. The RefNum received when a transaction was authorized via either the “sale” or “authonly” commands. Required for void and capture commands only.\",\n    \"4-0\": \"string\",\n    \"4-1\": \"AccountHolder\",\n    \"4-2\": \"Name of the account holder.\",\n    \"5-0\": \"[TransactionDetail](/docs/transactiondetail)\",\n    \"5-1\": \"Details\",\n    \"5-2\": \"Transaction details: amount, clerk, currency, etc.\",\n    \"6-0\": \"[CreditCardData](/docs/creditcarddata)\",\n    \"6-1\": \"CreditCardData\",\n    \"6-2\": \"CreditCardData. Required for credit card transactions.\",\n    \"7-0\": \"[CheckData](/docs/checkdata)\",\n    \"7-1\": \"CheckData\",\n    \"7-2\": \"CheckData. Required for electronic check processing.\",\n    \"8-0\": \"string\",\n    \"8-1\": \"ClientIP\",\n    \"8-2\": \"IP Address of client.\",\n    \"9-0\": \"string\",\n    \"9-1\": \"CustomerID\",\n    \"9-2\": \"CustomerID\",\n    \"10-0\": \"[Address](/docs/address)\",\n    \"10-1\": \"BillingAddress\",\n    \"10-2\": \"BillingAddress\",\n    \"11-0\": \"[Address](/docs/address)\",\n    \"11-1\": \"ShippingAddress\",\n    \"11-2\": \"ShippingAddress\",\n    \"12-0\": \"boolean\",\n    \"12-1\": \"CustReceipt\",\n    \"12-2\": \"Customer Receipt. Set to “true” if you would like the gateway to send an email to customer's billing address email.\",\n    \"13-0\": \"string\",\n    \"13-1\": \"Software\",\n    \"13-2\": \"Software Name/version. Allows application developers to stamp their application name and version number onto each transaction. Used to assist customers with trouble shooting. Not Required.\",\n    \"14-0\": \"boolean\",\n    \"14-1\": \"CustReceipt\",\n    \"14-2\": \"True/False. True will cause a customer receipt to be sent.\",\n    \"15-0\": \"string\",\n    \"15-1\": \"CustReceiptName\",\n    \"15-2\": \"Name of the receipt template to use. Defaults to the standard customer receipt.\",\n    \"16-0\": \"[RecurringBilling](/docs/recurringbilling)\",\n    \"16-1\": \"RecurringBilling\",\n    \"16-2\": \"RecurringBilling. Object describing if recurring billing cycle should be created if initial transaction is approved.\",\n    \"17-0\": \"[LineItem](/docs/lineitem)[]\",\n    \"17-1\": \"LineItems\",\n    \"17-2\": \"Array of line item details\",\n    \"18-0\": \"[FieldValue](/docs/fieldvalue)[]\",\n    \"18-1\": \"CustomFields\",\n    \"18-2\": \"Array of Custom Fields\",\n    \"19-0\": \"string\",\n    \"19-1\": \"IfAuthExpired\",\n    \"19-2\": \"Sets what will happen when a “capture” command is sent on authorization that has expired. By default the expiration will be ignored and the authorization will be captured. If set to “error” the capture will be blocked and an error will be returned. If set to “reauth” the system will send in a new authorization request to the platform before capturing the transaction.\",\n    \"20-0\": \"boolean\",\n    \"20-1\": \"IsRecurring\",\n    \"20-2\": \"Flags a credit card transaction as a recurring payment when sent to the platforms for processing. This is not related to the RecurringBilling object above and it does not tie into the gateway's recurring billing system. Rather, this flag should be used by developers who are initiating the recurring transactions from within their own system and need to indicate that it is recurring.\",\n    \"21-0\": \"string\",\n    \"21-1\": \"Software\",\n    \"21-2\": \"Free form string that can be used by the developer to record information about their software, version, build number or operating system details. Reported on the transaction detail screen, in custom reports or via api.\"\n  },\n  \"cols\": 3,\n  \"rows\": 22\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\": \"Dim tran As eBizCharge.TransactionRequestObject = New eBizCharge.TransactionRequestObject\\n       tran.CreditCardData = New eBizCharge.CreditCardData\\n       tran.CreditCardData.CardNumber = \\\"4444555566667779\\\"\\n       tran.CreditCardData.CardExpiration = \\\"0913\\\"\\n       tran.CreditCardData.CardCode = \\\"999\\\"\\n       tran.Details = New eBizCharge.TransactionDetail\\n       tran.Details.Amount = 9.02\\n       tran.Details.AmountSpecified = True\\n       tran.Details.Invoice = \\\"434534\\\"\\n       tran.Details.Description = \\\"Example transaction\\\"\\n       tran.Command = \\\"sale\\\"\",\n      \"language\": \"asp\"\n    }\n  ]\n}\n[/block]\n## C Sharp (.Net)\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"eBizCharge.TransactionRequestObject tran = new eBizCharge.TransactionRequestObject();\\ntran.Command = \\\"cc:sale\\\";\\ntran.Details =  new eBizCharge.TransactionDetail();\\ntran.Details.Amount = 1.00;\\ntran.Details.AmountSpecified = true;\\ntran.Details.Invoice = \\\"1234\\\";\\ntran.Details.Description = \\\"Example Transaction\\\";\\ntran.CreditCardData = new eBizCharge.CreditCardData();\\ntran.CreditCardData.CardNumber = \\\"4444555566667779\\\";\\ntran.CreditCardData.CardExpiration = \\\"0909\\\";\",\n      \"language\": \"csharp\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"transactionrequestobject","type":"basic","title":"TransactionRequestObject"}

TransactionRequestObject


Used to run a new transaction. [block:api-header] { "type": "basic", "title": "Description" } [/block] This object contains the data needed to run a new transaction, including sale, credit, void and authonly. [block:api-header] { "type": "basic", "title": "Properties" } [/block] [block:parameters] { "data": { "h-0": "Type", "h-1": "Name", "h-2": "Description", "0-0": "string", "0-1": "Command", "0-2": "Processing Command. Possible values are: sale, credit, void, creditvoid, authonly, capture, postauth, check and checkcredit. Default is sale.", "1-0": "boolean", "1-1": "IgnoreDuplicate", "1-2": "Do not check for duplicate transaction. Set to “true” if you would like to override the duplicate transaction handling.", "2-0": "string", "2-1": "AuthCode", "2-2": "Original Authorization Code. Authorization Code obtained “offline” (ie telephone authorization). Only required for PostAuth.", "3-0": "string", "3-1": "RefNum", "3-2": "Original Transaction Reference Number. The RefNum received when a transaction was authorized via either the “sale” or “authonly” commands. Required for void and capture commands only.", "4-0": "string", "4-1": "AccountHolder", "4-2": "Name of the account holder.", "5-0": "[TransactionDetail](/docs/transactiondetail)", "5-1": "Details", "5-2": "Transaction details: amount, clerk, currency, etc.", "6-0": "[CreditCardData](/docs/creditcarddata)", "6-1": "CreditCardData", "6-2": "CreditCardData. Required for credit card transactions.", "7-0": "[CheckData](/docs/checkdata)", "7-1": "CheckData", "7-2": "CheckData. Required for electronic check processing.", "8-0": "string", "8-1": "ClientIP", "8-2": "IP Address of client.", "9-0": "string", "9-1": "CustomerID", "9-2": "CustomerID", "10-0": "[Address](/docs/address)", "10-1": "BillingAddress", "10-2": "BillingAddress", "11-0": "[Address](/docs/address)", "11-1": "ShippingAddress", "11-2": "ShippingAddress", "12-0": "boolean", "12-1": "CustReceipt", "12-2": "Customer Receipt. Set to “true” if you would like the gateway to send an email to customer's billing address email.", "13-0": "string", "13-1": "Software", "13-2": "Software Name/version. Allows application developers to stamp their application name and version number onto each transaction. Used to assist customers with trouble shooting. Not Required.", "14-0": "boolean", "14-1": "CustReceipt", "14-2": "True/False. True will cause a customer receipt to be sent.", "15-0": "string", "15-1": "CustReceiptName", "15-2": "Name of the receipt template to use. Defaults to the standard customer receipt.", "16-0": "[RecurringBilling](/docs/recurringbilling)", "16-1": "RecurringBilling", "16-2": "RecurringBilling. Object describing if recurring billing cycle should be created if initial transaction is approved.", "17-0": "[LineItem](/docs/lineitem)[]", "17-1": "LineItems", "17-2": "Array of line item details", "18-0": "[FieldValue](/docs/fieldvalue)[]", "18-1": "CustomFields", "18-2": "Array of Custom Fields", "19-0": "string", "19-1": "IfAuthExpired", "19-2": "Sets what will happen when a “capture” command is sent on authorization that has expired. By default the expiration will be ignored and the authorization will be captured. If set to “error” the capture will be blocked and an error will be returned. If set to “reauth” the system will send in a new authorization request to the platform before capturing the transaction.", "20-0": "boolean", "20-1": "IsRecurring", "20-2": "Flags a credit card transaction as a recurring payment when sent to the platforms for processing. This is not related to the RecurringBilling object above and it does not tie into the gateway's recurring billing system. Rather, this flag should be used by developers who are initiating the recurring transactions from within their own system and need to indicate that it is recurring.", "21-0": "string", "21-1": "Software", "21-2": "Free form string that can be used by the developer to record information about their software, version, build number or operating system details. Reported on the transaction detail screen, in custom reports or via api." }, "cols": 3, "rows": 22 } [/block] [block:api-header] { "type": "basic", "title": "Examples" } [/block] ## Visual Basic (.Net) [block:code] { "codes": [ { "code": "Dim tran As eBizCharge.TransactionRequestObject = New eBizCharge.TransactionRequestObject\n tran.CreditCardData = New eBizCharge.CreditCardData\n tran.CreditCardData.CardNumber = \"4444555566667779\"\n tran.CreditCardData.CardExpiration = \"0913\"\n tran.CreditCardData.CardCode = \"999\"\n tran.Details = New eBizCharge.TransactionDetail\n tran.Details.Amount = 9.02\n tran.Details.AmountSpecified = True\n tran.Details.Invoice = \"434534\"\n tran.Details.Description = \"Example transaction\"\n tran.Command = \"sale\"", "language": "asp" } ] } [/block] ## C Sharp (.Net) [block:code] { "codes": [ { "code": "eBizCharge.TransactionRequestObject tran = new eBizCharge.TransactionRequestObject();\ntran.Command = \"cc:sale\";\ntran.Details = new eBizCharge.TransactionDetail();\ntran.Details.Amount = 1.00;\ntran.Details.AmountSpecified = true;\ntran.Details.Invoice = \"1234\";\ntran.Details.Description = \"Example Transaction\";\ntran.CreditCardData = new eBizCharge.CreditCardData();\ntran.CreditCardData.CardNumber = \"4444555566667779\";\ntran.CreditCardData.CardExpiration = \"0909\";", "language": "csharp" } ] } [/block]