🗝️Authentication

Payarc Connect uses a two-step authentication process, which is different from the Merchant and Agent/Partner APIs.

Step 1 – Login with your API/Bearer Token

Use the API/Bearer Token from your Merchant Dashboard to make a Login call.

Step 2 – Use the Access Token for all other calls

The Login call returns an Access Token.
You must use this Access Token to authenticate all other Payarc Connect API requests — such as Transactions, Last Transaction, ServerInfo, or Terminal endpoints.

In short:
➡️ Use your API/Bearer Token only to call Login.
➡️ Use the Access Token (returned from Login) for all other Payarc Connect endpoints.

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:

Be sure to be using the Payarc Connect Test app, this separate app will only connect to the Payarc Testing environment and is not to be used in production.
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, ErrorMessage, and a FriendlyMessage. These can include:

ErrorCode	ErrorMessage	FriendlyMessage
0	Ok
1	Unauthorized
2	Invalid Access	The user does not have access. If you continue to receive this error, please contact support.
11	Device Serial Number Missing	The device serial number is missing. Please contact support.
12	Terminal Not Connected	The terminal is not connected. Please check the terminal's connection and try again. If you continue to receive this error, please contact support.
13	Failed To Save	Error: failed to save to database, please try again. If you continue to receive this error, please contact support.
14	TerminalError: Invalid Card Type, Aborted	PAX Error: An error occurred on the terminal. If you continue to receive this error, please contact support.
15	Timed Out	PAX Error: The transaction timed out. Please try again. If you continue to receive this error, please contact support.
16	Network Error	Network error, please check the terminal's connection and try again. If you continue to receive this error, please contact support.
18	Missing Callback URL	Missing callback URL. If you continue to receive this error, please contact support.
19	Callback URL is not supported in V1. Please use V2 instead.	Callback URL is not supported in this version. Please use V2 instead.
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.