POS Charge Actions

Refund Charge [EXPERIMENTAL]

Notice: This endpoint has different server URLs and authorization method than the rest of the API.

Refunds a POS charge.

post/pos/charges/{chargeKey}/refund

Request

Path parameters

chargeKeystring required

Uniquely identifies a charge.

Example:chg-1e1dAHhgstYTUhlphPzZ

Uniquely identifies a charge.

Headers

Idempotency-Keystring

This key is used to deduplicate requests that are retried. For more information see the section on Idempotency.

Example:28gKCluIEKp8jVboUyr2

Request body

attemptCancelboolean

If true and the charge has not been cleared yet, the service attempts to cancel the transaction first. On success, returns a "ReversalAction". On failure, falls back to the refund process.

referencestring

Action reference assigned by the agent. Must not start with "act-". This allows merchants to track actions with their own reference system.

clearAfterstring iso-8601-date-time

If provided, clearing will not occur before this point in time. From August 13, 2025, clearAfter may be at most 6 months in the future from when the charge was created.

Example request

{
  "reference": "cancel-001",
  "dynamicDescriptor": {
    "merchantName": "Acme Inc.",
    "merchantCity": "Amsterdam"
  }
}

Response

Refund action created (either reversal or refund)

OR

Example response

{
  "key": "rvsl-5BH5chO93SXky5gw",
  "chargeKey": "chg-1e1dAHhgstYTUhlphPzZ",
  "reference": "cancel-001",
  "replacementAmount": {
    "value": 2599,
    "currency": "EUR",
    "breakdown": {
      "baseAmount": 2599,
      "cashback": 2599,
      "gratuity": 2599
    }
  },
  "authorizationResponse": {
    "responseCode": "00",
    "responseCodeDescription": "Approved"
  },
  "version": 1
}

Changes

No recorded changes to this operation across all 1 revision of this API.