developer:soap-1.6:methods:getregistrationpin

Soap API v1.6

getRegistrationPin

Retrieve a device registration pin

Description

For integrated software (point of sale solution) to use the gateway driven point of sale devices, the device must be paired with the source key. This can be done using the merchant's web console by going to Settings - POS Devices or the point of sale system can facilitate the pairing.

The steps for device pairing are:

  1. Power up pin pad device and verify proper network connectivity
  2. If successful, the pos device will display prompt for pin
  3. Point of sale software makes call to getRegistrationPin which will return pin
  4. Point of sale displays pin to user
  5. User enters pin into pos device
  6. Pos device will display idle screen and pos software can start using device methods

Syntax

string getRegistrationPin ( ueSecurityToken Token)

Arguments

Type Name Description
ueSecurityToken Token Merchant security token: used to identify merchant and retrieve the custom fields.

Return Value

string Pin Device registration pin

Exceptions

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

Code Message Advice

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:getRegistrationPin>
<Token>
<ClientIP>192.168.0.1</ClientIP>
<PinHash>
<HashValue>c49a67564d2f62e97507c05fa9f68135c139d362</HashValue>
<Seed>13651026722014578962</Seed>
<Type>sha1</Type>
</PinHash>
<SourceKey>e42SYc86C4uvlvyP62ow54Kv93SZsJVm</SourceKey>
</Token>
</ns1:getRegistrationPin>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Response:

 

Change History

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

Page Tools