---
title: "Refund Charge"
method: POST
path: "/charges/{chargeKey}/refund"
tags: ["Charge Actions"]
---

# Refund Charge

`POST /charges/{chargeKey}/refund`

## Request

- Base URL: `https://eu-west-1.api.silverflow.com/v1`
- URL: `https://eu-west-1.api.silverflow.com/v1/charges/{chargeKey}/refund`
- Auth: one of:
  - HTTP basic
  - HTTP bearer
- TypeScript: <https://skmtc.dev/silverflow/apis/silverflow-api/docs/charges/:chargeKey/refund/post.ts> (a function with typed inputs; its response is checked against the schema)

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](https://docs.silverflow.com/guides/charge-actions#tag/Refunds).

## Path parameters

- `chargeKey` string, required: Uniquely identifies a charge.

## Headers

- `Idempotency-Key` string: This key is used to deduplicate requests that are retried. For more information see the section on [Idempotency](https://docs.silverflow.com/guides/idempotency).

## Request body

- ChargeRefund: Refund a Charge
  - `refundAmount` integer: The refund amount. If not specified the full authorized charge amount will be refunded.
  - `reference` string: Action reference assigned by the agent. Must not start with "act-".
  - `clearAfter` string, 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.
  - `dynamicDescriptor` SchemasDynamicDescriptor: Field supports the merchant customizing the DBA name and city on a per-transaction basis, to allow the cardholder to recognize the business name and city on their card or bank statement.
    - `merchantName` string: Recognizable business name that will appear on the customer's card or bank statement.
    - `merchantCity` string: City from which the transaction originated
  - `createRefundCharge` boolean: 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`**.

## Response `201`

The resulting refund action.

- RefundAction: Action for refunding a charge
  - `type` 'refund', required
  - `key` string, required: Uniquely identifies an action
  - `chargeKey` string, required: Uniquely identifies a charge.
  - `refundChargeKey` string: Charge key of the created refund charge. Included only when the refund was created with `createRefundCharge = true`.
  - `reference` string: Action reference assigned by the agent. Must not start with "act-".
  - `amount` CommonAmount, required: The amount encoded as an object with a `value` in minor units and a `currency` code.
    - `value` integer, required: The amount in minor units. For example `$12.34` should be encoded as `1234`. Note that not all currencies have 2 minor units. Some have three or zero.
    - `currency` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XCG' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL', required: An alphabetic ISO-4217 currency code.
  - `status` object, required
    - `authorization` 'approved' | 'declined', required
  - `clearAfter` string, 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.
  - `authorizationResponse` union, required: Network-specific details from the authorization response. Actions created before 2023-10-07 will have the `network` property and other remaining properties as `unknown`.
    - object
      - `network` 'american-express', required
      - `responseCode` string, required: Contents of field 39
      - `responseCodeDescription` string, required: The description of the `responseCode`
      - `acquirerReferenceData` string, required: Contents of field 31. <a class="experimental-tag-link" href="https://docs.silverflow.com/guides/api-lifecycle#tag/EXPERIMENTAL-Tag"><span class="tag experimental-tag">EXPERIMENTAL</span></a>
    - object
      - `network` 'bancontact', required
      - `responseCode` string, required: Contents of field 39
      - `responseCodeDescription` string, required: The description of the `responseCode`
    - object
      - `network` 'diners', required
      - `responseCode` string, required: Contents of field 39
      - `responseCodeDescription` string, required: The description of the `responseCode`
      - `networkReferenceId` string, required: Contents field 123 <a class="experimental-tag-link" href="https://docs.silverflow.com/guides/api-lifecycle#tag/EXPERIMENTAL-Tag"><span class="tag experimental-tag">EXPERIMENTAL</span></a>
    - object
      - `network` 'discover', required
      - `responseCode` string, required: Contents of field 39
      - `responseCodeDescription` string, required: The description of the `responseCode`
      - `networkReferenceId` string, required: Contents field 48, position 11-25 <a class="experimental-tag-link" href="https://docs.silverflow.com/guides/api-lifecycle#tag/EXPERIMENTAL-Tag"><span class="tag experimental-tag">EXPERIMENTAL</span></a>
    - object
      - `network` 'mastercard', required
      - `responseCode` string, required: Contents of field 39
      - `responseCodeDescription` string, required: The description of the `responseCode`
      - `traceId` string, required: The trace ID can be used to refer to the original authorization for subsequent transactions (e.g., reversals, MITs). <a class="experimental-tag-link" href="https://docs.silverflow.com/guides/api-lifecycle#tag/EXPERIMENTAL-Tag"><span class="tag experimental-tag">EXPERIMENTAL</span></a> The value is constructed from the contents of field 63, subfield 1, field 63, subfield 2, and field 15. The value intentionally ends with two spaces.
    - object
      - `network` 'unionpay', required
      - `responseCode` string, required: Contents of field 39
      - `responseCodeDescription` string, required: The description of the `responseCode`
    - object
      - `network` 'visa', required
      - `responseCode` string, required: Contents of field 39
      - `responseCodeDescription` string, required: The description of the `responseCode`
      - `transactionIdentifier` string, required: Contents of field 62, subfield 2 <a class="experimental-tag-link" href="https://docs.silverflow.com/guides/api-lifecycle#tag/EXPERIMENTAL-Tag"><span class="tag experimental-tag">EXPERIMENTAL</span></a>
    - object
      - `network` 'unknown', required
      - `responseCode` 'unknown', required
      - `responseCodeDescription` 'unknown', required
  - `created` string, iso-8601-date-time, required: The date and time this object was created
  - `lastModified` string, iso-8601-date-time: The date and time this object was last modified
  - `version` integer, required: The version of this object

## Other responses

- `400`: The request body was malformed
- `401`: Authentication information is missing or invalid
- `403`: The authenticated client is forbidden to make the request for the resource identified.
- `404`: The requested resource was not found
- `409`: Conflict
- `429`: Too Many Requests
- `500`: Internal Server Error

---

[API](https://skmtc.dev/silverflow/apis/silverflow-api.md) - [All operations](https://skmtc.dev/silverflow/apis/silverflow-api/llms.txt) - [OpenAPI document](https://skmtc.dev/silverflow/apis/silverflow-api/revisions/43ecbe4fd6ea?raw)