developer:soap-1.6:methods:startcheckout

Soap API v1.6

startCheckOut

Start check out process on pos device

Description

Puts the pos device in checkout state. Depending on the information provided, the pos device will display the appropriate screens to the customer. The following three states of checkout are supported:

1) Order in progress, no line item detail

If no total amount is provided in the “Amount” detail parameter, it is assumed that the order is still in progress and that the pos device is still adding up a total. A “card may be swiped at any time” screen is displayed to the customer. Once they have swiped their card, a “please wait for cashier” message is shown. The pos software must then send a call to updateCheckOut with an amount once the order is ready for completion. Once the amount is provided, the customer is prompted to confirm the amount, the transaction is processed and the customer is prompted for signature.

2) Order in progress, with line item detail

If no total amount is provided in the “Amount” detail parameter, it is assumed that the order is still in progress and that the pos device is still adding up a total. The customer can swipe their card at any time. As new line items are rung up by the pos software, calls are made to the addCheckOutLineItem method. The line item is display to the pin pad along with a running total. When the order is ready for completion, the pos software must send an amount to updateCheckOut. Once the amount is provided, the customer is prompted to confirm the total amount, the transaction is processed and the customer is prompted for signature.

3) Order submitted in single step

All transaction information including order total are submitted with startCheckOut. The customer is immediately prompted to swipe their card, transaction is process and customer is prompted for signature.

A RequestID is returned by startCheckOut. This ID can be used to track the progress of the customer through the pos device screens. This can be done either by polling the checkout status using getCheckOutStatus or by open a socket hook listener.

Syntax

startCheckOut ( ueSecurityToken Token, CheckOutRequest Request)

Arguments

Type Name Description
ueSecurityToken Token Merchant security token: used to identify merchant and retrieve the custom fields.
CheckOutRequest Detail Transaction detail for checkout request

Return Value

string RequestID ID of checkout request, used to check status

Exceptions

The following exceptions (errors) are applicable to this method.

Code Message Advice
21100 There are no POS devices associated with this source key Register a pos device to this source key
21101 POS device offline Device associated with this source key is offline, try rebooting

Examples

PHP

For directions on how to set up the WSDL link, create “$token” and “$client”, go to PHP Soap How-to.

 

VB

 

.NET C#

 

XML

Request:

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://www.usaepay.com/soap/2.0/uedocs">
<SOAP-ENV:Body>
<ns1:startCheckOut>
<Token>
<ClientIP>192.168.0.1</ClientIP>
<PinHash>
<HashValue>9cc51a8c9124201b26ec4faa89d7f4252ad2e5c3</HashValue>
<Seed>1365186077957149393</Seed>
<Type>sha1</Type>
</PinHash>
<SourceKey>e42SYc86C4uvlvyP62ow54Kv93SZsJVm</SourceKey>
</Token>
<Request>
<Details>
<Amount>9.95</Amount>
<Invoice>123311</Invoice>
</Details>
</Request>
</ns1:startCheckOut>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Response:

 

Change History

Version Change
1.6 Method added in this release
developer/soap-1.6/methods/startcheckout.txt · Last modified: 2013/07/01 08:22 by edenmcewen

Page Tools