This shows you the differences between two versions of the page.
— |
developer:soap-1.6:methods:cancelcheckout [2013/07/01 08:41] (current) edenmcewen created |
||
---|---|---|---|
Line 1: | Line 1: | ||
+ | <embed ..:contents/> | ||
+ | ====== cancelCheckOut ====== | ||
+ | |||
+ | Cancel a checkout request | ||
+ | |||
+ | ===== Description ===== | ||
+ | |||
+ | Cancels in progress checkout request. | ||
+ | |||
+ | |||
+ | ===== Syntax ===== | ||
+ | |||
+ | string **cancelCheckOut** ( [[..:objects:ueSecurityToken]] Token, string RequestID) | ||
+ | |||
+ | ===== Arguments ===== | ||
+ | |||
+ | ^Type ^Name ^Description ^ | ||
+ | |[[..:objects:ueSecurityToken]] |Token |Merchant security token: used to identify merchant and retrieve the custom fields.| | ||
+ | |string |RequestID |ID returned by startCheckOut | | ||
+ | |||
+ | ===== Return Value ===== | ||
+ | |||
+ | |string |Status |Confirmation message | | ||
+ | |||
+ | |||
+ | ===== Exceptions ===== | ||
+ | |||
+ | The following exceptions (errors) are applicable to this method. | ||
+ | |||
+ | ^Code ^Message ^Advice ^ | ||
+ | |21104 |Checkout request not found |The RequestID was not found | | ||
+ | |||
+ | ===== Examples ===== | ||
+ | |||
+ | |||
+ | ==== PHP ==== | ||
+ | |||
+ | For directions on how to set up the WSDL link, create "$token" and "$client", go to [[..:howto:php|PHP Soap How-to]]. | ||
+ | |||
+ | <code php> | ||
+ | </code> | ||
+ | |||
+ | ==== VB ==== | ||
+ | |||
+ | <code vb> | ||
+ | </code> | ||
+ | |||
+ | ====.NET C# ==== | ||
+ | <code c> | ||
+ | </code> | ||
+ | |||
+ | ==== XML ==== | ||
+ | Request: | ||
+ | <code xml> | ||
+ | <?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:cancelCheckOut> | ||
+ | <Token> | ||
+ | <ClientIP>192.168.0.1</ClientIP> | ||
+ | <PinHash> | ||
+ | <HashValue>e9956826a2aedad6bfb9d617dc5725ac6e03811e</HashValue> | ||
+ | <Seed>1365187894824391806</Seed> | ||
+ | <Type>sha1</Type> | ||
+ | </PinHash> | ||
+ | <SourceKey>e42SYc86C4uvlvyP62ow54Kv93SZsJVm</SourceKey> | ||
+ | </Token> | ||
+ | <RequestID>192988521</RequestID> | ||
+ | </ns1:cancelCheckOut> | ||
+ | </SOAP-ENV:Body> | ||
+ | </SOAP-ENV:Envelope> | ||
+ | </code> | ||
+ | |||
+ | Response: | ||
+ | <code xml> | ||
+ | |||
+ | </code> | ||
+ | |||
+ | ===== Change History ===== | ||
+ | |||
+ | ^Version ^Change ^ | ||
+ | |[[developer:soap-1.6:methods:deletePosDeviceRegistration|1.6]] | Method added in this release | |