---
title: "Cancel payment order"
method: POST
path: "/inst-pull-pay/v1/pix/automatic/payment/order/cancel"
tags: ["Automatic Pix"]
---

# Cancel payment order

`POST /inst-pull-pay/v1/pix/automatic/payment/order/cancel`

Cancel the payment order in the provider.

## Headers

- `Authorization` string, required
- `Idempotency-Key` string, required
- `x-account-id` integer, required

## Request body

- CancelPaymentOrderRequest — Cancel payment order request
  - `end_to_end_id` string, required — This field is a Brazil Central Bank (BCB) requirement to track all steps of Pix transactions. Basically, there are two steps to a Pix transaction: 1. Initialize a transaction 2. Confirm a transaction The `end_to_end_id` is sent to the BCB in both steps in order to identify all transaction information.
  - `reason` 'ACCT' | 'BLCK' | 'CCLD' | 'FAIL' | 'OTHR' | 'SLBD' | 'SLCR', required — Payment order cancellation reason: * `ACCT` - Paying or receiving user's transactional account closed * `BLCK` - Paying or receiving user's transactional account blocked * `CCLD` - Recurring payments authorization cancelled * `FAIL` - Settlement process failure or error * `OTHR` - Paying or receiving user requested cancellation for other reasons * `SLBD` - Paying user request * `SLCR` - Receiving user request

## Response `200`

OK

- CancelPaymentOrderResponse — Cancel payment order request
  - `end_to_end_id` string, required — This field is a Brazil Central Bank (BCB) requirement to track all steps of Pix transactions. Basically, there are two steps to a Pix transaction: 1. Initialize a transaction 2. Confirm a transaction The `end_to_end_id` is sent to the BCB in both steps in order to identify all transaction information.
  - `reason` 'ACCT' | 'BLCK' | 'CCLD' | 'FAIL' | 'OTHR' | 'SLBD' | 'SLCR', required — Payment order cancellation reason: * `ACCT` - Paying or receiving user's transactional account closed * `BLCK` - Paying or receiving user's transactional account blocked * `CCLD` - Recurring payments authorization cancelled * `FAIL` - Settlement process failure or error * `OTHR` - Paying or receiving user requested cancellation for other reasons * `SLBD` - Paying user request * `SLCR` - Receiving user request
  - `cancelled_at` string, required — Cancellation date time, RFC 3339 format: YYYY-MM-DDThh:mm:ssZ.

## Other responses

- `400` — Bad request
- `401` — Access token is missing or invalid
- `404` — Not Found
- `500` — Internal server error

---

[API](https://skmtc.dev/pismo/apis/platform-authentication.md) · [All operations](https://skmtc.dev/pismo/apis/platform-authentication/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/pismo/platform-authentication/revisions/935b62e16de4/schema)