v1

latestOpenAPI 3.0.02026-07-263118119.8 KB
Create & Manage Transactions

transactionRefunds

Retrieve the current refund state for a specific transaction.

Returns two arrays:

  • refunds — processed or pending reversal transactions. Shape matches a standard transaction object. Always present; empty when no refunds have been processed.
  • queuedRefunds — individually tracked refunds that have been requested but not yet processed (e.g. the original transaction has not yet cleared). Each item has id, referenceId, amount (with amount and currency), and status (queued or abandoned). Always present; empty when nothing is queued.

The id on a queued refund item is the uuid assigned at the time POST /v2/reverseTransaction was called (either supplied by the client or system-generated). That same uuid becomes the id of the resulting reversal transaction once processed.

Multiple reversals: A transaction can have more than one independent reversal. Each POST /v2/reverseTransaction call produces its own record. Both refunds and queuedRefunds may contain multiple entries.

<details> <summary><strong>Error Glossary</strong> (click to expand)</summary>
CodeHTTP StatusMessage
AP011401Unauthorized
AP101401No authenticated user
AP700400Missing or invalid required parameter
AP701400Improperly formatted parameter
</details>
get/v2/transaction/{transactionUUID}/refunds

Headers

Content-Typestring
authorizationstring required

A userForMerchant scoped token.

Response

Success - Transaction refunds retrieved

Example response

{
  "refunds": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "amount": {
        "amount": 5000,
        "currency": "USD"
      },
      "status": "processed",
      "paymentType": "reversal",
      "userId": "2ac82269-9315-4bb6-8a19-f37e20d50238",
      "title": "Refund for Online Transaction",
      "referenceId": "0123456789",
      "attributes": [],
      "createdDate": "2026-01-22T10:30:00+00:00",
      "modifiedDate": "2026-01-22T10:30:00+00:00",
      "apFee": "0.00",
      "isRtp": false,
      "merchantId": 582,
      "locationId": 541,
      "userAccountId": 1139036
    }
  ],
  "queuedRefunds": []
}