APIs
Sub-processorsAbout PismoContact us

Cancel forced operation

post
https://sandbox.pismolabs.io/payments/v1/payments/force/cancel

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

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request object for POST v1/payments/force/cancel.

int64
≥ 1
string
length between 36 and 50
^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$

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

float

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

string
length between 36 and 50
^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$

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.

boolean

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

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

metadata
object

This optional user-defined key-value object field can be used with external operations to provide additional context or supplementary custom information for the operation.

The Pismo platform does not perform any validation or processing on this field but passes this object to the acquirer in transactions involving calls to the acquirer and sends it in the events related to the stream of data produced at the end of the request.

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.

Headers
string

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

Responses

Updated about 2 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago

Did this page help you?