API Reference
Start typing to search…

Initiate a void.

post
https://payarcconnectapi.payarc.net/v3/transactions/void

This API endpoint allows you to send a void command to the terminal for a previously submitted sale. The final outcome is delivered asynchronously to the callbackURL.

Body Params
string
required

12-digit merchant identifier (MID).

string
required

10-digit terminal serial number.

string
required
length ≤ 16

Client-generated transaction identifier used for reconciliation.

string
required
length ≤ 16

Original sale transaction identifier being voided.

string
enum
required

Tender type used on the original transaction.

Allowed:
string | null

Reason for the void request.

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.

Headers
string
required

Bearer token used to authenticate API requests.

uuid
required

Unique key used to prevent duplicate transaction commands.

Responses

Callback

Updated 13 days ago

Language
Credentials
Bearer
JWT
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 13 days ago