---
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`

## Request

- Base URL: `https://sandbox-cdn.pismolabs.io`
- URL: `https://sandbox-cdn.pismolabs.io/inst-pull-pay/v1/pix/automatic/payment/order/cancel`
- Auth: none declared. Required headers: `Authorization`, `Idempotency-Key`, `x-account`

Cancel the payment order in the provider.

## Headers

- `Authorization` string, required
- `Idempotency-Key` string, required
- `x-account` 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. <br /> Basically, there are two steps to a Pix transaction: <br /> 1. Initialize a transaction <br /> 2. Confirm a transaction <br /> The `end_to_end_id` is sent to the BCB in both steps in order to identify all transaction information. <br />
  - `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. <br /> Basically, there are two steps to a Pix transaction: <br /> 1. Initialize a transaction <br /> 2. Confirm a transaction <br /> The `end_to_end_id` is sent to the BCB in both steps in order to identify all transaction information. <br />
  - `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`: Unauthorized. Missing or invalid authentication token.
- `404`: Not found
- `500`: Internal Server Error

---

[API](https://skmtc.dev/pismo/apis/instant-payments-automatic-pix.md) - [All operations](https://skmtc.dev/pismo/apis/instant-payments-automatic-pix/llms.txt) - [OpenAPI document](https://skmtc.dev/pismo/apis/instant-payments-automatic-pix/revisions/88d97a2eb4f6?raw)