developer:soap-1.6:methods:getcheckoutstatus

Soap API v1.6

getCheckOutStatus

Retrieve status of checkout request

Description

Returns status of existing checkout request identified by RequestID. If a transaction has been processed, details of the transaction result will also be returned.

Checkout status information is only stored on the gateway for one hour. After one hour, developer must use transaction history. (See getTransaction)

Syntax

getCheckOutStatus ( ueSecurityToken Token, string RequestID)

Arguments

Type Name Description
ueSecurityToken Token Merchant security token: used to identify merchant and retrieve the custom fields.
string RequestID ID of checkout request, used to check status

Return Value

CheckOutStatus Check out status information including transaction result if complete

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:getCheckOutStatus>
<Token>
<ClientIP>192.168.0.1</ClientIP>
<PinHash>
<HashValue>e1a39549d9bdbfbc184fcdb24e519bc6ffd3484c</HashValue>
<Seed>1365184635412623736</Seed>
<Type>sha1</Type>
</PinHash>
<SourceKey>e42SYc86C4uvlvyP62ow54Kv93SZsJVm</SourceKey>
</Token>
<RequestID>192988532</RequestID>
</ns1:getCheckOutStatus>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Response:

 

Change History

Version Change
1.6 Method added in this release
developer/soap-1.6/methods/getcheckoutstatus.txt · Last modified: 2013/08/09 16:10 by tem

Page Tools