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
int64
≥ 1
string
length between 36 and 50

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

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

Any key-value object for adding complementary custom information.

Headers
string

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

Responses

Updated 21 days ago

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 21 days ago