API Reference

Sale

post
https://testpayarcconnectapi.payarc.net/v3/transactions/sale

This API endpoint enables you to charge a credit card via a terminal by sending a sale 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.

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.

string
enum
required

Tender type used on the transaction.

Allowed:
amount
object
required

Message amount providing total, subtotal, currency, tip, and tax.

boolean | null

Whether a tip is requested

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

Optional key-value metadata used for correlation and diagnostics.

splits
array of objects | null

Optional split-funding instructions for PAYFAC sale requests only. Do not include this field for standard traditional sales. Each mid must be a non-processing PAYFAC MID, sent as a 16-digit string with the required leading 0. For example: 0709900000098856.

splits
Headers
uuid
required

Unique key used to prevent duplicate transaction commands.

Responses

Callback

Updated 6 months ago

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

Updated 6 months ago

Did this page help you?