developer:soap-1.6:objects:checkoutrequest

Soap API v1.6

CheckOutRequest

Transaction detail for checkout requests

Description

This object contains the data needed to run a checkout request

Properties

Type Name Description
string Command 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
string CompletionMessage Message to display to customer when sale is complete
boolean IgnoreDuplicate Do not check for duplicate transaction. Set to “true” if you would like to override the duplicate transaction handling.
TransactionDetail Details Transaction details: amount, clerk, currency, etc.
string ClientIP IP Address of client.
boolean CustReceipt Customer Receipt. Set to “true” if you would like the gateway to send an email to customer.
string CustReceiptEmail Email address to receipt to. If left blank, the receipt will be sent to the email address stored in the customer record.
string CustReceiptName Customer Receipt Template Name. Specify the name of the template to use. (Optional)
boolean ManuallyKey If set to true, prompts user to key in card number instead of looking for card swipe
boolean MerchReceipt Send Merchant Receipt. Set to “true” if you would like the gateway to send a receipt to the merchant.
string MerchReceiptEmail Email address to receipt to. Required if MerchReceipt is set to true
string MerchReceiptName Merchant Receipt Template Name. Specify the name of the template to use. (Optional)
FieldValueCustomFields Array of field values containing the merchant defined custom fields. These fields are defined in the merchant console.
string InventoryLocation 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.
LineItem[] LineItems Array of line item detail objects
string ScreenHeader Option string to display on all checkout screens
string Software 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)

Places Used

Examples

Change History

Version Change
1.6 Object added in this release
developer/soap-1.6/objects/checkoutrequest.txt · Last modified: 2013/07/30 10:52 by tem

Page Tools