These parameters are used for products where StoreGUI = EP, EG. The PinRequest function type is used to retrieve one pin at a time in a real time delivery scenario and it is used for eGifts.
Certain parameters must be in all API calls, view all the parameters below:
GUI's are specified under each parameter. If not listed, then leave empty.
This field is part of the Common Request Parameters.
The value for this call is PinRequest
6 character code identifying product. List of codes is in the product file.
Product value reference, part of the product list provided by Payment Source. This value is in dollars and cents (100.00 represents $100)
Receipt number from Station. If the actual receipt number contains more than five characters, the last 5 characters (from the right) are recorded in the e-Fresh table.
An unique number identifying the transaction request. Generated by client application.
ID of the clerk who sold the product.
Store the client's reconciliation reference. It will be sent in the request packet to PSIcom.
(See Product Pages for customized examples)
<RequestXml>
<!-- Common request parameters -->
<Type>PinRequest</Type>
<TerminalId>Assigned</TerminalId>
<Password>Assigned</Password>
<Language>eng</Language>
<ReceiptNo>12345</ReceiptNo>
<ValueCode>10</ValueCode>
<ClerkId>1</ClerkId>
<RefNo>54832</RefNo>
<ReconRef>0001</ReconRef>
<ProdCode>ECTEST</ProdCode>
</RequestXml>
Certain fields are returned from all API calls, view all the fields below:
GUI's are specified under each parameter. If not listed, then do not use.
Returns the transno created for this transaction on the store PC’s system.
Unmasked PinSerial.
PIN data block, object contents below:
The secret code of the Product to be given to the customer. This field is sent as clear text, not encrypted. Provide to customer.
EP-Can contain information that should be delivered to the customer with the product. Most PIN products do not have data in this field. Provide to customer if this contains data.
EG-eGift cards use this field for the unique vendor voucher eGift URL. Provide to customer.
Can contain information that should be delivered to the customer with the product. Most PIN products do not have data in this field. Provide to customer if this contains data.
EP-Serial number of the PIN. Provide to customer.
EG-Unique vendor voucher ID of the gift card. Do not provide to customer.
Serial number of the PIN. Provide to customer.
Expiry number of the PIN. Optional to provide to customers.
(See product pages for customized examples)
<ResponseXml>
<StatusCode>0</StatusCode>
<StatusDescription>PIN is on receipt.
</StatusDescription>
<TransNo>0070000200643</TransNo>
<AccountNo>12285</AccountNo>
<PinData>
<Pin>888394270576843</Pin>
<Custom1 />
<Custom2 />
<PinSerial>12285</PinSerial>
<PinBatch>56978</PinBatch>
<ExpiryDate/>
</PinData>
<MerchantId>NPTTESTSTORE</MerchantId>
<Company>NPP Convenience Mart</Company>
<CompanyCity>Vancouver</CompanyCity>
<CompanyPhone>5559441234</CompanyPhone>
<CompanyDbaName>NPP Convenience</CompanyDbaName>
<TransDate>2019-01-20</TransDate>
<TransTime>11:17:06</TransTime>
<ProductVer>0340217</ProductVer>
<PromoVer>0340009</PromoVer>
<SoftVer />
<InvoiceNumber />
<NSM />
</ResponseXml>