SIsilverflow
Charge Actions

Refund Charge

Performs a refund of a charge.

It is only possible to refund charges with the following type.intent:

  • purchase
  • reservation
  • funding

Diners support is <a class="experimental-tag-link" href="https://docs.silverflow.com/guides/api-lifecycle#tag/EXPERIMENTAL-Tag"><span class="tag experimental-tag">EXPERIMENTAL</span></a>.

Requires charges:Refund permission.

For more information, see the guide page.

post/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

refundAmountinteger

The refund amount. If not specified the full authorized charge amount will be refunded.

referencestring

Action reference assigned by the agent. Must not start with "act-".

clearAfterstring iso-8601-date-time

If provided, clearing will not occur before this point in time. If no timezone is included, it is assumed to be UTC. The value may be at most 6 months in the future from when the charge was created.

createRefundChargeboolean

A full refund charge will be created along with the refund action.

On 23 February 2027, this field will be removed. Refunds on this endpoint will then always create a refund charge.

clearingMode'auto' | 'manual'

The clearing method for the refund charge.

  • auto: The charge is cleared automatically as soon as possible. To delay clearing, provide a clearAfter timestamp.
  • manual: The charge must be manually cleared later.

Only supported if createRefundCharge is set to true.

Example request

{
  "refundAmount": 2599,
  "reference": "MyRef",
  "dynamicDescriptor": {
    "merchantName": "Acme Inc.",
    "merchantCity": "Amsterdam"
  }
}

Response

The resulting refund action.

type'refund' required
keystring required

Uniquely identifies an action

chargeKeystring required

Uniquely identifies a charge.

refundChargeKeystring

Charge key of the created refund charge. Included only when the refund was created with createRefundCharge = true.

referencestring

Action reference assigned by the agent. Must not start with "act-".

clearAfterstring iso-8601-date-time

If provided, clearing will not occur before this point in time. If no timezone is included, it is assumed to be UTC. The value may be at most 6 months in the future from when the charge was created.

createdstring iso-8601-date-time required

The date and time this object was created

lastModifiedstring iso-8601-date-time

The date and time this object was last modified

versioninteger required

The version of this object

Example response

{
  "key": "act-1e1dA2fgs1YTUhlhyPOp",
  "chargeKey": "chg-1e1dAHhgstYTUhlphPzZ",
  "refundChargeKey": "chg-1e1dAHhgstYTUhlphPzZ",
  "reference": "MyRef",
  "amount": {
    "value": 2599,
    "currency": "EUR"
  },
  "authorizationResponse": {
    "responseCode": "00",
    "responseCodeDescription": "Approved"
  },
  "version": 1
}

Changes

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