developer:soap-1.6:methods:requestsignature

Soap API v1.6

requestSignature

Start signature request process on pos device

Description

Puts the pos device in signature capture state. The customer will be presented with a screen that takes a signature. An optional message can also be displayed on this screen.

A RequestID is returned by requestSignature. This ID can be used to track the status of the signature request and retrieve the signature image once the request is complete. This can be done either by polling the signature status using getSignatureStatus or by opening a socket hook listener. Signature requests expire after one hour. The signature image must be retrieved within an hour of starting the request.

Syntax

requestSignature ( ueSecurityToken Token, string Message, string CompletionMessage)

Arguments

Type Name Description
ueSecurityToken Token Merchant security token: used to identify merchant and retrieve the custom fields.
string Message Option message to display on the signature screen
string CompletionMessage Option message that is displayed after signature is captured

Return Value

string RequestID ID of signature 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:

 

Response:

 

Change History

Version Change
1.6 Method added in this release
developer/soap-1.6/methods/requestsignature.txt · Last modified: 2013/07/30 16:41 by tem

Page Tools