v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB

Payments

Cancel transfer funds

Note: Enhanced features and improvements are available in the Payment methods API, the new application interface for non-card network authorizations. This Cancel transfer funds endpoint is still supported, but all new feature developments will be available only in the Payment methods API. For more information, contact your Pismo representative.

Cancel a previously authorized transfer made with the Transfer funds endpoint. Pass one of two parameters (but not both) returned from the Transfer funds endpoint to identify the transfer to be canceled:

The tracking_id (pass as original_tracking_id)
The credit or debit authorization ID (pass as authorization_id).

For an external operation, the acquirer response is returned in the metadata field. If no processing codes are specified, the original authorization's reversal processing codes are used.

This endpoint generates an Authorization cancelled event.

For additional information, see the Cancel transfer guide.

post/payments/v2/cancel

Headers

x-tenantstring required

Example:TN-c0e4c660-9059-404c-ab22-761aa431766c

Unique Org ID.

x-cidstring

Example:c737895c-8159-4c0c-a92a-a4f8600bff37

Related correlation ID. If none is provided, a random one is generated.

Request body

authorization_idinteger

Credit or debit authorization ID (authorization_ids.credit or authorization_ids.debit) returned in the response of the original transfer from the Transfer funds endpoint.

Either this field or the original_tracking_id field is REQUIRED to identify the original transfer that needs to be canceled with this request.

tracking_idstring

Unique tracking ID of the pending cancellation. If you don't provide one, the Pismo platform generates it randomly. This field is useful for tracking and searching transaction information.

This field needs to be sent to guarantee the idempotence of the request. Requests that use the same tracking_id are considered the same. If tracking_id is not received, each request is treated as a new one.

original_tracking_idstring

Unique tracking ID of the original operation to be cancelled, which is returned from the Transfer funds endpoint as tracking_id.

Either this field or the authorization_id field is REQUIRED to identify the original transfer that needs to be cancelled with this request.

amountnumber float required

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

cancel_feesboolean

Indicates whether to cancel associated fees when canceling a transfer operation. When set to true, if a total or partial cancellation of an operation with a fee occurs, the platform automatically cancels the associated fee also. When this flag is not provided:

if a total cancellation of an operation with a fee occurs, the platform automatically cancels the fee also.
if a partial cancellation of an operation with a fee occurs, the platform does not cancel the fee.

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.

descriptorstring

This field allows you to provide an optional cancellation description.

The Pismo platform passes this field to the acquirer in transactions involving calls to the acquirer.

Example request

{
  "authorization_id": 15301234,
  "tracking_id": "1ff51e99-3a05-448a-bc19-7b5c05274174",
  "original_tracking_id": "0d240226-d03e-47eb-ab3f-6d57c7d5feeb",
  "amount": 9.95,
  "processing_code": {
    "credit": "002000",
    "debit": "004000"
  },
  "acquirer": {
    "credential": {
      "code": "5f1c280e-ffde-4081-a126-5f2f10a96c2f"
    }
  },
  "metadata": "{ \"key\": \"value\"}",
  "descriptor": "eShop purchase cancellation"
}

Response

tracking_idstring required

Provided tracking_id or the identifier automatically generated by the Pismo platform.

authorization_datetimestring

Authorization timestamp in the UTC-0 (RFC3339) format.

metadatastring

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

Example response

{
  "tracking_id": "be68db6e-8da0-4761-8632-6a51857bd123",
  "authorization_datetime": "2006-01-02T15:04:05.000Z",
  "authorization_ids": {
    "credit": 15301234,
    "debit": 15301235
  },
  "metadata": "{ \"key\": \"value\"}"
}