developer:soap-1.6:methods:updatecheckout

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

developer:soap-1.6:methods:updatecheckout [2013/07/01 08:39] (current)
edenmcewen created
Line 1: Line 1:
 +<embed ..:​contents/>​
  
 +====== updateCheckOut ======
 +
 +Update transaction information for checkout
 +
 +
 +===== Description =====
 +
 +Updates an in-progress checkout request. ​ This can be used to add a total amount or to fill in additional details such as invoice, description,​ etc.   ​updateCheckOut can be called repeatedly up until the customer has confirmed the amount.
 +
 +===== Syntax =====
 +
 +**updateCheckOut** ( [[..:​objects:​ueSecurityToken]] Token, string RequestID, [[..:​objects:​CheckOutRequest]] Request)
 +===== Arguments =====
 +
 +^Type   ​^Name ​  ​^Description ​  ^
 +|[[..:​objects:​ueSecurityToken]] |Token |Merchant security token: used to identify merchant and retrieve the custom fields.|
 +|string |RequestID |ID of checkout request that was returned by startCheckOut |
 +|[[..:​objects:​CheckOutRequest]] |Detail |Transaction detail for checkout request |
 +
 +===== Return Value =====
 +
 +|string |RequestID |ID of checkout request for confirmation |
 +
 +
 +===== 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 |
 +|21105 |Check out can no longer be updated |The checkout was cancelled or an error occurred. ​ A new checkout request should be started with startCheckOut |
 +|21106 |Transaction already processed, amount can't be updated |Checkout process has already passed the amount confirmation screen. ​ Use adjustTransaction to make a change before settlement. |
 +
 +
 +===== 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-stage.usaepay.com/​soap/​2.0/​uedocs">​
 +<​SOAP-ENV:​Body>​
 +<​ns1:​updateCheckOut>​
 +<​Token>​
 +<​ClientIP>​192.168.0.1</​ClientIP>​
 +<​PinHash>​
 +<​HashValue>​b19be1aba51d38ac7ba0daf0567d9bc3e31d903d</​HashValue>​
 +<​Seed>​13651908061679743807</​Seed>​
 +<​Type>​sha1</​Type>​
 +</​PinHash>​
 +<​SourceKey>​e42SYc86C4uvlvyP62ow54Kv93SZsJVm</​SourceKey>​
 +</​Token>​
 +<​RequestID>​192988538</​RequestID>​
 +<​Request>​
 +<​Details>​
 +<​Amount>​9.95</​Amount>​
 +<​Invoice>​123311</​Invoice>​
 +</​Details>​
 +</​Request>​
 +</​ns1:​updateCheckOut>​
 +</​SOAP-ENV:​Body>​
 +</​SOAP-ENV:​Envelope>​
 +</​code>​
 +
 +Response:
 +<code xml>
 +
 +</​code>​
 +
 +===== Change History =====
 +
 +^Version ^Change ^
 +|[[developer:​soap-1.6:​methods:​updatecheckout|1.6]] | Method added in this release |
developer/soap-1.6/methods/updatecheckout.txt ยท Last modified: 2013/07/01 08:39 by edenmcewen

Page Tools