Sign in

v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Force operations

Cancel forced operation

Cancel forced operation. Only works with forced operations and with the total amount.

This endpoint generates an Authorization cancelled event with authorization > type "FORCE".

post/payments/v1/payments/force/cancel

Headers

x-skip-timelinestring
Example:true

If set to true, this will prevent the generation of timeline events in the customer timeline.

Request body

authorization_idinteger
tracking_idstring

Unique tracking ID of the cancellation. If you don't provide one, the Pismo platform generates it randomly.

amountnumber float

Optional full or partial amount to cancel, which cannot be more than the original transaction amount. Maximum of two decimal places.

original_tracking_idstring

Either this field or authorization_id is REQUIRED. Unique tracking ID of the original operation to be canceled. Returned from the force request (v1/payments/force) as tracking_id.

cancel_feesboolean

Indicates whether to cancel associated fees when canceling a forced operation. Default value is false.

  • If set to true, when the cancel forced operation is performed, the associated fees on the original forced operation are cancelled also.
  • If set to false, when the cancel forced operation is performed, the associated fees on the original forced operation are not cancelled.
descriptorstring

Optional text that describes the created authorization. The platform supports only letters and numbers in this field and removes any special characters or emojis.

metadatastring

Any data object with key/value pairs. No limit on length.

Note: This field must not be used to send Personally Identifiable Information (PII), Payment Card Industry (PCI) data, or any sensitive/regulated information. Metadata fields are intended for operational, non-sensitive data only. For sensitive data, use the specific parameters designed for that purpose. For more information, refer to Get started with Pismo APIs.

Example request

{
  "authorization_id": 15301234,
  "tracking_id": "1ff51e99-3a05-448a-bc19-7b5c05274174",
  "original_tracking_id": "0d240226-d03e-47eb-ab3f-6d57c7d5feeb",
  "descriptor": "Single credit adjustment",
  "metadata": "{ \"key\": \"value\"}"
}

Response

OK

authorization_idinteger required

Generated cancellation authorization ID

event_datestring date-time required

Date and time of the cancellation authorization, in the UTC-0 (RFC3339) format.

tracking_idstring required

Unique 36-character identifier for the forced cancellation operation. If you didn't provide an identifier, then the Pismo platform automatically generates and includes one in the response.

Example response

{
  "authorization_id": 15301234,
  "event_date": "2020-01-02T15:14:00.218Z",
  "tracking_id": "82766158-514c-42f0-87e2-1bb3250c6dee"
}