---
title: "Cancel payment"
method: POST
path: "/corporate/v2/payments/cancel"
tags: ["Payments"]
---

# Cancel payment

`POST /corporate/v2/payments/cancel`

## Request

- Base URL: `https://sandbox.pismolabs.io`
- URL: `https://sandbox.pismolabs.io/corporate/v2/payments/cancel`
- Auth: HTTP bearer

Cancel an existing payment operation.

NOTE:
- This endpoint requires an account token - an access token encoded with an external account ID. Tokens can expire quickly, which can result in a `401 Unauthorized` message.

This endpoint generates the following events:
- [Platform authorization created](https://developers.pismo.io/events/docs/platform-authorization-platform-authorization-1)
- [Account balance changed](https://developers.pismo.io/events/docs/account-balances-balance-change-1)
- [Account balance changed (Availables)](https://developers.pismo.io/events/docs/availables-change-available-1)

Refer to [Data and reporting](doc:data-reporting-overview) for more information on events and setting up event notifications.

## Request body

- CancelPaymentV2Request
  - `original_tracking_id` string, required: Tracking ID for the original operation.
  - `tracking_id` string, required: A unique payment tracking number provided by the client. If an existing `tracking_id` is found on the Pismo platform, the API returns a `409` error. This field is: * Unique within the organization * Immutable: It can't be updated * Not recyclable: You can't reuse a `tracking_id`
  - `cancellation_method` 'INSTANT' | 'ORIGINAL_DATES': Define the cancellation method used to determine which dates the cancellation will impact the account balance. * `INSTANT` (default): Cancels the payment using the current business date. * `ORIGINAL_DATES`: Cancels the payment using the original payment dates.
  - `skip_account_date_validation` boolean: If `FALSE`, the `payment_datetime` is validated against the account creation date and time. If `TRUE`, the validation is skipped.
  - `metadata` ConfirmPaymentMetadata: Key-value pairs containing data intended for storage in the Pismo system.<br> **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).

## Response `201`

Created

- SettlementV2Response
  - `original_tracking_id` string: Tracking ID for the original operation.
  - `tracking_id` string: A unique payment tracking number provided by the client. If an existing `tracking_id` is found on the Pismo platform, the API returns a `409` error. This field is: * Unique within the organization * Immutable: It can't be updated * Not recyclable: You can't reuse a `tracking_id`
  - `event_datetime` string, date-time: Event date and time displayed in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.<br> `minLength: 1` `maxLength: 30`

## Other responses

- `400`: Bad request
- `401`: Unauthorized
- `403`: The request has been lost
- `404`: Bad request
- `409`: Conflict
- `423`: Locked
- `500`: Internal Server Error

---

[API](https://skmtc.dev/pismo/apis/banking-transaction-banking.md) - [All operations](https://skmtc.dev/pismo/apis/banking-transaction-banking/llms.txt) - [OpenAPI document](https://skmtc.dev/pismo/apis/banking-transaction-banking/revisions/1334306c9303?raw)