A collection of endpoints for interacting with a remote PAX terminal.
To add a custom background image:
- Tap the top, then bottom, then top, then bottom of the PAYARC Connect screen to open the menu.
- With the menu open a small image icon will appear in the top right.
- Clicking that will open a popup showing the device resolution as well as a field to put a link to the image.
- After the image link is added tapping the "Yes" button will load the image onto PAYARC Connect.
- To close the menu, follow the same tapping process as opening the menu.
If you are using a test account, follow these instructions:
- Change enviornment for this document to Dev. Make sure to update the endpoints you are using to reflect the endpoint changes. To view production endpoints, update the environment to "No Environment".
- On the terminal itself, long press on the Payarc Connect logo. A context menu will appear. Select development.
- For login, all parameters will be found on the testing portal at https://testdashboard.payarc.net/home This will correspond to your test merchant account.
All endpoints besides "Server Info" will return an ErrorCode and ErrorMessage. These can include:
ErrorCode | ErrorMessage |
---|---|
0 | Ok |
1 | Unauthorized |
2 | InvalidAccess |
11 | DeviceSerialNoMissing |
12 | TerminalNotConnected |
13 | FailedToSave |
14 | TerminalError |
15 | TimedOut |
16 | NetworkError |
999 | Exception |
Additional Fields in PaxResponse:
AddlRspData
: Response additional data.
ApprovedAmount
: Approved amount by the host ($$$$$$$CC).
ApprovedCashBackAmount
: Cash back amount approved by the host ($$$$$$$CC).
ApprovedMerchantFee
: Surcharge fee/Merchant fee approved by the host ($$$$$$$CC).
ApprovedTaxAmount
: Tax amount approved by the host ($$$$$$$CC).
ApprovedTipAmount
: Tip amount approved by the host ($$$$$$$CC).
AuthCode
: Transaction authorization code from the payment processor.
AuthorizationResponse
: Original authorization data for follow-up transactions.
AvsResponse
: AVS response.
BogusAccountNum
: Bogus account number.
CardInfo
: Response card information.
CardType
: Card type used.
CvResponse
: CVV response code.
DebitAccountType
: Debit account type.
ECRTransID
: ECR transaction ID (unique on the ECR side).
EDCType
: See EDC type definition.
ExtData
: Additional transaction information.
ExtraBalance
: Extra balance on the card.
FleetCard
: Response fleet card information.
GatewayTransactionID
: Transaction reference number from a gateway.
GiftCardType
: Type of gift card:
C
: Custom value gift card.
P
: Predefined value gift card.
HostCode
: Payment processing host reference number.
HostDetailedMessage
: Additional message or code from the host.
HostResponse
: Payment processing host response.
IssuerResponseCode
: Additional transaction decline details or reporting information.
MaskedPAN
: Masked primary account number (first 6 and last 4 digits visible).
Message
: Host or gateway message.
MultiMerchant
: Response multi-merchant data.
PayloadData
: Host-specific data formatted per specifications.
PaymentAccountReferenceID
: Unique identifier for a cardholder PAN.
PaymentEmvTag
: Response EMV tag data.
PaymentService2000
: Original payment service 2000.
PaymentTransInfo
: Transaction information response.
RawResponse
: Gateway raw response.
RefNum
: Reference number/transaction number.
RemainingBalance
: Remaining balance on the card.
RequestedAmount
: Original requested transaction amount.
Restaurant
: Restaurant-specific response data.
ResultCode
: Result code of the transaction.
ResultTxt
: Result text of the transaction.
RetrievalReferenceNumber
: Reference number for tracking a transaction until settlement.
SigFileName
: Filename of the captured signature.
SignData
: Signature data captured by the terminal.
Timestamp
: Transaction timestamp.
TORResponseInfo
: TOR response information.
Track1Data
: Track 1 data (valid for gift cards).
Track2Data
: Track 2 data (valid for gift cards).
Track3Data
: Track 3 data (valid for gift cards).
TransactionIntegrityClass
: Assigned by MasterCard for a U.S. merchant.
TransactionRemainingAmount
: Remaining amount of the original authorization after a void/refund ($$$$$$$CC).
VASResponseInfo
: VAS response information.