SIsilverflow
Charge Actions

Offline-Refund Charge

Performs an offline-refund of an authorized charge. This refund will be cleared without issuer authorization.

For American Express and Diners, this endpoint supports refunding charges for up to 6 months after their creation. When trying to refund a charge older than that, it will return an HTTP 409 error with type /silverflow/problems/charge/invalid-operation.

Requires charges:OfflineRefund permission.

post/charges/{chargeKey}/offlineRefund

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 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.

Example request

{
  "amount": 2599,
  "reference": "MyRef",
  "dynamicDescriptor": {
    "merchantName": "Acme Inc.",
    "merchantCity": "Amsterdam"
  },
  "initialRefundReferences": {
    "initialTraceId": "MCGATSGHX1112"
  }
}

Response

The resulting offline refund action

type'offline-refund' 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-".

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",
  "reference": "MyRef",
  "amount": {
    "value": 2599,
    "currency": "EUR"
  },
  "initialRefundReferences": {
    "initialTraceId": "MCGATSGHX1112"
  },
  "version": 1
}

Changes

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