Pre Auth

This API endpoint initiates a pre-authorization command to a terminal. The final approval/decline result is delivered asynchronously to the callbackURL. Terminal connectivity gate: the request returns immediately; before dispatching, the endpoint verifies the terminal is connected to Payarc Connect and, if it is not, responds immediately without sending any command to the terminal. It returns 409 TERMINAL_OFFLINE if the terminal was connected before but is offline now, 409 TERMINAL_NOT_ON_V3 if the terminal has never connected to Payarc Connect V3 (its app is likely set to V1/V2), or 503 TERMINAL_STATUS_UNAVAILABLE if its connectivity could not be verified. Tips are not supported on an auth: amount.tip must be 0, null, or omitted; a request with a non-zero amount.tip is rejected with 400 INVALID_REQUEST and no command is sent to the terminal. Apply the tip on the post-auth request.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
^[0-9]{12}$

12-digit merchant identifier (MID).

string
required
^[0-9]{10}$

10-digit terminal serial number.

string
required
length ≤ 16
^[A-Za-z0-9]{1,16}$

Client-generated transaction identifier used for reconciliation.

amount
object
required

Message amount providing total, subtotal, currency, and tax. Do not include a tip (a non-zero amount.tip) on an auth; tips are not supported on authorizations and the request is rejected with 400 INVALID_REQUEST. total must equal subtotal + tax. Collect the tip on the post-auth request instead.

boolean | null

Determines whether or not the terminal should tokenize the card for the given transaction.

integer
enum
required

Allowed values:
0 – No receipt
1 – Print merchant receipt
2 – Print customer receipt
3 – Print both merchant and customer receipts

Allowed:
string
required

HTTPS endpoint that receives the asynchronous callback payload.

metadata
object
Headers
uuid
required

Unique key used to prevent duplicate transaction commands.

Responses

Callback
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json