---
title: "Cancelamento da recorrência"
method: POST
path: "/automatic/recurrencies/{recurrencyId}/cancel"
---

# Cancelamento da recorrência

`POST /automatic/recurrencies/{recurrencyId}/cancel`

## Request

- Base URL: `https://sandbox.openfinance.celcoin.dev/baas/v2`
- URL: `https://sandbox.openfinance.celcoin.dev/baas/v2/automatic/recurrencies/{recurrencyId}/cancel`
- Auth: OAuth 2

## Path parameters

- `recurrencyId` string, required

## Request body

- object
  - `cancellingReason` string, required: Motivo do cancelamento

## Response `200`

200

- object
  - `version` string
  - `status` integer
  - `body` object
    - `recurrencyId` string
    - `clientRequestId` string
    - `interval` object
      - `start` string
      - `end` unknown
      - `frequencyType` string
    - `status` string
    - `journeys` object[]
      - `status` string
      - `type` integer
      - `createDate` string
    - `amount` integer
    - `creditParty` object
      - `bank` string
      - `branch` string
      - `account` string
      - `taxId` string
      - `name` string
    - `debitParty` object
      - `bank` string
      - `personType` string
      - `taxId` string
      - `accountType` string
      - `branch` string
      - `account` string
      - `stateCode` string
    - `debtor` object
      - `personType` string
      - `taxId` string
      - `name` string
    - `contract` object
      - `number` string
      - `description` string
    - `allowsNewAttemptsAfterExpiration` boolean
    - `recurrencyMaxAmount` unknown
    - `createDate` string
    - `allowAutoSendingPaymentInstructions` boolean
    - `cancellation` object
      - `id` string
      - `cancelledBy` string
      - `taxId` integer
      - `reason` string
      - `date` string

## Other responses

- `400`: 400

---

[API](https://skmtc.dev/celcoin/apis/baas-v2.md) - [All operations](https://skmtc.dev/celcoin/apis/baas-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/celcoin/apis/baas-v2/revisions/98ec6869c1f2?raw)
