{"_id":"5632a5ea49e16d0d0012248f","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"},"project":"55b933b3146ef121002158d3","user":"55b932ba8fd1a02b00f496c8","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:53:29.708Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":13,"body":"Used to run a new customer transaction.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Description\"\n}\n[/block]\nThis object contains the data needed to run a new stored customer transaction.\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 to run. Possible values: Sale, AuthOnly, Credit, Check and CheckCredit. If a blank is passed, the default value is Sale for credit card or Check for checks\",\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\": \"[TransactionDetail](/docs/transactiondetail)\",\n    \"2-1\": \"Details\",\n    \"2-2\": \"Transaction details: amount, clerk, currency, etc.\",\n    \"3-0\": \"string\",\n    \"3-1\": \"ClientIP\",\n    \"3-2\": \"IP Address of client.\",\n    \"4-0\": \"boolean\",\n    \"4-1\": \"CustReceipt\",\n    \"4-2\": \"Customer Receipt. Set to “true” if you would like the gateway to send an email to customer.\",\n    \"5-0\": \"string\",\n    \"5-1\": \"CustReceiptEmail\",\n    \"5-2\": \"Email address to receipt to. If left blank, the receipt will be sent to the email address stored in the customer record.\",\n    \"6-0\": \"string\",\n    \"6-1\": \"CustReceiptName\",\n    \"6-2\": \"Customer Receipt Template Name. Specify the name of the template to use. (Optional)\",\n    \"7-0\": \"boolean\",\n    \"7-1\": \"MerchReceipt\",\n    \"7-2\": \"Send Merchant Receipt. Set to “true” if you would like the gateway to send a receipt to the merchant.\",\n    \"8-0\": \"string\",\n    \"8-1\": \"MerchReceiptEmail\",\n    \"8-2\": \"Email address to receipt to. Required if MerchReceipt is set to true\",\n    \"9-0\": \"string\",\n    \"9-1\": \"MerchReceiptName\",\n    \"9-2\": \"Merchant Receipt Template Name. Specify the name of the template to use. (Optional)\",\n    \"10-0\": \"[FieldValue](/docs/fieldvalue)\",\n    \"10-1\": \"CustomFields\",\n    \"10-2\": \"Array of field values containing the merchant defined custom fields. These fields are defined in the merchant console.\",\n    \"11-0\": \"boolean\",\n    \"11-1\": \"isRecurring\",\n    \"11-2\": \"Recurring flag Signals to the platform that this transaction is a recurring billing transaction. Use with caution, can cause downgrades if not used properly. Defaults to false which causes the transaction to run as a normal card not present transaction.\",\n    \"12-0\": \"string\",\n    \"12-1\": \"InventoryLocation\",\n    \"12-2\": \"ID of warehouse to draw inventory from. If blank, uses setting from source key. If no setting in source key, inventory will not be adjusted.\",\n    \"13-0\": \"string\",\n    \"13-1\": \"CardCode\",\n    \"13-2\": \"CVV2/CVC card id code. PCI requirements forbid storing CVV2 value. Customer must be prompted to enter this value each time a transaction is run. This value is not required unless CVV2 validation is desired.\",\n    \"14-0\": \"[LineItem](/docs/lineitem)[]\",\n    \"14-1\": \"LineItems\",\n    \"14-2\": \"Array of line item detail objects\",\n    \"15-0\": \"string\",\n    \"15-1\": \"Software\",\n    \"15-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. (optional)\"\n  },\n  \"cols\": 3,\n  \"rows\": 16\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Examples\"\n}\n[/block]","excerpt":"","slug":"customertransactionrequest","type":"basic","title":"CustomerTransactionRequest"}

CustomerTransactionRequest


Used to run a new customer transaction. [block:api-header] { "type": "basic", "title": "Description" } [/block] This object contains the data needed to run a new stored customer transaction. [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 to run. Possible values: Sale, AuthOnly, Credit, Check and CheckCredit. If a blank is passed, the default value is Sale for credit card or Check for checks", "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": "[TransactionDetail](/docs/transactiondetail)", "2-1": "Details", "2-2": "Transaction details: amount, clerk, currency, etc.", "3-0": "string", "3-1": "ClientIP", "3-2": "IP Address of client.", "4-0": "boolean", "4-1": "CustReceipt", "4-2": "Customer Receipt. Set to “true” if you would like the gateway to send an email to customer.", "5-0": "string", "5-1": "CustReceiptEmail", "5-2": "Email address to receipt to. If left blank, the receipt will be sent to the email address stored in the customer record.", "6-0": "string", "6-1": "CustReceiptName", "6-2": "Customer Receipt Template Name. Specify the name of the template to use. (Optional)", "7-0": "boolean", "7-1": "MerchReceipt", "7-2": "Send Merchant Receipt. Set to “true” if you would like the gateway to send a receipt to the merchant.", "8-0": "string", "8-1": "MerchReceiptEmail", "8-2": "Email address to receipt to. Required if MerchReceipt is set to true", "9-0": "string", "9-1": "MerchReceiptName", "9-2": "Merchant Receipt Template Name. Specify the name of the template to use. (Optional)", "10-0": "[FieldValue](/docs/fieldvalue)", "10-1": "CustomFields", "10-2": "Array of field values containing the merchant defined custom fields. These fields are defined in the merchant console.", "11-0": "boolean", "11-1": "isRecurring", "11-2": "Recurring flag Signals to the platform that this transaction is a recurring billing transaction. Use with caution, can cause downgrades if not used properly. Defaults to false which causes the transaction to run as a normal card not present transaction.", "12-0": "string", "12-1": "InventoryLocation", "12-2": "ID of warehouse to draw inventory from. If blank, uses setting from source key. If no setting in source key, inventory will not be adjusted.", "13-0": "string", "13-1": "CardCode", "13-2": "CVV2/CVC card id code. PCI requirements forbid storing CVV2 value. Customer must be prompted to enter this value each time a transaction is run. This value is not required unless CVV2 validation is desired.", "14-0": "[LineItem](/docs/lineitem)[]", "14-1": "LineItems", "14-2": "Array of line item detail objects", "15-0": "string", "15-1": "Software", "15-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. (optional)" }, "cols": 3, "rows": 16 } [/block] [block:api-header] { "type": "basic", "title": "Examples" } [/block]