PApayarc
Transactions

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 with 409 TERMINAL_OFFLINE without sending any command to the terminal.

post/v3/transactions/auth

Request

  • Base URL
    https://testpayarcconnectapi.payarc.net
  • URL
    https://testpayarcconnectapi.payarc.net/v3/transactions/auth
  • Auth
    HTTP bearer

Headers

Authorizationstring required

Bearer token used to authenticate API requests.

X-Idempotency-Keystring uuid required

Unique key used to prevent duplicate transaction commands.

Request body

tenantIdstring required

12-digit merchant identifier (MID).

terminalIdstring required

10-digit terminal serial number.

transactionIdstring required

Client-generated transaction identifier used for reconciliation.

tokenizeCardboolean nullable

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

printReceipt0 | 1 | 2 | 3 required

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

callbackURLstring required

HTTPS endpoint that receives the asynchronous callback payload.

metadataobject

Example request

{
  "tenantId": "145504363463",
  "terminalId": "1850401309",
  "amount": {
    "currency": "USD"
  },
  "callbackURL": "https://example.com/payarc/callback"
}

Response

Transaction Initiated

traceIdstring uuid

Correlation identifier matching the initial API response traceId

Example response

{
  "response": {
    "status": "SUCCESS"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.