SIsilverflow
Charge Actions

Reverse Charge

Performs a reversal of a charge. This means that the authorization will be reversed. If no request body is provided, the full current charge amount will be reversed (taking into account reversals and increments).

Note that there are currently no restrictions on the amount you can reverse in relation to previous clearings; this is the responsibility of the client.

Diners and ATM Charge 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 the charges:Reverse permission.

post/charges/{chargeKey}/reverse

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

replacementAmountinteger

The amount to replace the original authorization with. Note that this is not the amount to be reversed. If zero, the full current charge amount will be reversed. If a non-zero amount is provided, a partial reversal will be done.

When reversing Visa POS transactions with cashback, this value must be 0.

referencestring

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

Example request

{
  "replacementAmount": 2599,
  "reference": "MyRef"
}

Response

The resulting reversal action.

type'reversal' 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",
  "replacementAmount": {
    "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.