v1

latestOpenAPI 3.1.02026-07-24170121.2 MB

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.

post/v3/transactions/refund

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

The last 12 digits of the merchant identifier (MID).

terminalIdstring required

10-digit terminal serial number.

transactionIdstring required

Client-generated transaction identifier used for reconciliation.

originalTransactionIdstring nullable

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

tenderType'CREDIT' | 'DEBIT' required

Tender type used on the original transaction.

reasonstring nullable

Reason for the Refund.

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": {
    "total": 540,
    "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"
  }
}