---
title: "Cancel transfer"
method: POST
path: "/payment-methods/v2/transfers/cancel"
tags: ["Payment methods"]
---

# Cancel transfer

`POST /payment-methods/v2/transfers/cancel`

## Request

- Base URL: `https://sandbox.pismolabs.io`
- URL: `https://sandbox.pismolabs.io/payment-methods/v2/transfers/cancel`
- Auth: HTTP bearer

Cancel an existing transfer operation. If you don't provide the `amount`, the platform cancels the total original amount. You can also provide the `amount` to cancel a total or partial amount.

Refer to the [Payment methods](doc:payment-methods) guide for additional information.

This endpoint generates a [Platform authorization created](https://developers.pismo.io/events/docs/platform-authorization-platform-authorization-1) event.

**Note:** This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment.

## Request body

- PaymentsCancelRequest: Request payment cancellation.
  - `tracking_id` string, required: Unique tracking ID for this operation.
  - `original_tracking_id` string, required: Tracking ID for the original operation.
  - `amount` number, float: Credit or debit amount.
  - `metadata` Metadata: 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](ref:get-started-with-pismo-apis#metadata).

## Response `200`

Request was processed successfully, existing authorization with the corresponding `tracking_id` returned.

- TransfersCancelResponse
  - `tracking_id` string: Unique tracking ID for this operation.
  - `response_code` string: Alphanumeric two-character standard card network response code or an alternative custom response code, which provides the precise reason for the success or denial of the operation by the card network, platform, or anti-fraud solution.
  - `denial_code` string: Denial code.
  - `from` PaymentsCancelResponse: Response for a cash-in or cash-out cancel operation.
    - `authorization_id` integer, required: Unique Pismo-generated ID of the authorization created for this request. Returned on 200 and 201 responses, including idempotent replays.
    - `tracking_id` string, required: Unique tracking ID for this operation.
    - `account_id` integer: Pismo account ID.
    - `response_code` string, required: Alphanumeric two-character standard card network response code or an alternative custom response code, which provides the precise reason for the success or denial of the operation by the card network, platform, or anti-fraud solution.
    - `denial_code` string: Denial code.
    - `validation_results` object[]
      - `name` string: Name of the evaluated rule.
      - `status` 'APPROVED' | 'REJECTED' | 'SKIPPED': Identifies if the rule was approved, rejected, or skipped during the validation flow.
      - `reason` string: Status reason why the specific rule was approved, rejected, or skipped.
      - `description` string: Description of the validation result.
      - `additional_data` object: Additional data for the validation result. This varies from validation to validation, but every denied validation has the `denial_code` and `response_code` fields.
  - `to` PaymentsCancelResponse: Response for a cash-in or cash-out cancel operation.
    - `authorization_id` integer, required: Unique Pismo-generated ID of the authorization created for this request. Returned on 200 and 201 responses, including idempotent replays.
    - `tracking_id` string, required: Unique tracking ID for this operation.
    - `account_id` integer: Pismo account ID.
    - `response_code` string, required: Alphanumeric two-character standard card network response code or an alternative custom response code, which provides the precise reason for the success or denial of the operation by the card network, platform, or anti-fraud solution.
    - `denial_code` string: Denial code.
    - `validation_results` object[]
      - `name` string: Name of the evaluated rule.
      - `status` 'APPROVED' | 'REJECTED' | 'SKIPPED': Identifies if the rule was approved, rejected, or skipped during the validation flow.
      - `reason` string: Status reason why the specific rule was approved, rejected, or skipped.
      - `description` string: Description of the validation result.
      - `additional_data` object: Additional data for the validation result. This varies from validation to validation, but every denied validation has the `denial_code` and `response_code` fields.

## Other responses

- `201`: Request was processed successfully, new authorization created.
- `400`: Bad request
- `404`: Access token is missing or invalid.
- `409`: Conflict
- `422`: Unprocessable request
- `500`: Internal server error

---

[API](https://skmtc.dev/pismo/apis/core-platform-payment-methods.md) - [All operations](https://skmtc.dev/pismo/apis/core-platform-payment-methods/llms.txt) - [OpenAPI document](https://skmtc.dev/pismo/apis/core-platform-payment-methods/revisions/ab9e879a54e0?raw)