SIsilverflow
Charge Actions

Increment Charge

Performs an increment on a charge. Note that this is not allowed if the charge has previously been cleared (either partially or fully).

Increment support for Diners 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>.

For decreasing the authorization amount, please see Reverse charge.

Requires the charges:Increment permission.

post/charges/{chargeKey}/increment

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 required

The new total authorized amount (initial amount plus increment).

referencestring

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

Example request

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

Response

The resulting increment action

type'increment' 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.