Initiate a refund.

post

https://payarcconnectapi.payarc.net/v3/transactions/refund

This API endpoint supports two refund flows. Include originalTransactionId for a linked refund against a previous sale; omit it for a blind credit refund. The final approval/decline result is delivered asynchronously to the callbackURL.

Body Params

tenantId

string

required

12-digit merchant identifier (MID).

terminalId

string

required

10-digit terminal serial number.

transactionId

string

required

length ≤ 16

Client-generated transaction identifier used for reconciliation.

originalTransactionId

string | null

Original sale transaction identifier for a linked refund. Omit this field to run the existing blind credit refund flow.

tenderType

string

enum

required

Tender type used on the original transaction.

Allowed:

amount

object

required

Message amount providing total and currency for refunds.

reason

string | null

Reason for the Refund.

printReceipt

integer

enum

required

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

Allowed:

callbackURL

string

required

HTTPS endpoint that receives the asynchronous callback payload.

metadata

object

Headers

Authorization

string

required

Bearer token used to authenticate API requests.

X-Idempotency-Key

uuid

required

Unique key used to prevent duplicate transaction commands.

Responses

Callback

Language

Credentials

Bearer

JWT

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Transaction Initiated

400Invalid Request