SIsilverflow
Charge Actions

Manually Clear Charge

Manually clear the charge after its creation. This endpoint also allows for (multiple) partial clearing, by providing an amount that is different from the original amount.

Please note that there are currently no restrictions on the amount or the number of times you can clear a charge; this is the responsibility of the client.

This endpoint supports clearing charges for up to 6 months after their creation. When trying to clear a charge older than that, it will return an HTTP 409 error with type /silverflow/problems/charge/too-old.

Requires charges:Clear permission.

post/charges/{chargeKey}/clear

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

amountinteger

The amount to clear. If omitted, the full amount of the charge will be cleared.

The amount should be 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.

closeChargeboolean

Indicates if the series of clearings for this transaction ends after the current clearing. Only relevant when doing partial clearing.

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.

referencestring

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

Example request

{
  "amount": 900,
  "reference": "MyRef",
  "enhancedData": {
    "taxAmount": 300,
    "customerCode": "REF12345",
    "destinationAddress": {
      "countryCode": {
        "alpha3": "NLD"
      },
      "postalCode": "1234BC"
    },
    "discountAmount": 50,
    "orderDate": "2026-05-01",
    "shippingAddress": {
      "postalCode": "1234BC"
    },
    "timeOfPurchase": "1402"
  }
}

Response

The resulting clearing action.

type'clearing' required
keystring required

Uniquely identifies an action

chargeKeystring required

Uniquely identifies a charge.

referencestring

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

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",
  "reference": "MyRef",
  "amount": {
    "value": 2599,
    "currency": "EUR"
  },
  "enhancedData": {
    "taxAmount": 300,
    "customerCode": "REF12345",
    "destinationAddress": {
      "countryCode": {
        "alpha3": "NLD",
        "alpha2": "NL",
        "numeric": "528"
      },
      "postalCode": "1234BC"
    },
    "discountAmount": 50,
    "orderDate": "2026-05-01",
    "shippingAddress": {
      "postalCode": "1234BC"
    },
    "timeOfPurchase": "1402"
  },
  "version": 1
}

Changes

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