{"info":{"_postman_id":"a9afa7ed-e267-4239-a688-a54724dde0ff","name":"Paygistix Client Developer's Guide","description":"

About this guide

Intended Audience

\n\n

This guide is intended for ISVs looking to integrate their application with a robust payment solution that:

Removes the POS application from the scope of PA-DSS compliance
Minimizes an end user’s or service provider’s scope of PCI DSS compliance
Provides a solution for EMV, NFC and other emerging payment technologies
Is backwards compatible with any integration (e.g. if there’s a new release of Paygistix Client, existing integrations will continue to function normally)
Offers value added technologies such as store-and-forward, signature capture, on-device tipping, digital
receipts, loyalty and more with minimal to no coding required
Allows users to use new hardware without requiring additional coding from the ISV

Associated Documentation

\n\n

Calls to Paygistix Client (covered in this document), Paygistix Gateway web services (covered in the Paygistix Core API Guide and associated SDK kits), Paygistix Web (covered in the Paygistix Web SDK), Paygistix Cloud (covered in the Paygistix Cloud Developers Guide and associated SDK kits), and PayLink (Covered covered in the PayLink API requirements document, are compatible and may be interchanged where appropriate. In other words, all transactions ultimately connect up to the Paygistix Gateway and tokens (referred to as PNRef) supplied in responses from any one of our integration technologies can be subsequently used to make calls with any other of our integration technologies.

Supported Platforms

\n\n

Paygistix Client can be installed on the following Microsoft Operating Systems:

Windows 7 or higher
Windows Server 2012 R2 or higher

\n\n

In addition to the operating system, the following software needs to also be installed:

Windows Script Host
Microsoft .NET Framework 4.5 or higher
Microsoft MSXML component

Windows Scripting

\n\n

Throughout this document we will be using the Microsoft Windows Script host to demonstrate sample code. If you would like a primer on Windows Scripting the following link can provide some valuable information: http://www.microsoft.com/technet/scriptcenter/topics/beginner/firststeps.mspx/

The Windows Script Host utility can launch small programs written in VBScript; which is a subset of the Microsoft Visual Basic programming language.

MSXML Requirements

\n\n

Most of the scripts discussed in this document include some level of XML input and output. For these scripts to run and make the necessary internet requests, we will be utilizing MSXML which is a library of functions found in most installations of Windows.

It is likely that the example code included in this integration kit will work with the version of MSXML you have already installed. If you need further information on installing this library, please see the following link for help: http://support.microsoft.com/kb/324460/

Installing the Application

Prerequisites

\n\n

Before running the installer you should ensure that you have Microsoft .NET Framework 4.5 or higher installed. This can be downloaded directly from Microsoft using the following link if required.
http://www.microsoft.com/en-us/download/details.aspx?id=30653/

Installing

Request a sandbox account herehttp://why.pay.link/developers.
A developer support representative will email you the installer package and an activation code
Run the install package as administrator.
Enter the activation Code. To request an additional activation code, contact developer support at 888-472-9564 or devsupport@paymentlogistics.com.

Configuration Parameters

The following are the main configuration parameters that will be configured on your behalf by Payment Logistics. To request a configuration change, contact contact developer support at 888-472-9564 or devsupport@paymentlogistics.com.

HttpServerPort = 8080

The port number Client uses to listen for HTTP requests.

ServerDomainOrIP = 127.0.0.1

The IP address to listen on, which is normally set to 127.0.0.1, except when running on a server. See the Advanced Features section for more information.

Gateway = https://cert.paygistix.net

The URL of the Paygistix gateway. For certification and testing use https://cert.paygistix.net , for production use https://ipn3.paygistix.net.

HttpsServerPort = 8081

The port number to use when using a local SSL connection. Contact Payment Logistics about how to install a local certificate for SSL.

WatchFolder = “c:\\folder\\” or “\\\\UNCPath\\Folder”

When using the filedrop method (for legacy systems that do not want to support more modern HTTP communication methods), this folder is set to listen for file requests to trigger transactions. We recommend setting this value to a specific folder on the same machine that Paygistix Client is installed. Using UNC file paths are less efficient as they cause Paygistix Client to poll for files rather than use windows messaging which is trigger based.

SAFMode=Proactive|Auto

Proactive = If Paygistix Client detects that a transaction cannot be run online, SAF will automatically be enabled.

Auto = Paygistix Client reads the response from the Pax device and/or Gateway, and depending on the response, the cardholder will be prompted to run the transaction offline. Auto mode was created to cover scenarios not covered by proactive mode, and it can be enabled alongside proactive mode.

AllowOfflineVoid = ON | OFF

ON = Allow voids of offline transactions that have not yet been uploaded/
OFF = Blocks the voiding of offline transactions that have not yet been uploaded/

ReturnExtendedCardData = YES | NO

If this value is set to YES, additional response parameters are returned when calling transactions such as /pay/auth, /pay/repeatauth, /pay/sale, /pay/repeatsale, /pay/credit, and /pay/billcard. These additional response parameters are:

Last4 = last 4 digits of the credit or debit card account number used
Name = cardholder’s name

MinimizeOnStartup = YES | NO

When set to YES, the card BIN (Bank Identification Number) is returned in Paygistix Client’s response. This is useful for POS systems that need to categorize transactions by BIN.

ReformatName= YES | NO

Returns the cardholder’s name as LASTNAME/FIRSTNAME vs. the default FIRSTNAME LASTNAME. For POS systems that create bar tabs based on the cardholder’s name, enabling this setting puts the last name first, which is desirable for some bars.

Logging = YES | NO

When set to YES, this records local Paygistix Client events in a graphical interface. The interface records events live as they happen and is useful for troubleshooting. This interface appears on the same windows endpoint Paygistix Client is running on.

LogFullParams = YES | NO

When set to YES, the full request and response parameters are logged within the Paygistix Client Control Panel, which is accessible to Payment Logistics personnel. This setting is helpful for debugging, but it should not be left on in a production environment as it can create superfluous logs.

Trace = YES | NO

When set to YES, the full request and response parameters for PATT and PayLink are logged. This setting is helpful for debugging, but it should not be left on in a production environment as it can create superfluous logs.

ReturnExpDate = YES | NO

When set to YES, pay/auth and pay/sale transaction responses include the expiration date of the card. This applies to credit, debit, and EBT.

TipOnlySale = YES | NO

When set to YES, sales where the tip amount equals the amount paid are allowed.

EMVReceipt = YES | NO

When set to “yes,” EMV receipt data is returned in the transaction response for EMV transactions.

CaptureAllTenderType = CREDIT | DEBIT |EBT | ALL

When a CaptureAll request is sent to Paygistix Client, this setting determines whether only credit, debit, or EBT batches close, or whether all of them will be closed.

PAXMode = ON | SERVER

ON = Use a single PAX Device
SERVER = Run Paygistix Client in server mode allowing for remote requests and multiple PAX devices.

PAXDevice = “COM1, {deviceid},MT30” or “192.168.0.99:10009, {deviceid},MT30”

Either the Serial or TCP/IP connection for the PAX device; Payment Logistics will supply the deviceid relating to your specific PAX device. For TCP/IP you must supply the IP address followed by the port number. Can be setup as MT30, SP30, S80, D200, D210 or S300 depending on which PAX device you have. The PAXDevice configuration is intended for use where there is a single MT30, SP30, S80, D200, or D210 associated with the Paygistix Client when used with PAXMode=ON.

PAXUserMapping =User1,192.168.0.99:10009,{deviceid1},MT30|User2,192.168.0.98:10009,{deviceid2},MT30|{…}

Similar to the PAXDevice option above, but allows multiple devices to be bound to different Paygistix users when running in server mode. PAXUserMapping is ideally suited to a multilane environment where PAXMode=SERVER. You must choose either PAXUserMapping or PAXDevice, but not both.

SNMapping=Serial1,Token1,IPAddress:Port,TerminalType1| Serial2,Token2,IPAddress:Port,TerminalType2

Similar to the PAXUserMapping option above, but allows for the use of PAX IP Registration.

PAXCaptureSignature = YES | NO

Whether to cause a PAX device to prompt the cardholder for a signature by default. If set to “NO” this can be manually initiated by sending the optional “Signature = “YES” parameter when calling the /pay/auth or /pay/sale function. Please note, when the PAX device collects a signature from the cardholder during an Auth or Sale function, that signature is automatically sent to the Paygistix Gateway and archived along with the merchant’s copy of the receipt. To capture a signature without a transaction, use the getsignature function.

SignaturePath = “c:\\Signature{PNREF}.jpg”

The name of the file to write the signature file to. This will replace {PNREF} with the transaction reference returned from the /pay/sale or /pay/auth transaction. Please note, when a signature is captured as part of a /pay/auth or /pay/sale transaction, the signature is always sent to the Paygistix Gateway for archival. The SignaturePath configuration option allows an image of the signature to also be stored on the merchant’s local windows environment.

PAXSignStatus = YES | NO

When set to YES, a status variable is returned to indicate the nature of the capture or whether it succeeded or not. For SignStaus, the following responses are possible:

The signature was captured and stored on the terminal but not uploaded
The signature screen was aborted
The signature screen timed out
A signature was not captured
The signature uploaded successfully
The signature failed to upload
The signature was captured after the transaction had ended

PAXTipRequest = YES | NO

Whether to automatically support inline Tip’s on the PAX device. If set to NO this can be manually initiated using the “TipRequest = YES” parameter when calling the /pay/sale function.

PAXCreditDebitButtons = YES | NO

When set to YES, a call to the /pay/sale function prompts the cardholder to choose Credit or Debit on the payment device screen, after selection the cardholder is prompted to swipe their card. If set to “NO,” this can be manually initiated by sending the “PaxCreditDebitButtons=”YES” parameter when calling. Please note, when using this feature, you will not know what tender type is used prior to the transaction occurring since the cardholder can choose their tender type on the PAX device. As such you will need to parse the “CardType” response parameter to determine the tender type and account for the sale properly in your system where desired.

PAXAutoClearBatch = YES | NO | 0-23

When set to YES, at 2am local computer time the PAX device is cleared of stored transactions (Transactions are cleared since they serve no purpose due to the fact that they are batched by the Paygistix Gateway instead of the terminal). If an hour other than 2am is desired, a whole integer between 0-23 can be set (Ex: 0 is 12:00 AM, and 23 is 11:00 PM). If set to NO, the POS will be responsible for daily clearing of the transactions using the /pay/clearbatch function.

PAXTimeoutSeconds = Numeric Value

The number of seconds that Paygistix Client will wait for a transaction to complete on a PAX Terminal. The timer begins once the transaction is sent to the terminal. If not set, the default time is 300 seconds.

PaxButtons = CDEFCGL

This parameter determines which payment buttons are displayed on the PAX screen. Since PAX devices can only show 4 buttons at a time, a combination of 4 letters max can be sent. They are the letters: C, D, E, G, or L.. These letters represent different payment types: Credit, Debit, EBT, Gift Card, and Loyalty respectively. (Usage Example: “CD” will display Credit and Debit buttons in that order. “CDEG” will display Credit, Debit, EBT and Gift buttons in that order.

TerminalResponse = YES | NO

Returns the result text from the payment device in the parameter “TerminalMessage.”

EMVReceipt = YES | NO

When set to YES, extra EMV data will be returned by Paygistix Client for Chip Card transactions. This is necessary for printing EMV receipts.

MinimizeOnStartup = YES | NO

When enabled, the Paygistix Client application window will minimize after starting up. This reduces occurrences where end users close the application window accidentally.

Note on SSL/TLS:

Beginning in Paygistix Client version 1.1.9, the server is also configured by default to listen on port 8081 for HTTPS (SSL/TLS encrypted) traffic however some additional configuration steps are required on each station. Please contact Payment Logistics for assistance with SSL/TLS configuration.

Default Configuration upon installation:

SERVERDOMAINORIP = 127.0.0.1
SERVERPORT = 8080
HTTPSSERVERPORT = 8081
GATEWAY = https://paygistixcert.paymentlogistics.net
PAXMODE = OFF

\n\n

*Configuration settings are no longer within the PaygistixClient.exe.config file but are now contained within the settings.xml file. This new encrypted file can be configured away from its default settings with the help of your Payment Logistics support representative.

Launching Paygistix Client

\n\n

The installer will add the Paygistix Client local server application to the Windows user “Startup” folder ensuring that the server automatically listens once the user logs in. Following installation, you can also manually start the server by selecting Paygistix Client from Start->All Programs->Payment Logistics.

Paygistix Client can be run as a Windows Service. This is desirable for environments where the Windows machine running Paygistix Client is not always logged in with a windows user. To run Paygistix Client as a service, after installing:

On the Windows machine, in the Windows Startup Folder, delete the Paygistix Client shortcut
Go to Windows services
ind “Paygistix Client Monitor Service”
Start the service
Set the Startup type to Automatic
Save

Paygistix Client Application Infrastructure

The following graphics illustrate how Paygistix Client works in Client Mode and Server Mode.

Client Mode with Payment Terminal Option

\n\n

Server Mode with Payment Terminal - Compatible with POS Systems Running on All Operating Systems

\n\n

Paygistix Client runs as a local web server on a Windows endpoint. In Client mode it runs on the actual POS workstation and is designed to accept local requests. In Server mode, it runs on a networked Windows endpoint and is designed to accept requests from multiple other endpoints which could be POS workstations, POS servers, mobile endpoints web servers or a combination thereof. Your application connects directly to Paygistix Client via HTTP or HTTPS. All payment screens and integrated terminals are managed by Paygistix Client in separate memory space and Paygistix Client and its integrated terminals handle all connections to the Paygistix Gateway. An integration with Paygistix Client provides a secure means of transaction processing outside of your application, maintains the benefits of a fully integrated payment processing solution and eliminates many of the challenges faced by application developers which are associated with integrated payments.

Advanced Features

\n\n

In this section we will cover some additional more advanced features including running Paygistix Client on a server with multiple machines attaching to it as clients and a method to communicate via the file system rather than via HTTP/HTTPS.

Running Paygistix Client in Server Mode

The main purpose for running Paygistix Client in server mode is if you have a number of POS devices and you want to centralize a single dedicated machine to handle the transaction routing for you, or you have a non-windows environment and want to require only a single windows endpoint to use Paygistix Client with. A change must be made to the Paygistix Client configuration settings to ensure the server is listening on a valid network IP address. This must be a static IP address too. You will need to supply the static IP address you wish to use to Payment Logistics to have the Paygistix Client configuration updated.

Your server firewall rules must allow machines on the network to connect via TCP/IP over the allocated port. The default port Paygistix Client listens on for HTTP traffic is 8080. The default port Paygistix Client listens on for HTTPS traffic is 8081.

\n\n

Warning: When PAXMode is set to SERVER or ON, any functions called that involve interaction with the PAX device will use the “password” value that is pre-programmed in the PAX device and not the “password” sent in the call to the API.

Warning: Any functions called that DO NOT involve interaction with the PAX device will require the passing of the proper Paygistix username and password.

Calling Paygistix Client in Server Mode

\n\n

When calling Paygistix Client in Server mode, you must use the IP address and port of the server. An example of a VB script to call a sale which will initiate a transaction on a PAX device is as follows:

    'Setup URI for sale. Use IP address of server rather than local IP\n    Dim URI: URI = \"http://192.168.0.2:8080/pay/sale/?\"\n    'Append Username & Password (minimum requirements)\n    'set output type to XML for easy reading\n    URI = URI & \"Username=payg2783&Password=paylogtest&Output=XML\" \n    'Use MSXML to call the local web service\n    Dim xmlHttp: Set xmlHttp = CreateObject(\"Msxml2.ServerXMLHTTP\")\n    'Disable any timeouts\n    xmlHttp.setTimeouts 0,0,0,0\n    'Open the connection and send the request\n    xmlHttp.open \"GET\", URI, false\n    xmlHttp.send \n    'Output the response\n    WScript.echo \"Sample Script: Sale response\" & vbcrlf & xmlHttp.ResponseText\n    Set xmlHttp = nothing\n\n\n

Following the call to this function the PAX device will ask for a card to be swiped and on completion of the transaction the script will return the XML response to say if the transaction completed correctly or not.

Configuring multiple PAX devices when working in a networking environment

\n\n

When working with multiple PAX devices on a network it is advisable to set each one up with a different username on Paygistix. This way you can account for and report on the individual terminals transactions.

The configuration settings must have a PAXUserMapping parameter as follows “User1,192.168.0.99:10009,{deviceid1},MT30|User2,192.168.0.98:10009,{deviceid2},MT30|{…}”.

Please contact your Payment Logistics support representative to configure these settings on your behalf. When using PAXUserMapping, each PAX device should be configured with a static IP on the internal network.

You can setup as many device / user combinations as you like; each one is separated with a pipe “|“ symbol. When initiating a transaction, simply send the appropriate username through in the calling function and this will determine which device will be targeted.

Beginning with Paygistix Client version 2.2.3 release C, PAXUserMapping can be replaced with SNMapping. This allows PAX devices to be configured with dynamic IP addresses using DHCP. The PAX devices will automatically register their IP address with Paygistix which allows these devices to be plug and play. Anytime the device IP address changes, it is automatically updated in Paygistix in real-time.

In the example below you can see the only change you need to make to target a specific device is the Username parameter.

    'Setup URI for sale. Use IP address of server rather than local IP\n    Dim URI: URI = \"http://192.168.0.2:8080/pay/sale/?\"\n    'Append Username & Password (minimum requirements)\n    'set output type to XML for easy reading\n    URI = URI & \"Username=User1&Password=paylogtest&Output=XML\" \n    'Use MSXML to call the local web service\n    Dim xmlHttp: Set xmlHttp = CreateObject(\"Msxml2.ServerXMLHTTP\")\n    'Disable any timeouts\n    xmlHttp.setTimeouts 0,0,0,0\n    'Open the connection and send the request\n    xmlHttp.open \"GET\", URI, false\n    xmlHttp.send \n    'Output the response\n    WScript.echo \"Sample Script: Sale response\" & vbcrlf & xmlHttp.ResponseText\n    Set xmlHttp = nothing\n\n\n

Communicating via File Drop rather than HTTP

\n\n

Instead of using HTTP to communicate with Paygistix Client, you can set it up to work using files. This can come in handy when working with legacy systems that may have system limitations preventing HTTP(s) communication or are already accustomed to using a file drop method for payment integration.

WatchFolder = “c:\\folder\\” or “\\\\UNCPath\\Folder”
When using filedrop method, this folder is set to listen for file requests to trigger transactions. See the Advanced Section later in this guide for more information regarding the file drop method. We recommend where possible to set this value to a specific folder on the same machine that Paygistix Client is installed. UNC file paths are less efficient as they have to poll for files rather than use windows messaging which is trigger based.

Input files can be sent through as .TXT or .XML

For .TXT you need to pass through the values as Name Value Pairs. So for instance if you wanted to call a SALE using the test account, you would have the following content in your file.

Filename: c:\\drop files\\ABC123.TXT

\n\n

ServiceType=SALE\nUserName=payg2783\nPassword=paylogtest\nAmount=10\nInvoiceNumber=ABC123\nOutput=NVP\n\n

If you wish to use XML then you should output the file in the following format.

Filename: c:\\drop files\\ABC123.XML

\n\n

\"\n    SALE\n    payg2783\n    paylogtest\n    10.00\n    ABC123\n    XML\n\n

Paygistix Client monitors the watch folder for transaction files and when it sees a new one arrives it will consume the file and make the corresponding function call. Once the function has been processed, the result will be returned in a file with the same name as the input file but with the file extension .OUT. The response within the .out file will either be Name Value Pairs or XML depending on the format of the request.

Digital Receipts

ISVs who integrate with Paygistix Client can easily add support for PayLink Digital Receipts.

\n\n

What are Digital Receipts?

An online version of a receipt that customers receive via text message.

\n\n

What's the big deal with Digital Receipts anyway?

PayLink Digital Receipts allow ISVs to enhance the value proposition of their POS by enabling their merchants to connect with their customers digitally. For example, merchants can embed an advertisement, promotion, links to social media, website links, etc... right on the receipt itself.

Merchants can also enable PayLink Ratings to get valuable feedback from customers. When enabled, customers rate their experience from 1 to 5 stars right on the Digital Receipt. Merchants can then access this information in the PayLink Portal, empowering them to make informed decisions to improve their customer experience.

\n\n

How does a cardholder get their digital receipt?

When a cardholder is checking out through a Pax Device it will prompt them for their phone number. Then they'll complete their payment per usual (EMV, contactless, etc...). Afterwards they'll receive a text with a link to their digital receipt.

\n\n

Does this work for ecommerce or Direct-to-Pax applications?

Yes, but we offer a separate API for this. Contact devsupport@paymentlogistics.com for more information.

\n\n

Does this work for cash payments?

Not at this time.

\n\n

What does it cost?

Digital Receipts require merchants to sign up for a PayLink plan on https://why.pay.link.

\n\n

Specifications

Paygistix Client’s Digital Receipt feature offers customers the option of receiving a link to their receipt via text message. This works through a prompt on the payment device that asks the customer how they want to receive their receipt. The options are Print, SMS, or None. The result of the customer’s selection is returned in the payment response, and includes the customer’s phone number if applicable. The prompt is shown during the payment process when the transaction is being run on the terminal, and is not a separate request.

\n\n

The receipt is sent in the /pay/sale request, and is a Base64 Encoded string. The string should be 32 columns wide, with each column separated by the string “\\n”. At the end of the string, append the string “{BODY}”.

Sample string:

1 Avocado Toast            $9.00\\n* Lemon Slice                   \\n================================\\nTip                        $0.13\\nTotal                      $9.13\\n================================\\n{BODY}\n\n

This string would then get Base64 Encoded, and become:

MSBBdm9jYWRvIFRvYXN0ICAgICAgICAgICAgJDkuMDBcbiogTGVtb24gU2xpY2UgICAgICAgICAgICAgICAgICAgXG49PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PVxuVGlwICAgICAgICAgICAgICAgICAgICAgICAgJDAuMTNcblRvdGFsICAgICAgICAgICAgICAgICAgICAgICQ5LjEzXG49PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PVxue0JPRFl9\n\n

Example Request for a /pay/sale, with included receipt data:

\"\n    payg2783\n    paylogtest\n    9.13\n    9.13\n    ABC123\n    XML\nMSBBdm9jYWRvIFRvYXN0ICAgICAgICAgICAgJDkuMDBcbiogTGVtb24gU2xpY2UgICAgICAgICAgICAgICAgICAgXG49PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PVxuVGlwICAgICAgICAgICAgICAgICAgICAgICAgJDAuMTNcblRvdGFsICAgICAgICAgICAgICAgICAgICAgICQ5LjEzXG49PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PVxue0JPRFl9\n\n

This generates the following receipt, and texts it to the customer automatically:
https://dev.pay.link/mobile/cb200faa10894e13a285b4e4a0e2f51d

The payment/transaction response will include additional fields:

\n\n

ReceiptType:

S for SMS Text
P for Print
N for No Receipt

Since this field is not required, if it is not present in the response then use the default system behavior of the POS.

\n\n

SMSTextNumber:

This field should be present when ReceiptType=S.
The format of the SMSTextNumber is “+18885729564”.

Below is an example response returned from a MasterCard transaction using /pay/sale/:

\n\n

    10.00\n    OK7156\n    Address Match + 5 Zip\n    MASTERCARD\n    1a4a1d44-d715-4d7c-a3e5-f612d843c20c\n    ABC123\n    0026\n    APPROVED\n    John Doe\n    35898\n    SALE\n    0\n    Match\n    Match\n    S\n    +18885729564\n\n

Each merchant will need their own PayLink account. An account on our development servers will be provided for development, as well.

Receipt Guidelines

\n\n

With the introduction of EMV transactions comes new requirements for EMV transaction receipts. The purpose of this section is to provide guidelines for printing receipts for EMV transactions.

The following covers what new data will be included and how it will be returned in a Paygistix Client response. See below for examples of a typical transaction response and a paper receipt.

EMV Receipt Response Data
Below is a list and brief description of the Paygistix Client response parameters which will be included in the response returned for sale transactions in which an EMV card was used to complete the transaction.

Parameter Name	Full Name	Description
Method	Entry Method	Method signifies the mode of entry used to collect the cardholder data. Possible values are: Manual \| Swipe \| Contactless \| Scanner \| Chip \| Chip Fallback Swipe
TC	Transaction Certificate	A TC is a type of Application Cryptogram that is generated whenever a card approves a transaction during Card Action Analysis.
TVR	Terminal Verification Results	The TVR is a series of bits set by the terminal reading an EMV card, based on logical tests (for example has the card expired). This data object is used in the terminal's decision whether to accept, decline or go on-line for a payment transaction
AID	Application Identifier	An AID is used to uniquely identify each EMV application that a terminal supports, and every AID has an associated card scheme and parameters relating to how the application needs to be processed. A terminal may contain any number of such applications, and the list of each supported AID is used during Candidate List Creation to generate a list of applications that are mutually supported by both the terminal and the card.
TSI	Transaction Status Information	The TSI is a collection of indicators that the terminal will set to show what processing steps have been performed on the current transaction (e.g. Cardholder Verification, Data Authentication). Together with the TVR, this information enables the card and the host to manage risk and determine the correct outcome for the transaction.
ATC	Application Transaction Counter	A counter, maintained by the chip card application (incremented by the chip), that provides a sequential reference to each transaction. A duplicate ATC, a decrease in ATC or a large jump in ATC values may indicate data copying or other fraud to the issuer.
APPLAB	Application Label	Mnemonic associated with AID according to [ISO 7816-5]. Used in application selection. Application Label is optional in the File Control Information (FCI) of an Application Definition File (ADF) and optional in an ADF directory entry.
APPN	Application Preferred Name	EMV cards will often include an ‘application preferred name’, which is the name of the card application in the cardholder’s local language.
CVM	Cardholder Verification Method	Possible values are: PIN Verified \| Signature \| NotReq
PrintSigLine	Print Signature Line Indicator	This value indicates whether or not to print a signature line on a receipt.Possible values are: TRUE \| FALSE => TRUE = Print Signature Line \| FALSE = Don’t Print Signature Line

Example Paygistix Client EMV Transaction Response

\n\n

  10.00\n  OK9816\n  Address Match + 5 Zip\n  MASTERCARD\n  a687d6fe-1700-40f1-8be3-13bf14694dc5\n  ABC123\n  APPROVED\n  237122\n  TRUE\n  0\n     ***Example EMV Data***\n      Chip\n      9B45AB13C3101576\n      0200008000\n      A0000000041010\n      E800\n      0001\n      MasterCard\n      Signature\n\n

Example EMV Transaction Receipt

\n\n

In the image below the EMV data is highlighted in pink. This example does not include the APPN as it’s not returned for every EMV transaction.

Besides EMV data, other data that should be printed on both EMV and non EMV receipts are: Card Type, Last 4 of Card number, Authorization Code, Merchant Name, Date, PNRef Number, Response (known as “Message” in the Paygistix Client Developers Guide), Date, and Time. See the Paygistix Client Developers guide for more information on obtaining the above data. Please note, as you will see below, in most cases using abbreviations to describe the data title is acceptable so long the title is reasonably identifiable.

Questions? Contact developer support at 888-472-9564

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"About this guide","slug":"about-this-guide"},{"content":"Installing the Application","slug":"installing-the-application"},{"content":"Configuration Parameters","slug":"configuration-parameters"},{"content":"Advanced Features","slug":"advanced-features"},{"content":"Digital Receipts","slug":"digital-receipts"},{"content":"Receipt Guidelines","slug":"receipt-guidelines"}],"owner":"3936658","collectionId":"a9afa7ed-e267-4239-a688-a54724dde0ff","publishedId":"TWDRqyxX","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"EBEBEB","highlight":"006fba"},"publishDate":"2021-10-13T20:27:38.000Z"},"item":[{"name":"Transaction Requests","item":[{"name":"Function pay/auth","id":"e43f9e9a-447e-4406-8b3a-aecae64b8a09","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"description":"

*Your Paygistix Web Service User Name (required)

\n","key":"Username","type":"text","value":""},{"description":"

*Your Paygistix Web Service Password (required)

\n","key":"Password","type":"text","value":""},{"description":"

Total Sale Amount (including any tip)\nType: Numeric\nFormat: 0.00\nMax: 99999.99

\n","key":"Amount","type":"text","value":""},{"description":"

Invoice number associated with the transaction

Type: Alphanumeric (spaces and hyphens allowed)

\n","key":"InvoiceNumber","type":"text","value":""},{"description":"

Forces the structure of the returned response\nOptions: \nXML(Default)\nNVP\nNVPCRLF\nJSON

\n","key":"Output","type":"text","value":""},{"description":"

A file name allocated to receive the response into allowing the web service to be called asynchronously\nExample: c:\\result.txt

\n","key":"FileName","type":"text","value":""},{"description":"

Options\nYES=the PAX device will request a signature

\n","key":"Signature","type":"text","value":""},{"key":"ReceiptTemplateBase64","value":"","description":"

The itemized receipt data as a Base64 Encoded string, 32 columns wide, and separated by the sting \"\\n\" with the string \"{BODY}\" appended to the end. (required)

\n","type":"text"}]},"url":"http://localhost:8080/pay/auth/","description":"

Use this function to request an authorization.

To call this function you need to request the service at http://[IPAddressOfServer]:8080/pay/auth/

Example XML envelope with several optional parameters selected:

<?xml version=\"1.0\" encoding=\"utf-8\"?>\"\n  <Request>\n    <UserName>payg2783</UserName>\n    <Password>paylogtest</Password>\n    <Amount>10.00</Amount>\n    <InvoiceNumber>ABC123</InvoiceNumber>\n    <Output>XML</Output>\n    <FileName>c:\\result.txt</FileName>\n    <ReceiptTemplateBase64></ReceiptTemplateBase64>\n  </Request> \n

An example script calling the /pay/auth/ function with the same optional parameters selected:

<job id=\"Paygistix_Test\">\n<script language=\"VBScript\">\n    'Setup a URI to the payment service \n    Const URI = http://localhost:8080/pay/auth/\n    'Create a Request envelope to send to the service\n    Dim sEnvelope\n    sEnvelope = \"<?xml version=\"\"1.0\"\" encoding=\"\"utf-8\"\"?>\"  & _\n        \"<Request>\" & _\n        \"   <UserName>payg2783</UserName>\" & _ \n        \"   <Password>paylogtest</Password>\" & _ \n        \"   <Amount>10.00</Amount>\" & _ \n        \"   <InvoiceNumber>ABC123</InvoiceNumber>\" & _ \n        \"   <Output>XML</Output>\" & _ \n        \"   <FileName>c:\\result.txt</FileName>\" & _ \n        \"</Request>\" \n    'Use MSXML to call the local web service\n    Dim xmlHttp: Set xmlHttp = CreateObject(\"Msxml2.ServerXMLHTTP\")\n    xmlHttp.open \"POST\", URI , false\n    xmlHttp.setRequestHeader \"Content-Type\",\"text/xml\"\n    xmlHttp.send sEnvelope \n    'output the response GUID\n    WScript.echo xmlHttp.ResponseText\n</script>\n</job>\n

Because a Filename is passed when calling the function, the calling script will return a GUID only which is a unique identifier that can be used to validate the result file later. In our test case the value 1c5137e1-c5f7-47a9-ab1f-7e58b0e9f177 is returned.

On completing a test transaction the file c:\\result.txt gets created with the following content.

<?xml version=\"1.0\" encoding=\"utf-8\"?>\n  <Response>\n    <Amount>10.00</Amount>\n    <AuthCode>OK160C</AuthCode>\n    <AVSResult>Address Match + 5 Zip</AVSResult>\n    <CardType>MASTERCARD</CardType> \n    <Guid>1c5137e1-c5f7-47a9-ab1f-7e58b0e9f177</Guid>\n    <InvoiceNumber>ABC123</InvoiceNumber>\n    <Last4>0026</Last4>\n    <Message>APPROVED</Message>\n           <Name>John Doe</Name>\n    <PNRef>35898</PNRef>\n    <ServiceType>AUTH</ServiceType>\n    <Status>0</Status>\n    <StreetMatch>Match</StreetMatch>\n    <ZipMatch>Match</ZipMatch>\n  </Response>\n

","urlObject":{"protocol":"http","path":["pay","auth",""],"host":["localhost:8080"],"query":[],"variable":[]}},"response":[{"id":"d88ae690-20ce-41d7-8fcb-91f8b74d7b19","name":"Function pay/auth","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"description":"*Your Paygistix Web Service User Name (required) ","key":"Username","type":"text","value":""},{"description":"*Your Paygistix Web Service Password (required) ","key":"Password","type":"text","value":""},{"description":"Total Sale Amount (including any tip)\nType: Numeric\nFormat: 0.00\nMax: 99999.99","key":"Amount","type":"text","value":""},{"description":"Invoice number associated with the transaction\n\nType: Alphanumeric (spaces and hyphens allowed)\n","key":"InvoiceNumber","type":"text","value":""},{"description":"Forces the structure of the returned response\nOptions: \nXML(Default)\nNVP\nNVPCRLF\nJSON","key":"Output","type":"text","value":"XML"},{"description":"A file name allocated to receive the response into allowing the web service to be called asynchronously\nExample: c:\\result.txt","key":"FIleName","type":"text","value":""},{"description":"Options\nYES=the PAX device will request a signature","key":"Signature","type":"text","value":""}]},"url":"http://localhost:8080/pay/auth/"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"\n \n 10.00\n OK160C\n Address Match + 5 Zip\n MASTERCARD \n 1c5137e1-c5f7-47a9-ab1f-7e58b0e9f177\n ABC123\n 0026\n APPROVED\n John Doe\n 35898\n AUTH\n 0\n Match\n Match\n \n"}],"_postman_id":"e43f9e9a-447e-4406-8b3a-aecae64b8a09"},{"name":"Function pay/repeatauth","event":[{"listen":"test","script":{"id":"be561b6e-3b19-4b73-a33c-2b72fde9c743","exec":[""],"type":"text/javascript"}}],"id":"9be607df-d0d7-43e6-b0b7-bab4f37b52bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"description":"

*Your Paygistix Web Service User Name (required)

\n","key":"Username","type":"text","value":""},{"description":"

*Your Paygistix Web Service Password (required)

\n","key":"Password","type":"text","value":""},{"description":"

*PNRef returned in a response from a previous transaction (required)

\n","key":"PNRef","type":"text","value":""},{"description":"

Total Sale Amount (including any tip)\nType: Numeric\nFormat: 0.00\nMax: 99999.99

\n","key":"Amount","type":"text","value":""},{"description":"

Invoice number associated with the transaction \nType: Alphanumeric (spaces and hyphens allowed)

\n","key":"InvoiceNumber","type":"text","value":""},{"description":"

Forces the structure of the returned response\nOptions:\nXML(Default)\nNVP\nNVPCRLF\nJSON

\n","key":"Output","type":"text","value":""},{"description":"

A file name allocated to receive the response into allowing the web service to be called asynchronously\nExample: c:\\result.txt

\n","key":"FIleName","type":"text","value":""}]},"url":"http://localhost:8080/pay/repeatauth/","description":"

This function is used to authorize a card using a PNRef from a previous transaction. The repeatauth function has no user interface and requires no cardholder data be inputted. Instead, the PNRef serves as a token which references cardholder data that is securely stored in the Paygistix Gateway.

To call this function you need to request the service at http://[IPAddressOfServer]:8080/pay/repeatauth/

An example XML envelope to be sent as a request with all parameters selected.

<?xml version=\"1.0\" encoding=\"utf-8\"?>\"\n  <Request>\n    <UserName>payg2783</UserName>\n    <Password>paylogtest</Password>\n    <PNRef>240542</PNRef>\n    <Amount>10.00</Amount>\n    <InvoiceNumber>ABC123</InvoiceNumber>\n    <Output>XML</Output>\n    <FileName>c:\\result.txt</FileName>\n  </Request> \n

Example response returned from a call to /pay/repeatauth/. Notice how there is an OriginalPNRef response parameter in addition to the PNRef response parameter. The OriginalPNRef response parameter is the PNRef that was submitted in the request message. The PNRef parameter is the PNRef returned as a result of the repeat auth transaction.

<?xml version=\"1.0\" encoding=\"utf-8\"?>\n  <Response>\n    <Amount>10.00</Amount>\n    <AuthCode>OK7156</AuthCode>\n    <CardType>MASTERCARD</CardType>\n    <Guid>e6427238-3279-4370-ad6c-1a6a38cac985</Guid>\n    <InvoiceNumber>ABC123</InvoiceNumber> \n    <Last4>0026</Last4>\n    <Message>APPROVED</Message>\n    <Name>John Doe</Name>\n    <OriginalPNRef>240542</OriginalPNRef>\n    <PNRef>241840</PNRef>\n    <ServiceType>REPEATAUTH</ServiceType>\n    <Status>0</Status>\n  </Response>\n

The Request Parameters you can pass to this function are as follows:

\n","urlObject":{"protocol":"http","path":["pay","repeatauth",""],"host":["localhost:8080"],"query":[],"variable":[]}},"response":[{"id":"0747a101-a226-4143-bcaf-17abf4042ee4","name":"Function pay/repeatauth","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"description":"*Your Paygistix Web Service User Name (required)","key":"Username","type":"text","value":""},{"description":"*Your Paygistix Web Service Password (required)","key":"Password","type":"text","value":""},{"description":"*PNRef returned in a response from a previous transaction (required)","key":"PNRef","type":"text","value":""},{"description":"Total Sale Amount (including any tip)\nType: Numeric\nFormat: 0.00\nMax: 99999.99","key":"Amount","type":"text","value":""},{"description":"Invoice number associated with the transaction \nType: Alphanumeric (spaces and hyphens allowed)","key":"InvoiceNumber","type":"text","value":""},{"description":"Forces the structure of the returned response\nOptions:\nXML(Default)\nNVP\nNVPCRLF\nJSON","key":"Output","type":"text","value":"XML"},{"description":"A file name allocated to receive the response into allowing the web service to be called asynchronously\nExample: c:\\result.txt","key":"FIleName","type":"text","value":""}]},"url":"http://localhost:8080/pay/repeatauth/"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"\r\n \r\n 10.00\r\n OK7156\r\n MASTERCARD\r\n e6427238-3279-4370-ad6c-1a6a38cac985\r\n ABC123 \r\n 0026\r\n APPROVED\r\n John Doe\r\n 240542\r\n 241840\r\n REPEATAUTH\r\n 0\r\n \r\n"}],"_postman_id":"9be607df-d0d7-43e6-b0b7-bab4f37b52bc"},{"name":"Function pay/sale","event":[{"listen":"test","script":{"id":"3ca4e23a-03d3-4636-a3d9-032354a8009d","exec":[""],"type":"text/javascript"}}],"id":"fde8d159-c06a-41b2-9a40-f8a227af03ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"description":"

*Your Paygistix Web Service User Name (required)

\n","key":"Username","type":"text","value":""},{"description":"

*Your Paygistix Web Service Password (required)

\n","key":"Password","type":"text","value":""},{"description":"

Can specify Credit, Debit, Gift, Loyalty or EBT. This sets the transaction type. If using a PAX terminal, this will skip the transaction type buttons and proceed to prompt the customer to swipe now for the specified tender type. If left blank, the customer will be prompted to perform a credit transaction.

If it’s desired to prompt the cardholder to select their card type, use PaxButtons (see below).

\n","key":"TenderType","type":"text","value":""},{"description":"

Total Sale Amount (including any tip) (required)\nType: Numeric\nFormat: 0.00\nMax: 99999.99

\n","key":"Amount","type":"text","value":""},{"description":"

Mandatory gratuity amount. Please note, this amount is informational only and not added to the total amount; therefore, be sure to include the tip in the above “Amount” parameter. In other words, the TipAmount is the portion of the “Amount” that is allocated as a tip and is passed to the Paygistix Gateway as a tip. This feature is appropriate for any situation where a gratuity is mandatory such as in many restaurant settings where large parties have gratuities automatically added to them. To adjust the tip after the original sale is completed, see section 3.14 (Function /pay/addtip), and section 3.15 (Function /pay/addtipnoui).

\n","key":"TipAmount","type":"text","value":""},{"description":"

When set to YES, this will cause a PAX device to prompt for an inline tip (i.e. the payment device will prompt the cardholder to select a tip amount). This parameter can only be used when UseDevice=YES or PaxMode=ON or Server. When used in conjunction with the optional TipAmount parameter, this will prompt the cardholder to add a tip in addition to the mandatory gratuity supplied in the “TipAmount” parameter and the entire gratuity (TipAmount + any additional gratuity resulting from TipRequest) will be sent to Paygistix Gateway denoted as a gratuity. If a cardholder adds a tip, it will be returned in the response so the POS can add it to it’s records.

\n","key":"TipRequest","type":"text","value":""},{"description":"

Invoice number associated with the transaction \nType: Alphanumeric (spaces and hyphens allowed)

\n","key":"InvoiceNumber","type":"text","value":""},{"description":"

Forces the structure of the returned response\nOptions:\nXML(Default)\nNVP\nNVPCRLF\nJSON

\n","key":"Output","type":"text","value":""},{"description":"

A file name allocated to receive the response into allowing the web service to be called asynchronously\nExample: c:\\result.txt

\n","key":"FileName","type":"text","value":""},{"description":"

Options YES=the payment device will request a signature

\n","key":"Signature","type":"text","value":""},{"description":"

This parameter determines which payment buttons are displayed on the PAX screen. Since PAX devices can only show 4 buttons at a time, a combination of 4 letters max can be sent. Valid letters are: C, D, E, G, or L.. These letters represent different payment types: Credit, Debit, EBT, Gift Card, and Loyalty respectively. (Usage Example: “CD” will display Credit and Debit buttons in that order. “CDEG” will display Credit, Debit, EBT and Gift buttons in that order.

\n","key":"PaxButtons","type":"text","value":""},{"key":"ReceiptTemplateBase64","value":"","description":"

The itemized receipt data as a Base64 Encoded string, 32 columns wide, and separated by the sting \"\\n\" with the string \"{BODY}\" appended to the end. (required)

\n","type":"text"}]},"url":"http://localhost:8080/pay/sale/","description":"

Use this function to process a sale transaction.

To call this function you need to request the service at http:// [IPAddressOfServer] :8080/pay/sale/

Example response returned from an EBT transaction using /pay/sale/

<?xml version=\"1.0\" encoding=\"utf-8\"?>\n  <Response>\n    <Amount>10.00</Amount>\n    <AuthCode>346549</AuthCode>\n    <Balance>50.00</Balance>\n    <CardType>EBT</CardType>\n    <Guid>cf712d8e-6908-440e-bd07-71855cb51c46</Guid>\n    <InvoiceNumber>ABC123</InvoiceNumber>\n    <Last4>0026</Last4>\n    <Message>APPROVED</Message>\n    <Name>John Doe</Name>\n    <PNRef>10035718</PNRef>\n    <Requested_Amount>10.00</Requested_Amount>\n    <ServiceType>SALE</ServiceType>\n    <Status>0</Status>\n    <Total_Amount>10.00</Total_Amount>\n  </Response>\n

The Request Parameters you can pass to this function are as follows:

\n","urlObject":{"protocol":"http","path":["pay","sale",""],"host":["localhost:8080"],"query":[],"variable":[]}},"response":[{"id":"3bd85eb8-128b-46c7-b6e9-9a60b411930b","name":"Function pay/sale","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"description":"*Your Paygistix Web Service User Name (required)","key":"Username","type":"text","value":""},{"description":"*Your Paygistix Web Service Password (required)","key":"Password","type":"text","value":""},{"description":"Can specify Credit, Debit, Gift, Loyalty, FoodStamp, CashBenefit, or EBT. This sets the transaction type. If using a PAX terminal, this will skip the transaction type buttons and proceed to prompt the customer to swipe now for the specified tender type. If left blank, the customer will be prompted to perform a credit transaction.\n\nIf it’s desired to prompt the cardholder to select their card type, use PaxButtons (see below).","key":"TenderType","type":"text","value":""},{"description":"Total Sale Amount (including any tip) (required)\nType: Numeric\nFormat: 0.00\nMax: 99999.99","key":"Amount","type":"text","value":""},{"description":"Mandatory gratuity amount. Please note, this amount is informational only and not added to the total amount; therefore, be sure to include the tip in the above “Amount” parameter. In other words, the TipAmount is the portion of the “Amount” that is allocated as a tip and is passed to the Paygistix Gateway as a tip. This feature is appropriate for any situation where a gratuity is mandatory such as in many restaurant settings where large parties have gratuities automatically added to them. To adjust the tip after the original sale is completed, see section 3.14 (Function /pay/addtip), and section 3.15 (Function /pay/addtipnoui).","key":"TipAmount","type":"text","value":""},{"description":"When set to YES, this will cause a PAX device to prompt for an inline tip (i.e. the payment device will prompt the cardholder to select a tip amount). This parameter can only be used when UseDevice=YES or PaxMode=ON or Server. When used in conjunction with the optional TipAmount parameter, this will prompt the cardholder to add a tip in addition to the mandatory gratuity supplied in the “TipAmount” parameter and the entire gratuity (TipAmount + any additional gratuity resulting from TipRequest) will be sent to Paygistix Gateway denoted as a gratuity. If a cardholder adds a tip, it will be returned in the response so the POS can add it to it’s records.","key":"TipRequest","type":"text","value":""},{"description":"Invoice number associated with the transaction \nType: Alphanumeric (spaces and hyphens allowed)","key":"InvoiceNumber","type":"text","value":""},{"description":"Forces the structure of the returned response\nOptions:\nXML(Default)\nNVP\nNVPCRLF\nJSON","key":"Output","type":"text","value":""},{"description":"A file name allocated to receive the response into allowing the web service to be called asynchronously\nExample: c:\\result.txt","key":"FIleName","type":"text","value":""},{"description":"Options YES=the payment device will request a signature","key":"Signature","type":"text","value":""},{"description":"This parameter determines which payment buttons are displayed on the PAX screen. Since PAX devices can only show 4 buttons at a time, a combination of 4 letters max can be sent. Valid letters are: C, D, E, G, or L.. These letters represent different payment types: Credit, Debit, EBT, Gift Card, and Loyalty respectively. (Usage Example: “CD” will display Credit and Debit buttons in that order. “CDEG” will display Credit, Debit, EBT and Gift buttons in that order.","key":"PaxButtons","type":"text","value":""}]},"url":"http://localhost:8080/pay/sale/"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"\r\n \r\n 10.00\r\n OK7156\r\n Address Match + 5 Zip\r\n MASTERCARD\r\n 1a4a1d44-d715-4d7c-a3e5-f612d843c20c\r\n ABC123\r\n 0026\r\n APPROVED\r\n John Doe\r\n 35898\r\n SALE\r\n 0\r\n Match\r\n Match\r\n \r\n"}],"_postman_id":"fde8d159-c06a-41b2-9a40-f8a227af03ad"},{"name":"Function pay/repeatsale","event":[{"listen":"test","script":{"id":"02713377-e44a-4c89-9584-6843091189e8","exec":[""],"type":"text/javascript"}}],"id":"b8cef079-f88d-4a3d-9893-f34ba2d43bfc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"description":"

*Your Paygistix Web Service User Name (required)

\n","key":"Username","type":"text","value":""},{"description":"

*Your Paygistix Web Service Password (required)

\n","key":"Password","type":"text","value":""},{"key":"PNRef","value":"","description":"

*PNRef returned in a response from a previous transaction (required)

\n","type":"text"},{"description":"

*Total Sale Amount (including any tip) (required)\nType: Numeric\nFormat: 0.00\nMax: 99999.99

\n","key":"Amount","type":"text","value":""},{"description":"

\n","key":"TipAmount","type":"text","value":""},{"description":"

Invoice number associated with the transaction \nType: Alphanumeric (spaces and hyphens allowed)

\n","key":"InvoiceNumber","type":"text","value":""},{"description":"

Forces the structure of the returned response\nOptions:\nXML(Default)\nNVP\nNVPCRLF\nJSON

\n","key":"Output","type":"text","value":""},{"description":"

A file name allocated to receive the response into allowing the web service to be called asynchronously\nExample: c:\\result.txt

\n","key":"FIleName","type":"text","value":""}]},"url":"http://localhost:8080/pay/repeatsale/","description":"

This function is used to process a sale on a card using a PNRef from a previous transaction. The repeatsale function has no interface and requires no cardholder data be inputted. Instead, the PNRef serves as a token which references cardholder data that is securely stored in the Payment Logistics PCI DSS level 1 validated Paygistix Gateway environment.

In the example response returned from a call to /pay/repeatsale/. Notice how there is an OriginalPNRef response parameter in addition to the PNRef response parameter. The OriginalPNRef response parameter is the PNRef that was submitted in the request message. The PNRef parameter is the PNRef returned as a result of the repeatsale transaction.

To call this function you need to request the service at http://[IPAddressOfServer]:8080/pay/repeatsale

The Request Parameters you can pass to this function are as follows:

\n","urlObject":{"protocol":"http","path":["pay","repeatsale",""],"host":["localhost:8080"],"query":[],"variable":[]}},"response":[{"id":"8aaadad1-1285-4df3-8ac4-254d9a657e0d","name":"Function pay/repeatsale","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"description":"*Your Paygistix Web Service User Name (required)","key":"Username","type":"text","value":""},{"description":"*Your Paygistix Web Service Password (required)","key":"Password","type":"text","value":""},{"description":"*PNRef returned in a response from a previous transaction (required)","key":"PNRef","type":"text","value":""},{"description":"*Total Sale Amount (including any tip) (required)\nType: Numeric\nFormat: 0.00\nMax: 99999.99","key":"Amount","type":"text","value":""},{"description":"Mandatory gratuity amount. Please note, this amount is informational only and not added to the total amount; therefore, be sure to include the tip in the above “Amount” parameter. In other words, the TipAmount is the portion of the “Amount” that is allocated as a tip and is passed to the Paygistix Gateway as a tip. This feature is appropriate for any situation where a gratuity is mandatory such as in many restaurant settings where large parties have gratuities automatically added to them. To adjust the tip after the original sale is completed, see section 3.14 (Function /pay/addtip), and section 3.15 (Function /pay/addtipnoui).","key":"TipAmount","type":"text","value":""},{"description":"Invoice number associated with the transaction \nType: Alphanumeric (spaces and hyphens allowed)","key":"InvoiceNumber","type":"text","value":""},{"description":"Forces the structure of the returned response\nOptions:\nXML(Default)\nNVP\nNVPCRLF\nJSON","key":"Output","type":"text","value":""},{"description":"A file name allocated to receive the response into allowing the web service to be called asynchronously\nExample: c:\\result.txt","key":"FIleName","type":"text","value":""}]},"url":"http://localhost:8080/pay/repeatsale/"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"\r\n \r\n 10.00\r\n OK171C\r\n VISA\r\n 07de9843-bb66-4db4-a913-50b3870b3f8c\r\n ABC1230026\r\n 0026\r\n APPROVED\r\n John Doe\r\n 35905\r\n 241840\r\n REPEATSALE\r\n 0\r\n \r\n"}],"_postman_id":"b8cef079-f88d-4a3d-9893-f34ba2d43bfc"},{"name":"Function pay/force","event":[{"listen":"test","script":{"id":"224875c9-921f-4149-b22a-5841761332fd","exec":[""],"type":"text/javascript"}}],"id":"80902df0-fe22-4829-abfe-84a9c997fe38","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"description":"

*Your Paygistix Web Service User Name (required)

\n","key":"Username","type":"text","value":""},{"description":"

*Your Paygistix Web Service Password (required)

\n","key":"Password","type":"text","value":""},{"key":"PNRef","value":"","description":"

*Transaction reference of an existing Auth transaction (required)