---
title: "Crie uma recorrência com jornada 1"
method: POST
path: "/automatic/recurrencies/journey1"
---

# Crie uma recorrência com jornada 1

`POST /automatic/recurrencies/journey1`

## Request

- Base URL: `https://sandbox.openfinance.celcoin.dev/baas/v2`
- URL: `https://sandbox.openfinance.celcoin.dev/baas/v2/automatic/recurrencies/journey1`
- Auth: OAuth 2

## Request body

- object
  - `recurrencyId` string, required: Identificador único da recorrência
  - `recurrency` object, required
    - `clientRequestId` string, required: Um identificador único para este registro de recorrência
    - `amount` number, double: O valor do pagamento para cada ocorrência da recorrência.
    - `recurrencyMinAmount` number, double: O valor mínimo do débito recorrente. Obrigatório quando recorrência de valor variável. Se preencher este campo, não deverá ser preenchido o campo Amount.
    - `interval` object: Objeto com a periodicidade e o período da recorrência.
      - `start` string, required: A data início da recorrência.
      - `end` string, required: A data término da recorrência
      - `frequencyType` 'WEEKLY' | 'MONTHLY' | 'QUARTER' | 'SEMESTER' | 'YEARLY', required: Frequência da cobrança
    - `creditParty` object: O objeto que representa o beneficiário do pagamento (quem recebe).
      - `branch` string, required: agência bancária do beneficiário
      - `account` string, required: conta bancária do beneficiário
      - `taxId` string, required: O CPF/CNPJ do beneficiário.
      - `name` string, required: A razão social do beneficiário .
    - `debtor` object: O objeto que representa o devedor do pagamento.
      - `personType` string, required: O tipo de pessoa do devedor (LEGAL_PERSON,NATURAL_PERSON).
      - `taxId` string, required: O CPF ou CNPJ
      - `name` string, required: O nome completo do devedor
    - `contract` object: Detalhes sobre o contrato associado à recorrência.
      - `number` string, required: Número do contrato.
      - `description` string, required: Descrição do produto contratado.
    - `allowsNewAttemptsAfterExpiration` boolean: Indica se o sistema pode fazer novas tentativas de cobrança
    - `allowAutoSendingPaymentInstructions` boolean: Determina se as instruções de pagamento devem ser enviadas automaticamente para processamento.
    - `debitParty` object: O objeto que representa a origem do pagamento (de onde o dinheiro será debitado).
      - `personType` 'LEGAL_PERSON' | 'PERSONAL_PERSON', required: O tipo de pessoa da parte pagadora (pessoa física ou jurídica)
      - `taxId` string, required: O CPF/CNPJ da parte pagadora.
      - `bank` string, required: ISPB do banco da conta de onde o pagamento será debitado.
      - `branch` string, required: agência bancária do pagador
      - `account` string, required: O número da conta da parte pagadora.
    - `changeToNextWorkingDay` boolean: Indica caso um agendamento cair no final de semana, será adiado para o próximo dia útil.

## Response `200`

200

- object
  - `status` integer
  - `version` string
  - `body` object
    - `recurrencyId` string
    - `clientRequestId` string
    - `interval` object
      - `start` string
      - `end` string
      - `frequencyType` string
    - `status` string
    - `journeys` object[]
      - `status` string
      - `type` integer
      - `createDate` string
    - `amount` integer
    - `recurrencyMinAmount` integer
    - `creditParty` object
      - `bank` string
      - `taxId` string
      - `name` string
      - `branch` string
      - `account` string
    - `debitParty` object
      - `personType` string
      - `taxId` string
      - `bank` string
      - `account` string
      - `branch` string
    - `debtor` object
      - `personType` string
      - `taxId` string
      - `name` string
    - `contract` object
      - `number` string
      - `description` string
    - `cancellation` object
      - `id` string
      - `personType` string
      - `taxId` string
      - `reason` string
      - `date` string
    - `createDate` string
    - `acceptanceDate` string
    - `denyDate` string
    - `updateDate` 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)