{"_id":"5632a5ea49e16d0d001224a5","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"},"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"},"project":"55b933b3146ef121002158d3","user":"55b932ba8fd1a02b00f496c8","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-04T17:59:47.403Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":35,"body":"Transaction detail for checkout requests\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Description\"\n}\n[/block]\nThis object contains the data needed to run a checkout request\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\": \"string\",\n    \"1-1\": \"CompletionMessage\",\n    \"1-2\": \"Message to display to customer when sale is complete\",\n    \"2-0\": \"boolean\",\n    \"2-1\": \"IgnoreDuplicate\",\n    \"2-2\": \"Do not check for duplicate transaction. Set to “true” if you would like to override the duplicate transaction handling.\",\n    \"3-0\": \"[TransactionDetail](/docs/transactiondetail)\",\n    \"3-1\": \"Details\",\n    \"3-2\": \"Transaction details: amount, clerk, currency, etc.\",\n    \"4-0\": \"string\",\n    \"4-1\": \"ClientIP\",\n    \"4-2\": \"IP Address of client.\",\n    \"5-0\": \"boolean\",\n    \"5-1\": \"CustReceipt\",\n    \"5-2\": \"Customer Receipt. Set to “true” if you would like the gateway to send an email to customer.\",\n    \"6-0\": \"string\",\n    \"6-1\": \"CustReceiptEmail\",\n    \"6-2\": \"Email address to receipt to. If left blank, the receipt will be sent to the email address stored in the customer record.\",\n    \"7-0\": \"string\",\n    \"7-1\": \"CustReceiptName\",\n    \"7-2\": \"Customer Receipt Template Name. Specify the name of the template to use. (Optional)\",\n    \"8-0\": \"boolean\",\n    \"8-1\": \"ManuallyKey\",\n    \"8-2\": \"If set to true, prompts user to key in card number instead of looking for card swipe\",\n    \"9-0\": \"boolean\",\n    \"9-1\": \"MerchReceipt\",\n    \"9-2\": \"Send Merchant Receipt. Set to “true” if you would like the gateway to send a receipt to the merchant.\",\n    \"10-0\": \"string\",\n    \"10-1\": \"MerchReceiptEmail\",\n    \"10-2\": \"Email address to receipt to. Required if MerchReceipt is set to true\",\n    \"11-0\": \"string\",\n    \"11-1\": \"MerchReceiptName\",\n    \"11-2\": \"Merchant Receipt Template Name. Specify the name of the template to use. (Optional)\",\n    \"12-0\": \"[FieldValue](/docs/fieldvalue)\",\n    \"12-1\": \"CustomFields\",\n    \"12-2\": \"Array of field values containing the merchant defined custom fields. These fields are defined in the merchant console.\",\n    \"13-0\": \"string\",\n    \"13-1\": \"InventoryLocation\",\n    \"13-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    \"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\": \"ScreenHeader\",\n    \"15-2\": \"Option string to display on all checkout screens\",\n    \"16-0\": \"string\",\n    \"16-1\": \"Software\",\n    \"16-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\": 17\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Places Used\"\n}\n[/block]","excerpt":"","slug":"checkoutrequest","type":"basic","title":"CheckOutRequest"}
Transaction detail for checkout requests [block:api-header] { "type": "basic", "title": "Description" } [/block] This object contains the data needed to run a checkout request [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": "string", "1-1": "CompletionMessage", "1-2": "Message to display to customer when sale is complete", "2-0": "boolean", "2-1": "IgnoreDuplicate", "2-2": "Do not check for duplicate transaction. Set to “true” if you would like to override the duplicate transaction handling.", "3-0": "[TransactionDetail](/docs/transactiondetail)", "3-1": "Details", "3-2": "Transaction details: amount, clerk, currency, etc.", "4-0": "string", "4-1": "ClientIP", "4-2": "IP Address of client.", "5-0": "boolean", "5-1": "CustReceipt", "5-2": "Customer Receipt. Set to “true” if you would like the gateway to send an email to customer.", "6-0": "string", "6-1": "CustReceiptEmail", "6-2": "Email address to receipt to. If left blank, the receipt will be sent to the email address stored in the customer record.", "7-0": "string", "7-1": "CustReceiptName", "7-2": "Customer Receipt Template Name. Specify the name of the template to use. (Optional)", "8-0": "boolean", "8-1": "ManuallyKey", "8-2": "If set to true, prompts user to key in card number instead of looking for card swipe", "9-0": "boolean", "9-1": "MerchReceipt", "9-2": "Send Merchant Receipt. Set to “true” if you would like the gateway to send a receipt to the merchant.", "10-0": "string", "10-1": "MerchReceiptEmail", "10-2": "Email address to receipt to. Required if MerchReceipt is set to true", "11-0": "string", "11-1": "MerchReceiptName", "11-2": "Merchant Receipt Template Name. Specify the name of the template to use. (Optional)", "12-0": "[FieldValue](/docs/fieldvalue)", "12-1": "CustomFields", "12-2": "Array of field values containing the merchant defined custom fields. These fields are defined in the merchant console.", "13-0": "string", "13-1": "InventoryLocation", "13-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.", "14-0": "[LineItem](/docs/lineitem)[]", "14-1": "LineItems", "14-2": "Array of line item detail objects", "15-0": "string", "15-1": "ScreenHeader", "15-2": "Option string to display on all checkout screens", "16-0": "string", "16-1": "Software", "16-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": 17 } [/block] [block:api-header] { "type": "basic", "title": "Places Used" } [/block]