Adapter - Fiserv
This page describes version 2.0.1 of the adapter.
Overview
This adapter is used to connect a hospitality kiosk solution to a Fiserv payment processing device.
The adapter can be used to initiate credit card transactions, monitor their status, and run end of day reports using Fiserv's payment processing solution.
The Fiserv device is connected to a USB port on the Kiosk Client.
The Serial2TCP Windows service must be configured to connect to the Kiosk Router and to communicate
with the serial port of the connected payment device.
Supported Devices
The following payment devices are supported:
The adapter connects to Kiosk Router using information specified in the adapter properties.
- The URL to the Kiosk Server such as https://kioskserver:8080.
- The Kiosk position name where the device is connected.
- The router token specified in Serial2TCP on the device.
- The client certificate and private key for the adapter to connect.
- This is available in Kiosk Admin under UIP Adapter Connection in Connection Settings.
The Kiosk position name and router token together make a unique key to match the adapter and Serial2TCP running on the client.
Properties
| Name |
Display |
Is Required |
Comments |
Type |
Default Value |
Maximum Value |
Minimum Value |
Maximum Length |
Minimum Length |
| url |
Kiosk Router URL |
True |
The URL of the Kiosk Router (e.g https://address:8080). |
string |
|
|
|
1024 |
1 |
| client |
Kiosk Position |
True |
The name of the Kiosk Position hosting the Fiserv device. |
string |
|
|
|
256 |
1 |
| token |
Kiosk Router Token |
True |
The token defined in the Serial2Tcp Proxy on the Kiosk Position. |
string |
|
|
|
1024 |
1 |
| certificate |
Certificate |
True |
The UIP Adapter Connection Certificate found in Kiosk Admin's Connection Settings. |
string |
|
|
|
|
|
| privateKey |
Private Key |
True |
The UIP Adapter Connection Private Key found in Kiosk Admin's Connection Settings. |
password |
|
|
|
|
|
| commandTimeoutSeconds |
Command Times Out After (seconds) |
False |
The number of seconds to wait for a response to a command sent to the Fiserv device. |
integer |
60 |
86400 |
1 |
|
|
| reconnectIntervalSeconds |
Reconnect Every (seconds) |
False |
The number of seconds to wait in between attempts to reconnect to the Fiserv device. |
integer |
5 |
86400 |
1 |
|
|
| connectionCheckIntervalMinutes |
Check Connection Every (minutes) |
False |
The number of minutes to wait in between connection checks to the Fiserv device. |
integer |
60 |
1440 |
1 |
|
|
Commands
Sale (sale)
Run a one-time sale on the Fiserv device.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| amt |
Sale Amount |
The amount requested for the sale; the decimal point will be assumed. E.g. 200 will be read as 2.00 |
True |
string |
| tipAmt |
Tip Amount |
The tip amount for the sale; the decimal point will be assumed. E.g. 200 will be read as 2.00 |
False |
string |
| detail |
Return Detail |
Does the response message contain details or is it in a simple format? |
False |
boolean |
| ecrRef |
ECR Reference Number |
A unique value for the electronic cash register reference, up to 32 digits. |
False |
string |
Response Properties
| Name |
Description |
Type |
| status |
Transaction status ('P' - processing, 'A' - approved, or 'R' - rejected) |
string |
| rspCode |
Response Code |
string |
| rspText |
Description of the response code |
string |
| ecrRef |
A unique value for the electronic cash register reference, up to 32 digits |
string |
| txnId |
The transaction ID (invoice #) |
string |
| txnDate |
Date of the transaction in YYYYMMDD format |
string |
| txnTime |
Time of the transaction in HHMM format |
string |
| appCode |
The approval code of the transaction |
string |
| amt |
The amount of the transaction |
string |
| adjAmt |
The amount of the transaction adjusted to include tips |
string |
| cardType |
Visa (VISA), Mastercard (MASTER), American Express (AMEX), China Union Pay (CUP), etc. |
string |
| pan |
Credit card # (masked if terminal configured appropriately) |
string |
| expData |
Expiration Date of the card in YYMM format |
string |
| cardHolderName |
Name of the cardholder |
string |
| entryMode |
Point of sale entry mode ('S' – Swipe, 'C' – Chip Insert, 'F' – Fallback Swipe, 'T' – Contactless Tap, 'M' – Manual Input, 'Q' - QR Code) |
string |
| terminalId |
The 8-digit terminal ID |
string |
| merchantID |
The 15-digit merchant ID |
string |
| batchNo |
A six digit batch # |
string |
| referenceNo |
The reference # from the bank host |
string |
| appName |
EMV Application Label Name |
string |
| aid |
A 16-digit application ID |
string |
| tc |
A 16-digit cryptogram |
string |
| tvr |
The 10-digit EMV transaction verification result |
string |
| tsi |
The 4-digit EMV transaction status information |
string |
| atc |
A 4-digit transaction counter |
string |
| noSign |
Is signature required? |
boolean |
| stt |
Is this a small ticket transaction (below a certain limit)? |
boolean |
| preAuthID1 |
The first unique ID to identify a card not present pre-auth transaction |
string |
| preAuthID2 |
The second unique ID to identify a card not present pre-auth transaction |
string |
| foreignAmt |
The amount in foreign currency for DCC opt-in transactions |
string |
| fxRate |
The conversion rate for DCC opt-in transactions |
string |
| cardHolderCode |
The currency of the cardholder for DCC opt-in transactions |
string |
| txnCurrCode |
The local currency of the transaction for DCC opt-in transactions |
string |
| emiPerMonth |
The per-month EMI |
string |
| interestAmt |
The per-month interest amount |
string |
| tenure |
The tenure of EMI |
string |
Void (void)
Void a sale on the Fiserv device.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| txnId |
Transaction ID |
The transaction ID (invoice #) |
True |
string |
| detail |
Return Detail |
Does the response message contain details or is it in a simple format? |
False |
boolean |
| pwd |
Void Password |
The password for voiding transactions |
False |
string |
| ecrRef |
ECR Reference Number |
A unique value for the electronic cash register reference, up to 32 digits. |
False |
string |
Response Properties
| Name |
Description |
Type |
| status |
Transaction status ('P' - processing, 'A' - approved, or 'R' - rejected) |
string |
| rspCode |
Response Code |
string |
| rspText |
Description of the response code |
string |
| ecrRef |
A unique value for the electronic cash register reference, up to 32 digits |
string |
| txnId |
The transaction ID (invoice #) |
string |
| txnDate |
Date of the transaction in YYYYMMDD format |
string |
| txnTime |
Time of the transaction in HHMM format |
string |
| appCode |
The approval code of the transaction |
string |
| amt |
The amount of the transaction |
string |
| adjAmt |
The amount of the transaction adjusted to include tips |
string |
| cardType |
Visa (VISA), Mastercard (MASTER), American Express (AMEX), China Union Pay (CUP), etc. |
string |
| pan |
Credit card # (masked if terminal configured appropriately) |
string |
| expData |
Expiration Date of the card in YYMM format |
string |
| cardHolderName |
Name of the cardholder |
string |
| entryMode |
Point of sale entry mode ('S' – Swipe, 'C' – Chip Insert, 'F' – Fallback Swipe, 'T' – Contactless Tap, 'M' – Manual Input, 'Q' - QR Code) |
string |
| terminalId |
The 8-digit terminal ID |
string |
| merchantID |
The 15-digit merchant ID |
string |
| batchNo |
A six digit batch # |
string |
| referenceNo |
The reference # from the bank host |
string |
| appName |
EMV Application Label Name |
string |
| aid |
A 16-digit application ID |
string |
| tc |
A 16-digit cryptogram |
string |
| tvr |
The 10-digit EMV transaction verification result |
string |
| tsi |
The 4-digit EMV transaction status information |
string |
| atc |
A 4-digit transaction counter |
string |
| noSign |
Is signature required? |
boolean |
| stt |
Is this a small ticket transaction (below a certain limit)? |
boolean |
| preAuthID1 |
The first unique ID to identify a card not present pre-auth transaction |
string |
| preAuthID2 |
The second unique ID to identify a card not present pre-auth transaction |
string |
| foreignAmt |
The amount in foreign currency for DCC opt-in transactions |
string |
| fxRate |
The conversion rate for DCC opt-in transactions |
string |
| cardHolderCode |
The currency of the cardholder for DCC opt-in transactions |
string |
| txnCurrCode |
The local currency of the transaction for DCC opt-in transactions |
string |
| emiPerMonth |
The per-month EMI |
string |
| interestAmt |
The per-month interest amount |
string |
| tenure |
The tenure of EMI |
string |
Refund (refund)
Refund an amount on the Fiserv device.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| amt |
Refund Amount |
The amount requested for the refund; the decimal point will be assumed. E.g. 200 will be read as 2.00 |
True |
string |
| detail |
Return Detail |
Does the response message contain details or is it in a simple format? |
False |
boolean |
| referenceNo |
Reference Number |
The reference # from the original transaction being refunded |
False |
string |
| pwd |
Refund Password |
The password for refunding transactions |
False |
string |
| ecrRef |
ECR Reference Number |
A unique value for the electronic cash register reference, up to 32 digits. |
False |
string |
Response Properties
| Name |
Description |
Type |
| status |
Transaction status ('P' - processing, 'A' - approved, or 'R' - rejected) |
string |
| rspCode |
Response Code |
string |
| rspText |
Description of the response code |
string |
| ecrRef |
A unique value for the electronic cash register reference, up to 32 digits |
string |
| txnId |
The transaction ID (invoice #) |
string |
| txnDate |
Date of the transaction in YYYYMMDD format |
string |
| txnTime |
Time of the transaction in HHMM format |
string |
| appCode |
The approval code of the transaction |
string |
| amt |
The amount of the transaction |
string |
| adjAmt |
The amount of the transaction adjusted to include tips |
string |
| cardType |
Visa (VISA), Mastercard (MASTER), American Express (AMEX), China Union Pay (CUP), etc. |
string |
| pan |
Credit card # (masked if terminal configured appropriately) |
string |
| expData |
Expiration Date of the card in YYMM format |
string |
| cardHolderName |
Name of the cardholder |
string |
| entryMode |
Point of sale entry mode ('S' – Swipe, 'C' – Chip Insert, 'F' – Fallback Swipe, 'T' – Contactless Tap, 'M' – Manual Input, 'Q' - QR Code) |
string |
| terminalId |
The 8-digit terminal ID |
string |
| merchantID |
The 15-digit merchant ID |
string |
| batchNo |
A six digit batch # |
string |
| referenceNo |
The reference # from the bank host |
string |
| appName |
EMV Application Label Name |
string |
| aid |
A 16-digit application ID |
string |
| tc |
A 16-digit cryptogram |
string |
| tvr |
The 10-digit EMV transaction verification result |
string |
| tsi |
The 4-digit EMV transaction status information |
string |
| atc |
A 4-digit transaction counter |
string |
| noSign |
Is signature required? |
boolean |
| stt |
Is this a small ticket transaction (below a certain limit)? |
boolean |
| preAuthID1 |
The first unique ID to identify a card not present pre-auth transaction |
string |
| preAuthID2 |
The second unique ID to identify a card not present pre-auth transaction |
string |
| foreignAmt |
The amount in foreign currency for DCC opt-in transactions |
string |
| fxRate |
The conversion rate for DCC opt-in transactions |
string |
| cardHolderCode |
The currency of the cardholder for DCC opt-in transactions |
string |
| txnCurrCode |
The local currency of the transaction for DCC opt-in transactions |
string |
| emiPerMonth |
The per-month EMI |
string |
| interestAmt |
The per-month interest amount |
string |
| tenure |
The tenure of EMI |
string |
Pre-Authorize Card (preAuth)
Pre-Authorize an amount on the Fiserv device.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| amt |
Pre-Auth Amount |
The amount requested for the pre-authorization; the decimal point will be assumed. E.g. 200 will be read as 2.00 |
True |
string |
| detail |
Return Detail |
Does the response message contain details or is it in a simple format? |
False |
boolean |
| ecrRef |
ECR Reference Number |
A unique value for the electronic cash register reference, up to 32 digits. |
False |
string |
Response Properties
| Name |
Description |
Type |
| status |
Transaction status ('P' - processing, 'A' - approved, or 'R' - rejected) |
string |
| rspCode |
Response Code |
string |
| rspText |
Description of the response code |
string |
| ecrRef |
A unique value for the electronic cash register reference, up to 32 digits |
string |
| txnId |
The transaction ID (invoice #) |
string |
| txnDate |
Date of the transaction in YYYYMMDD format |
string |
| txnTime |
Time of the transaction in HHMM format |
string |
| appCode |
The approval code of the transaction |
string |
| amt |
The amount of the transaction |
string |
| adjAmt |
The amount of the transaction adjusted to include tips |
string |
| cardType |
Visa (VISA), Mastercard (MASTER), American Express (AMEX), China Union Pay (CUP), etc. |
string |
| pan |
Credit card # (masked if terminal configured appropriately) |
string |
| expData |
Expiration Date of the card in YYMM format |
string |
| cardHolderName |
Name of the cardholder |
string |
| entryMode |
Point of sale entry mode ('S' – Swipe, 'C' – Chip Insert, 'F' – Fallback Swipe, 'T' – Contactless Tap, 'M' – Manual Input, 'Q' - QR Code) |
string |
| terminalId |
The 8-digit terminal ID |
string |
| merchantID |
The 15-digit merchant ID |
string |
| batchNo |
A six digit batch # |
string |
| referenceNo |
The reference # from the bank host |
string |
| appName |
EMV Application Label Name |
string |
| aid |
A 16-digit application ID |
string |
| tc |
A 16-digit cryptogram |
string |
| tvr |
The 10-digit EMV transaction verification result |
string |
| tsi |
The 4-digit EMV transaction status information |
string |
| atc |
A 4-digit transaction counter |
string |
| noSign |
Is signature required? |
boolean |
| stt |
Is this a small ticket transaction (below a certain limit)? |
boolean |
| preAuthID1 |
The first unique ID to identify a card not present pre-auth transaction |
string |
| preAuthID2 |
The second unique ID to identify a card not present pre-auth transaction |
string |
| foreignAmt |
The amount in foreign currency for DCC opt-in transactions |
string |
| fxRate |
The conversion rate for DCC opt-in transactions |
string |
| cardHolderCode |
The currency of the cardholder for DCC opt-in transactions |
string |
| txnCurrCode |
The local currency of the transaction for DCC opt-in transactions |
string |
| emiPerMonth |
The per-month EMI |
string |
| interestAmt |
The per-month interest amount |
string |
| tenure |
The tenure of EMI |
string |
Void Pre-Authorization (preAuthVoid)
Void a Pre-Authorized amount on the Fiserv device.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| amt |
Pre-Auth Amount |
The amount originally requested for the pre-authorization; the decimal point will be assumed. E.g. 200 will be read as 2.00 |
True |
string |
| appCode |
Approval Code |
The approval code of the pre-authorization transaction |
True |
string |
| txnId |
Transaction ID |
The transaction ID (invoice #) of the pre-authorization |
True |
string |
| last4DigitCardNo |
Card Last Four |
The last four digits of the card used for pre-authorization |
False |
string |
| pan |
Card Number |
Credit card # returned from pre-authorization (alternative to Card Last Four) |
False |
string |
| cardType |
Card Type |
Type of card used for pre-authorization: Visa (VISA), Mastercard (MASTER), American Express (AMEX), China Union Pay (CUP), etc. |
False |
string |
Response Properties
| Name |
Description |
Type |
| status |
Transaction status ('P' - processing, 'A' - approved, or 'R' - rejected) |
string |
| rspCode |
Response Code |
string |
| rspText |
Description of the response code |
string |
| ecrRef |
A unique value for the electronic cash register reference, up to 32 digits |
string |
| txnId |
The transaction ID (invoice #) |
string |
| txnDate |
Date of the transaction in YYYYMMDD format |
string |
| txnTime |
Time of the transaction in HHMM format |
string |
| appCode |
The approval code of the transaction |
string |
| amt |
The amount of the transaction |
string |
| adjAmt |
The amount of the transaction adjusted to include tips |
string |
| cardType |
Visa (VISA), Mastercard (MASTER), American Express (AMEX), China Union Pay (CUP), etc. |
string |
| pan |
Credit card # (masked if terminal configured appropriately) |
string |
| expData |
Expiration Date of the card in YYMM format |
string |
| cardHolderName |
Name of the cardholder |
string |
| entryMode |
Point of sale entry mode ('S' – Swipe, 'C' – Chip Insert, 'F' – Fallback Swipe, 'T' – Contactless Tap, 'M' – Manual Input, 'Q' - QR Code) |
string |
| terminalId |
The 8-digit terminal ID |
string |
| merchantID |
The 15-digit merchant ID |
string |
| batchNo |
A six digit batch # |
string |
| referenceNo |
The reference # from the bank host |
string |
| appName |
EMV Application Label Name |
string |
| aid |
A 16-digit application ID |
string |
| tc |
A 16-digit cryptogram |
string |
| tvr |
The 10-digit EMV transaction verification result |
string |
| tsi |
The 4-digit EMV transaction status information |
string |
| atc |
A 4-digit transaction counter |
string |
| noSign |
Is signature required? |
boolean |
| stt |
Is this a small ticket transaction (below a certain limit)? |
boolean |
| preAuthID1 |
The first unique ID to identify a card not present pre-auth transaction |
string |
| preAuthID2 |
The second unique ID to identify a card not present pre-auth transaction |
string |
| foreignAmt |
The amount in foreign currency for DCC opt-in transactions |
string |
| fxRate |
The conversion rate for DCC opt-in transactions |
string |
| cardHolderCode |
The currency of the cardholder for DCC opt-in transactions |
string |
| txnCurrCode |
The local currency of the transaction for DCC opt-in transactions |
string |
| emiPerMonth |
The per-month EMI |
string |
| interestAmt |
The per-month interest amount |
string |
| tenure |
The tenure of EMI |
string |
Complete Pre-Authorization (preAuthCom)
Complete a Pre-Authorized amount on the Fiserv device.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| amt |
Pre-Auth Amount |
The amount originally requested for the pre-authorization; the decimal point will be assumed. E.g. 200 will be read as 2.00 |
True |
string |
| appCode |
Approval Code |
The approval code of the pre-authorization transaction |
True |
string |
| txnId |
Transaction ID |
The transaction ID (invoice #) of the pre-authorization |
True |
string |
| last4DigitCardNo |
Card Last Four |
The last four digits of the card used for pre-authorization |
False |
string |
| pan |
Card Number |
Credit card # returned from pre-authorization (alternative to Card Last Four) |
False |
string |
| cardType |
Card Type |
Type of card used for pre-authorization: Visa (VISA), Mastercard (MASTER), American Express (AMEX), China Union Pay (CUP), etc. |
False |
string |
| ecrRef |
ECR Reference Number |
A unique value for the electronic cash register reference, up to 32 digits. |
False |
string |
Response Properties
| Name |
Description |
Type |
| status |
Transaction status ('P' - processing, 'A' - approved, or 'R' - rejected) |
string |
| rspCode |
Response Code |
string |
| rspText |
Description of the response code |
string |
| ecrRef |
A unique value for the electronic cash register reference, up to 32 digits |
string |
| txnId |
The transaction ID (invoice #) |
string |
| txnDate |
Date of the transaction in YYYYMMDD format |
string |
| txnTime |
Time of the transaction in HHMM format |
string |
| appCode |
The approval code of the transaction |
string |
| amt |
The amount of the transaction |
string |
| adjAmt |
The amount of the transaction adjusted to include tips |
string |
| cardType |
Visa (VISA), Mastercard (MASTER), American Express (AMEX), China Union Pay (CUP), etc. |
string |
| pan |
Credit card # (masked if terminal configured appropriately) |
string |
| expData |
Expiration Date of the card in YYMM format |
string |
| cardHolderName |
Name of the cardholder |
string |
| entryMode |
Point of sale entry mode ('S' – Swipe, 'C' – Chip Insert, 'F' – Fallback Swipe, 'T' – Contactless Tap, 'M' – Manual Input, 'Q' - QR Code) |
string |
| terminalId |
The 8-digit terminal ID |
string |
| merchantID |
The 15-digit merchant ID |
string |
| batchNo |
A six digit batch # |
string |
| referenceNo |
The reference # from the bank host |
string |
| appName |
EMV Application Label Name |
string |
| aid |
A 16-digit application ID |
string |
| tc |
A 16-digit cryptogram |
string |
| tvr |
The 10-digit EMV transaction verification result |
string |
| tsi |
The 4-digit EMV transaction status information |
string |
| atc |
A 4-digit transaction counter |
string |
| noSign |
Is signature required? |
boolean |
| stt |
Is this a small ticket transaction (below a certain limit)? |
boolean |
| preAuthID1 |
The first unique ID to identify a card not present pre-auth transaction |
string |
| preAuthID2 |
The second unique ID to identify a card not present pre-auth transaction |
string |
| foreignAmt |
The amount in foreign currency for DCC opt-in transactions |
string |
| fxRate |
The conversion rate for DCC opt-in transactions |
string |
| cardHolderCode |
The currency of the cardholder for DCC opt-in transactions |
string |
| txnCurrCode |
The local currency of the transaction for DCC opt-in transactions |
string |
| emiPerMonth |
The per-month EMI |
string |
| interestAmt |
The per-month interest amount |
string |
| tenure |
The tenure of EMI |
string |
Void Completed Pre-Authorization (preAuthComVoid)
Void a Completed Pre-Authorized amount on the Fiserv device.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| txnId |
Transaction ID |
The transaction ID (invoice #) of the pre-authorization completion |
True |
string |
| ecrRef |
ECR Reference Number |
A unique value for the electronic cash register reference, up to 32 digits. |
False |
string |
Response Properties
| Name |
Description |
Type |
| status |
Transaction status ('P' - processing, 'A' - approved, or 'R' - rejected) |
string |
| rspCode |
Response Code |
string |
| rspText |
Description of the response code |
string |
| ecrRef |
A unique value for the electronic cash register reference, up to 32 digits |
string |
| txnId |
The transaction ID (invoice #) |
string |
| txnDate |
Date of the transaction in YYYYMMDD format |
string |
| txnTime |
Time of the transaction in HHMM format |
string |
| appCode |
The approval code of the transaction |
string |
| amt |
The amount of the transaction |
string |
| adjAmt |
The amount of the transaction adjusted to include tips |
string |
| cardType |
Visa (VISA), Mastercard (MASTER), American Express (AMEX), China Union Pay (CUP), etc. |
string |
| pan |
Credit card # (masked if terminal configured appropriately) |
string |
| expData |
Expiration Date of the card in YYMM format |
string |
| cardHolderName |
Name of the cardholder |
string |
| entryMode |
Point of sale entry mode ('S' – Swipe, 'C' – Chip Insert, 'F' – Fallback Swipe, 'T' – Contactless Tap, 'M' – Manual Input, 'Q' - QR Code) |
string |
| terminalId |
The 8-digit terminal ID |
string |
| merchantID |
The 15-digit merchant ID |
string |
| batchNo |
A six digit batch # |
string |
| referenceNo |
The reference # from the bank host |
string |
| appName |
EMV Application Label Name |
string |
| aid |
A 16-digit application ID |
string |
| tc |
A 16-digit cryptogram |
string |
| tvr |
The 10-digit EMV transaction verification result |
string |
| tsi |
The 4-digit EMV transaction status information |
string |
| atc |
A 4-digit transaction counter |
string |
| noSign |
Is signature required? |
boolean |
| stt |
Is this a small ticket transaction (below a certain limit)? |
boolean |
| preAuthID1 |
The first unique ID to identify a card not present pre-auth transaction |
string |
| preAuthID2 |
The second unique ID to identify a card not present pre-auth transaction |
string |
| foreignAmt |
The amount in foreign currency for DCC opt-in transactions |
string |
| fxRate |
The conversion rate for DCC opt-in transactions |
string |
| cardHolderCode |
The currency of the cardholder for DCC opt-in transactions |
string |
| txnCurrCode |
The local currency of the transaction for DCC opt-in transactions |
string |
| emiPerMonth |
The per-month EMI |
string |
| interestAmt |
The per-month interest amount |
string |
| tenure |
The tenure of EMI |
string |
Top-Up Pre-Authorization (preAuthTopUp)
Top-up a Pre-Authorized amount on the Fiserv device.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| amt |
Top-Up Amount |
The top-up amount requested for the pre-authorization; the decimal point will be assumed. E.g. 200 will be read as 2.00 |
True |
string |
| appCode |
Approval Code |
The approval code of the pre-authorization transaction |
True |
string |
| txnId |
Transaction ID |
The transaction ID (invoice #) of the pre-authorization |
True |
string |
| ecrRef |
ECR Reference Number |
A unique value for the electronic cash register reference, up to 32 digits. |
False |
string |
Response Properties
| Name |
Description |
Type |
| status |
Transaction status ('P' - processing, 'A' - approved, or 'R' - rejected) |
string |
| rspCode |
Response Code |
string |
| rspText |
Description of the response code |
string |
| ecrRef |
A unique value for the electronic cash register reference, up to 32 digits |
string |
| txnId |
The transaction ID (invoice #) |
string |
| txnDate |
Date of the transaction in YYYYMMDD format |
string |
| txnTime |
Time of the transaction in HHMM format |
string |
| appCode |
The approval code of the transaction |
string |
| amt |
The amount of the transaction |
string |
| adjAmt |
The amount of the transaction adjusted to include tips |
string |
| cardType |
Visa (VISA), Mastercard (MASTER), American Express (AMEX), China Union Pay (CUP), etc. |
string |
| pan |
Credit card # (masked if terminal configured appropriately) |
string |
| expData |
Expiration Date of the card in YYMM format |
string |
| cardHolderName |
Name of the cardholder |
string |
| entryMode |
Point of sale entry mode ('S' – Swipe, 'C' – Chip Insert, 'F' – Fallback Swipe, 'T' – Contactless Tap, 'M' – Manual Input, 'Q' - QR Code) |
string |
| terminalId |
The 8-digit terminal ID |
string |
| merchantID |
The 15-digit merchant ID |
string |
| batchNo |
A six digit batch # |
string |
| referenceNo |
The reference # from the bank host |
string |
| appName |
EMV Application Label Name |
string |
| aid |
A 16-digit application ID |
string |
| tc |
A 16-digit cryptogram |
string |
| tvr |
The 10-digit EMV transaction verification result |
string |
| tsi |
The 4-digit EMV transaction status information |
string |
| atc |
A 4-digit transaction counter |
string |
| noSign |
Is signature required? |
boolean |
| stt |
Is this a small ticket transaction (below a certain limit)? |
boolean |
| preAuthID1 |
The first unique ID to identify a card not present pre-auth transaction |
string |
| preAuthID2 |
The second unique ID to identify a card not present pre-auth transaction |
string |
| foreignAmt |
The amount in foreign currency for DCC opt-in transactions |
string |
| fxRate |
The conversion rate for DCC opt-in transactions |
string |
| cardHolderCode |
The currency of the cardholder for DCC opt-in transactions |
string |
| txnCurrCode |
The local currency of the transaction for DCC opt-in transactions |
string |
| emiPerMonth |
The per-month EMI |
string |
| interestAmt |
The per-month interest amount |
string |
| tenure |
The tenure of EMI |
string |
Void Pre-Authorization (CNP) (CNPPreAuthVoid)
Void a Pre-Authorized amount (with card not present) on the Fiserv device.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| amt |
Pre-Auth Amount |
The amount originally requested for the pre-authorization; the decimal point will be assumed. E.g. 200 will be read as 2.00 |
True |
string |
| appCode |
Approval Code |
The approval code of the pre-authorization transaction |
True |
string |
| txnId |
Transaction ID |
The transaction ID (invoice #) of the pre-authorization |
False |
string |
| preAuthID1 |
Pre-Auth ID 1 |
The first unique ID to identify a card not present pre-auth transaction |
True |
string |
| preAuthID2 |
Pre-Auth ID 2 |
The second unique ID to identify a card not present pre-auth transaction |
True |
string |
| cardType |
Card Type |
Type of card used for pre-authorization: Visa (VISA), Mastercard (MASTER), American Express (AMEX), China Union Pay (CUP), etc. |
True |
string |
| ecrRef |
ECR Reference Number |
A unique value for the electronic cash register reference, up to 32 digits. |
False |
string |
Response Properties
| Name |
Description |
Type |
| status |
Transaction status ('P' - processing, 'A' - approved, or 'R' - rejected) |
string |
| rspCode |
Response Code |
string |
| rspText |
Description of the response code |
string |
| ecrRef |
A unique value for the electronic cash register reference, up to 32 digits |
string |
| txnId |
The transaction ID (invoice #) |
string |
| txnDate |
Date of the transaction in YYYYMMDD format |
string |
| txnTime |
Time of the transaction in HHMM format |
string |
| appCode |
The approval code of the transaction |
string |
| amt |
The amount of the transaction |
string |
| adjAmt |
The amount of the transaction adjusted to include tips |
string |
| cardType |
Visa (VISA), Mastercard (MASTER), American Express (AMEX), China Union Pay (CUP), etc. |
string |
| pan |
Credit card # (masked if terminal configured appropriately) |
string |
| expData |
Expiration Date of the card in YYMM format |
string |
| cardHolderName |
Name of the cardholder |
string |
| entryMode |
Point of sale entry mode ('S' – Swipe, 'C' – Chip Insert, 'F' – Fallback Swipe, 'T' – Contactless Tap, 'M' – Manual Input, 'Q' - QR Code) |
string |
| terminalId |
The 8-digit terminal ID |
string |
| merchantID |
The 15-digit merchant ID |
string |
| batchNo |
A six digit batch # |
string |
| referenceNo |
The reference # from the bank host |
string |
| appName |
EMV Application Label Name |
string |
| aid |
A 16-digit application ID |
string |
| tc |
A 16-digit cryptogram |
string |
| tvr |
The 10-digit EMV transaction verification result |
string |
| tsi |
The 4-digit EMV transaction status information |
string |
| atc |
A 4-digit transaction counter |
string |
| noSign |
Is signature required? |
boolean |
| stt |
Is this a small ticket transaction (below a certain limit)? |
boolean |
| preAuthID1 |
The first unique ID to identify a card not present pre-auth transaction |
string |
| preAuthID2 |
The second unique ID to identify a card not present pre-auth transaction |
string |
| foreignAmt |
The amount in foreign currency for DCC opt-in transactions |
string |
| fxRate |
The conversion rate for DCC opt-in transactions |
string |
| cardHolderCode |
The currency of the cardholder for DCC opt-in transactions |
string |
| txnCurrCode |
The local currency of the transaction for DCC opt-in transactions |
string |
| emiPerMonth |
The per-month EMI |
string |
| interestAmt |
The per-month interest amount |
string |
| tenure |
The tenure of EMI |
string |
Complete Pre-Authorization (CNP) (CNPPreAuthCom)
Complete a Pre-Authorized amount (with card not present) on the Fiserv device.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| amt |
Pre-Auth Amount |
The amount originally requested for the pre-authorization; the decimal point will be assumed. E.g. 200 will be read as 2.00 |
True |
string |
| appCode |
Approval Code |
The approval code of the pre-authorization transaction |
True |
string |
| txnId |
Transaction ID |
The transaction ID (invoice #) of the pre-authorization |
False |
string |
| preAuthID1 |
Pre-Auth ID 1 |
The first unique ID to identify a card not present pre-auth transaction |
True |
string |
| preAuthID2 |
Pre-Auth ID 2 |
The second unique ID to identify a card not present pre-auth transaction |
True |
string |
| cardType |
Card Type |
Type of card used for pre-authorization: Visa (VISA), Mastercard (MASTER), American Express (AMEX), China Union Pay (CUP), etc. |
True |
string |
| ecrRef |
ECR Reference Number |
A unique value for the electronic cash register reference, up to 32 digits. |
False |
string |
Response Properties
| Name |
Description |
Type |
| status |
Transaction status ('P' - processing, 'A' - approved, or 'R' - rejected) |
string |
| rspCode |
Response Code |
string |
| rspText |
Description of the response code |
string |
| ecrRef |
A unique value for the electronic cash register reference, up to 32 digits |
string |
| txnId |
The transaction ID (invoice #) |
string |
| txnDate |
Date of the transaction in YYYYMMDD format |
string |
| txnTime |
Time of the transaction in HHMM format |
string |
| appCode |
The approval code of the transaction |
string |
| amt |
The amount of the transaction |
string |
| adjAmt |
The amount of the transaction adjusted to include tips |
string |
| cardType |
Visa (VISA), Mastercard (MASTER), American Express (AMEX), China Union Pay (CUP), etc. |
string |
| pan |
Credit card # (masked if terminal configured appropriately) |
string |
| expData |
Expiration Date of the card in YYMM format |
string |
| cardHolderName |
Name of the cardholder |
string |
| entryMode |
Point of sale entry mode ('S' – Swipe, 'C' – Chip Insert, 'F' – Fallback Swipe, 'T' – Contactless Tap, 'M' – Manual Input, 'Q' - QR Code) |
string |
| terminalId |
The 8-digit terminal ID |
string |
| merchantID |
The 15-digit merchant ID |
string |
| batchNo |
A six digit batch # |
string |
| referenceNo |
The reference # from the bank host |
string |
| appName |
EMV Application Label Name |
string |
| aid |
A 16-digit application ID |
string |
| tc |
A 16-digit cryptogram |
string |
| tvr |
The 10-digit EMV transaction verification result |
string |
| tsi |
The 4-digit EMV transaction status information |
string |
| atc |
A 4-digit transaction counter |
string |
| noSign |
Is signature required? |
boolean |
| stt |
Is this a small ticket transaction (below a certain limit)? |
boolean |
| preAuthID1 |
The first unique ID to identify a card not present pre-auth transaction |
string |
| preAuthID2 |
The second unique ID to identify a card not present pre-auth transaction |
string |
| foreignAmt |
The amount in foreign currency for DCC opt-in transactions |
string |
| fxRate |
The conversion rate for DCC opt-in transactions |
string |
| cardHolderCode |
The currency of the cardholder for DCC opt-in transactions |
string |
| txnCurrCode |
The local currency of the transaction for DCC opt-in transactions |
string |
| emiPerMonth |
The per-month EMI |
string |
| interestAmt |
The per-month interest amount |
string |
| tenure |
The tenure of EMI |
string |
Void Completed Pre-Authorization (CNP) (CNPPreAuthComVoid)
Void a Completed Pre-Authorized amount (with card not present) on the Fiserv device.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| amt |
Pre-Auth Amount |
The amount originally requested for the pre-authorization; the decimal point will be assumed. E.g. 200 will be read as 2.00 |
True |
string |
| appCode |
Approval Code |
The approval code of the pre-authorization transaction |
True |
string |
| txnId |
Transaction ID |
The transaction ID (invoice #) of the pre-authorization |
False |
string |
| referenceNo |
Reference Number |
The pre-authorization reference # from the bank host |
True |
string |
| txnDate |
Transaction Date |
Date of the pre-authorization in YYYYMMDD format |
True |
string |
| txnTime |
Transaction Time |
Time of the pre-authorization in HHMM format |
True |
string |
| preAuthID1 |
Pre-Auth ID 1 |
The first unique ID to identify a card not present pre-auth transaction |
True |
string |
| preAuthID2 |
Pre-Auth ID 2 |
The second unique ID to identify a card not present pre-auth transaction |
True |
string |
| cardType |
Card Type |
Type of card used for pre-authorization: Visa (VISA), Mastercard (MASTER), American Express (AMEX), China Union Pay (CUP), etc. |
True |
string |
| ecrRef |
ECR Reference Number |
A unique value for the electronic cash register reference, up to 32 digits. |
False |
string |
Response Properties
| Name |
Description |
Type |
| status |
Transaction status ('P' - processing, 'A' - approved, or 'R' - rejected) |
string |
| rspCode |
Response Code |
string |
| rspText |
Description of the response code |
string |
| ecrRef |
A unique value for the electronic cash register reference, up to 32 digits |
string |
| txnId |
The transaction ID (invoice #) |
string |
| txnDate |
Date of the transaction in YYYYMMDD format |
string |
| txnTime |
Time of the transaction in HHMM format |
string |
| appCode |
The approval code of the transaction |
string |
| amt |
The amount of the transaction |
string |
| adjAmt |
The amount of the transaction adjusted to include tips |
string |
| cardType |
Visa (VISA), Mastercard (MASTER), American Express (AMEX), China Union Pay (CUP), etc. |
string |
| pan |
Credit card # (masked if terminal configured appropriately) |
string |
| expData |
Expiration Date of the card in YYMM format |
string |
| cardHolderName |
Name of the cardholder |
string |
| entryMode |
Point of sale entry mode ('S' – Swipe, 'C' – Chip Insert, 'F' – Fallback Swipe, 'T' – Contactless Tap, 'M' – Manual Input, 'Q' - QR Code) |
string |
| terminalId |
The 8-digit terminal ID |
string |
| merchantID |
The 15-digit merchant ID |
string |
| batchNo |
A six digit batch # |
string |
| referenceNo |
The reference # from the bank host |
string |
| appName |
EMV Application Label Name |
string |
| aid |
A 16-digit application ID |
string |
| tc |
A 16-digit cryptogram |
string |
| tvr |
The 10-digit EMV transaction verification result |
string |
| tsi |
The 4-digit EMV transaction status information |
string |
| atc |
A 4-digit transaction counter |
string |
| noSign |
Is signature required? |
boolean |
| stt |
Is this a small ticket transaction (below a certain limit)? |
boolean |
| preAuthID1 |
The first unique ID to identify a card not present pre-auth transaction |
string |
| preAuthID2 |
The second unique ID to identify a card not present pre-auth transaction |
string |
| foreignAmt |
The amount in foreign currency for DCC opt-in transactions |
string |
| fxRate |
The conversion rate for DCC opt-in transactions |
string |
| cardHolderCode |
The currency of the cardholder for DCC opt-in transactions |
string |
| txnCurrCode |
The local currency of the transaction for DCC opt-in transactions |
string |
| emiPerMonth |
The per-month EMI |
string |
| interestAmt |
The per-month interest amount |
string |
| tenure |
The tenure of EMI |
string |
Top-Up Pre-Authorization (CNP) (CNPPreAuthTopUp)
Top-up a Pre-Authorized amount (with card not present) on the Fiserv device.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| amt |
Top-Up Amount |
The top-up amount requested for the pre-authorization; the decimal point will be assumed. E.g. 200 will be read as 2.00 |
True |
string |
| txnId |
Transaction ID |
The transaction ID (invoice #) of the pre-authorization |
False |
string |
| preAuthID1 |
Pre-Auth ID 1 |
The first unique ID to identify a card not present pre-auth transaction |
True |
string |
| preAuthID2 |
Pre-Auth ID 2 |
The second unique ID to identify a card not present pre-auth transaction |
True |
string |
| cardType |
Card Type |
Type of card used for pre-authorization: Visa (VISA), Mastercard (MASTER), American Express (AMEX), China Union Pay (CUP), etc. |
True |
string |
| ecrRef |
ECR Reference Number |
A unique value for the electronic cash register reference, up to 32 digits. |
True |
string |
Response Properties
| Name |
Description |
Type |
| status |
Transaction status ('P' - processing, 'A' - approved, or 'R' - rejected) |
string |
| rspCode |
Response Code |
string |
| rspText |
Description of the response code |
string |
| ecrRef |
A unique value for the electronic cash register reference, up to 32 digits |
string |
| txnId |
The transaction ID (invoice #) |
string |
| txnDate |
Date of the transaction in YYYYMMDD format |
string |
| txnTime |
Time of the transaction in HHMM format |
string |
| appCode |
The approval code of the transaction |
string |
| amt |
The amount of the transaction |
string |
| adjAmt |
The amount of the transaction adjusted to include tips |
string |
| cardType |
Visa (VISA), Mastercard (MASTER), American Express (AMEX), China Union Pay (CUP), etc. |
string |
| pan |
Credit card # (masked if terminal configured appropriately) |
string |
| expData |
Expiration Date of the card in YYMM format |
string |
| cardHolderName |
Name of the cardholder |
string |
| entryMode |
Point of sale entry mode ('S' – Swipe, 'C' – Chip Insert, 'F' – Fallback Swipe, 'T' – Contactless Tap, 'M' – Manual Input, 'Q' - QR Code) |
string |
| terminalId |
The 8-digit terminal ID |
string |
| merchantID |
The 15-digit merchant ID |
string |
| batchNo |
A six digit batch # |
string |
| referenceNo |
The reference # from the bank host |
string |
| appName |
EMV Application Label Name |
string |
| aid |
A 16-digit application ID |
string |
| tc |
A 16-digit cryptogram |
string |
| tvr |
The 10-digit EMV transaction verification result |
string |
| tsi |
The 4-digit EMV transaction status information |
string |
| atc |
A 4-digit transaction counter |
string |
| noSign |
Is signature required? |
boolean |
| stt |
Is this a small ticket transaction (below a certain limit)? |
boolean |
| preAuthID1 |
The first unique ID to identify a card not present pre-auth transaction |
string |
| preAuthID2 |
The second unique ID to identify a card not present pre-auth transaction |
string |
| foreignAmt |
The amount in foreign currency for DCC opt-in transactions |
string |
| fxRate |
The conversion rate for DCC opt-in transactions |
string |
| cardHolderCode |
The currency of the cardholder for DCC opt-in transactions |
string |
| txnCurrCode |
The local currency of the transaction for DCC opt-in transactions |
string |
| emiPerMonth |
The per-month EMI |
string |
| interestAmt |
The per-month interest amount |
string |
| tenure |
The tenure of EMI |
string |
Installment (inst)
Pay an Installment amount on the Fiserv device.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| amt |
Installment Amount |
The installment amount requested; the decimal point will be assumed. E.g. 200 will be read as 2.00 |
True |
string |
| ecrRef |
ECR Reference Number |
A unique value for the electronic cash register reference, up to 32 digits. |
False |
string |
Response Properties
| Name |
Description |
Type |
| status |
Transaction status ('P' - processing, 'A' - approved, or 'R' - rejected) |
string |
| rspCode |
Response Code |
string |
| rspText |
Description of the response code |
string |
| ecrRef |
A unique value for the electronic cash register reference, up to 32 digits |
string |
| txnId |
The transaction ID (invoice #) |
string |
| txnDate |
Date of the transaction in YYYYMMDD format |
string |
| txnTime |
Time of the transaction in HHMM format |
string |
| appCode |
The approval code of the transaction |
string |
| amt |
The amount of the transaction |
string |
| adjAmt |
The amount of the transaction adjusted to include tips |
string |
| cardType |
Visa (VISA), Mastercard (MASTER), American Express (AMEX), China Union Pay (CUP), etc. |
string |
| pan |
Credit card # (masked if terminal configured appropriately) |
string |
| expData |
Expiration Date of the card in YYMM format |
string |
| cardHolderName |
Name of the cardholder |
string |
| entryMode |
Point of sale entry mode ('S' – Swipe, 'C' – Chip Insert, 'F' – Fallback Swipe, 'T' – Contactless Tap, 'M' – Manual Input, 'Q' - QR Code) |
string |
| terminalId |
The 8-digit terminal ID |
string |
| merchantID |
The 15-digit merchant ID |
string |
| batchNo |
A six digit batch # |
string |
| referenceNo |
The reference # from the bank host |
string |
| appName |
EMV Application Label Name |
string |
| aid |
A 16-digit application ID |
string |
| tc |
A 16-digit cryptogram |
string |
| tvr |
The 10-digit EMV transaction verification result |
string |
| tsi |
The 4-digit EMV transaction status information |
string |
| atc |
A 4-digit transaction counter |
string |
| noSign |
Is signature required? |
boolean |
| stt |
Is this a small ticket transaction (below a certain limit)? |
boolean |
| preAuthID1 |
The first unique ID to identify a card not present pre-auth transaction |
string |
| preAuthID2 |
The second unique ID to identify a card not present pre-auth transaction |
string |
| foreignAmt |
The amount in foreign currency for DCC opt-in transactions |
string |
| fxRate |
The conversion rate for DCC opt-in transactions |
string |
| cardHolderCode |
The currency of the cardholder for DCC opt-in transactions |
string |
| txnCurrCode |
The local currency of the transaction for DCC opt-in transactions |
string |
| emiPerMonth |
The per-month EMI |
string |
| interestAmt |
The per-month interest amount |
string |
| tenure |
The tenure of EMI |
string |
Adjust (adjust)
Adjust a transaction amount on the Fiserv device.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| txnId |
Transaction ID |
The transaction ID (invoice #) of the original sale |
True |
string |
| adjAmt |
Adjusted Amount |
The adjusted amount requested; the decimal point will be assumed. E.g. 200 will be read as 2.00 |
True |
string |
| pwd |
Adjustment Password |
The password for adjusting transactions |
False |
string |
| ecrRef |
ECR Reference Number |
A unique value for the electronic cash register reference, up to 32 digits. |
False |
string |
Response Properties
| Name |
Description |
Type |
| status |
Transaction status ('P' - processing, 'A' - approved, or 'R' - rejected) |
string |
| rspCode |
Response Code |
string |
| rspText |
Description of the response code |
string |
| ecrRef |
A unique value for the electronic cash register reference, up to 32 digits |
string |
| txnId |
The transaction ID (invoice #) |
string |
| txnDate |
Date of the transaction in YYYYMMDD format |
string |
| txnTime |
Time of the transaction in HHMM format |
string |
| appCode |
The approval code of the transaction |
string |
| amt |
The amount of the transaction |
string |
| adjAmt |
The amount of the transaction adjusted to include tips |
string |
| cardType |
Visa (VISA), Mastercard (MASTER), American Express (AMEX), China Union Pay (CUP), etc. |
string |
| pan |
Credit card # (masked if terminal configured appropriately) |
string |
| expData |
Expiration Date of the card in YYMM format |
string |
| cardHolderName |
Name of the cardholder |
string |
| entryMode |
Point of sale entry mode ('S' – Swipe, 'C' – Chip Insert, 'F' – Fallback Swipe, 'T' – Contactless Tap, 'M' – Manual Input, 'Q' - QR Code) |
string |
| terminalId |
The 8-digit terminal ID |
string |
| merchantID |
The 15-digit merchant ID |
string |
| batchNo |
A six digit batch # |
string |
| referenceNo |
The reference # from the bank host |
string |
| appName |
EMV Application Label Name |
string |
| aid |
A 16-digit application ID |
string |
| tc |
A 16-digit cryptogram |
string |
| tvr |
The 10-digit EMV transaction verification result |
string |
| tsi |
The 4-digit EMV transaction status information |
string |
| atc |
A 4-digit transaction counter |
string |
| noSign |
Is signature required? |
boolean |
| stt |
Is this a small ticket transaction (below a certain limit)? |
boolean |
| preAuthID1 |
The first unique ID to identify a card not present pre-auth transaction |
string |
| preAuthID2 |
The second unique ID to identify a card not present pre-auth transaction |
string |
| foreignAmt |
The amount in foreign currency for DCC opt-in transactions |
string |
| fxRate |
The conversion rate for DCC opt-in transactions |
string |
| cardHolderCode |
The currency of the cardholder for DCC opt-in transactions |
string |
| txnCurrCode |
The local currency of the transaction for DCC opt-in transactions |
string |
| emiPerMonth |
The per-month EMI |
string |
| interestAmt |
The per-month interest amount |
string |
| tenure |
The tenure of EMI |
string |
Reprint (reprint)
Reprint a transaction receipt on the Fiserv device.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| txnId |
Transaction ID |
The transaction ID (invoice #) of the original sale |
True |
string |
Response Properties
| Name |
Description |
Type |
| status |
Transaction status ('P' - processing, 'A' - approved, or 'R' - rejected) |
string |
| rspCode |
Response Code |
string |
| rspText |
Description of the response code |
string |
| ecrRef |
A unique value for the electronic cash register reference, up to 32 digits |
string |
| txnId |
The transaction ID (invoice #) |
string |
| txnDate |
Date of the transaction in YYYYMMDD format |
string |
| txnTime |
Time of the transaction in HHMM format |
string |
| appCode |
The approval code of the transaction |
string |
| amt |
The amount of the transaction |
string |
| adjAmt |
The amount of the transaction adjusted to include tips |
string |
| cardType |
Visa (VISA), Mastercard (MASTER), American Express (AMEX), China Union Pay (CUP), etc. |
string |
| pan |
Credit card # (masked if terminal configured appropriately) |
string |
| expData |
Expiration Date of the card in YYMM format |
string |
| cardHolderName |
Name of the cardholder |
string |
| entryMode |
Point of sale entry mode ('S' – Swipe, 'C' – Chip Insert, 'F' – Fallback Swipe, 'T' – Contactless Tap, 'M' – Manual Input, 'Q' - QR Code) |
string |
| terminalId |
The 8-digit terminal ID |
string |
| merchantID |
The 15-digit merchant ID |
string |
| batchNo |
A six digit batch # |
string |
| referenceNo |
The reference # from the bank host |
string |
| appName |
EMV Application Label Name |
string |
| aid |
A 16-digit application ID |
string |
| tc |
A 16-digit cryptogram |
string |
| tvr |
The 10-digit EMV transaction verification result |
string |
| tsi |
The 4-digit EMV transaction status information |
string |
| atc |
A 4-digit transaction counter |
string |
| noSign |
Is signature required? |
boolean |
| stt |
Is this a small ticket transaction (below a certain limit)? |
boolean |
| preAuthID1 |
The first unique ID to identify a card not present pre-auth transaction |
string |
| preAuthID2 |
The second unique ID to identify a card not present pre-auth transaction |
string |
| foreignAmt |
The amount in foreign currency for DCC opt-in transactions |
string |
| fxRate |
The conversion rate for DCC opt-in transactions |
string |
| cardHolderCode |
The currency of the cardholder for DCC opt-in transactions |
string |
| txnCurrCode |
The local currency of the transaction for DCC opt-in transactions |
string |
| emiPerMonth |
The per-month EMI |
string |
| interestAmt |
The per-month interest amount |
string |
| tenure |
The tenure of EMI |
string |
Get Transaction (getTxn)
Get transaction details from the Fiserv device.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| txnId |
Transaction ID |
The transaction ID (invoice #) of the original sale |
False |
string |
| ecrRef |
ECR Reference Number |
A unique value for the electronic cash register reference, up to 32 digits. |
False |
string |
| detail |
Return Detail |
Does the response message contain details or is it in a simple format? |
False |
boolean |
Response Properties
| Name |
Description |
Type |
| status |
Transaction status ('P' - processing, 'A' - approved, or 'R' - rejected) |
string |
| rspCode |
Response Code |
string |
| rspText |
Description of the response code |
string |
| ecrRef |
A unique value for the electronic cash register reference, up to 32 digits |
string |
| txnId |
The transaction ID (invoice #) |
string |
| txnDate |
Date of the transaction in YYYYMMDD format |
string |
| txnTime |
Time of the transaction in HHMM format |
string |
| appCode |
The approval code of the transaction |
string |
| amt |
The amount of the transaction |
string |
| adjAmt |
The amount of the transaction adjusted to include tips |
string |
| cardType |
Visa (VISA), Mastercard (MASTER), American Express (AMEX), China Union Pay (CUP), etc. |
string |
| pan |
Credit card # (masked if terminal configured appropriately) |
string |
| expData |
Expiration Date of the card in YYMM format |
string |
| cardHolderName |
Name of the cardholder |
string |
| entryMode |
Point of sale entry mode ('S' – Swipe, 'C' – Chip Insert, 'F' – Fallback Swipe, 'T' – Contactless Tap, 'M' – Manual Input, 'Q' - QR Code) |
string |
| terminalId |
The 8-digit terminal ID |
string |
| merchantID |
The 15-digit merchant ID |
string |
| batchNo |
A six digit batch # |
string |
| referenceNo |
The reference # from the bank host |
string |
| appName |
EMV Application Label Name |
string |
| aid |
A 16-digit application ID |
string |
| tc |
A 16-digit cryptogram |
string |
| tvr |
The 10-digit EMV transaction verification result |
string |
| tsi |
The 4-digit EMV transaction status information |
string |
| atc |
A 4-digit transaction counter |
string |
| noSign |
Is signature required? |
boolean |
| stt |
Is this a small ticket transaction (below a certain limit)? |
boolean |
| preAuthID1 |
The first unique ID to identify a card not present pre-auth transaction |
string |
| preAuthID2 |
The second unique ID to identify a card not present pre-auth transaction |
string |
| foreignAmt |
The amount in foreign currency for DCC opt-in transactions |
string |
| fxRate |
The conversion rate for DCC opt-in transactions |
string |
| cardHolderCode |
The currency of the cardholder for DCC opt-in transactions |
string |
| txnCurrCode |
The local currency of the transaction for DCC opt-in transactions |
string |
| emiPerMonth |
The per-month EMI |
string |
| interestAmt |
The per-month interest amount |
string |
| tenure |
The tenure of EMI |
string |
Settle (settle)
Settle transactions on the Fiserv device.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| acqName |
Acquirer Name |
The target acquirer of the transactions to settle (i.e. - "FDMS-V/M", "FDMS-CUP", "FDMS-JCB", "FDMS-AE", etc.) or "ALL" for all acquirers |
True |
string |
| pwd |
Settlement Password |
The password for settling transactions |
False |
string |
Response Properties
| Name |
Description |
Type |
| status |
Transaction status ('P' - processing, 'A' - approved, or 'R' - rejected) |
string |
| rspCode |
Response Code |
string |
| rspText |
Description of the response code |
string |
| settlement |
Acquirer Settlement Response |
array |
| settlement.count |
The number of Acquirer Settlment Responses |
string |
| settlement[0].rspCode |
Response Code |
string |
| settlement[0].rspText |
Description of the response code |
string |
| settlement[0].txnType |
A "SETTLE" transaction |
string |
| settlement[0].acqName |
The target acquirer of the transactions settled (i.e. - "FDMS-V/M", "FDMS-CUP", "FDMS-JCB", "FDMS-AE", etc.) or "ALL" for all acquirers |
string |
| settlement[0].batchUpload |
A batch upload? |
boolean |
| settlement[0].batchNo |
A six digit batch # |
string |
| settlement[0].saleTotalAmt |
Total amount of Sale + Adjust + Complete Pre-Authorization + Offline transactions |
string |
| settlement[0].saleTotalNum |
Number of Sale + Adjust +Complete Pre-Authorization + Offline transactions |
string |
| settlement[0].saleVoidTotalAmt |
Total amount of Voided Sale + Void Completed Pre-Authorization transactions |
string |
| settlement[0].saleVoidTotalNum |
Number of Voided Sale + Void Completed Pre-Authorization transactions |
string |
| settlement[0].refundTotalAmt |
Total amount of Refund transactions |
string |
| settlement[0].refundTotalNum |
Number of Refund transactions |
string |
| settlement[0].refundVoidTotalAmt |
Total amount of Voided Refund transactions |
string |
| settlement[0].refundVoidTotalNum |
Number of Voided Refund transactions |
string |
| settlement[0].txnDate |
Date of the transaction in YYYYMMDD format |
string |
| settlement[0].txnTime |
Time of the transaction in HHMM format |
string |
Release History
| Version |
Type |
Description |
Tracking # |
Date |
| 2.0.1 |
Initial |
First release in the Adapter Type store. |
NAP-25011 |
2023-07-31 |
Categories