---
title: "GeneratePixAutomatic"
method: POST
path: "/GeneratePixAutomatic"
tags: ["Automatic Pix"]
---

# GeneratePixAutomatic

`POST /GeneratePixAutomatic`

This method can be used to initiate a Pix Automatic recurrence agreement (Jornada 1).

## Request body

- JsonGeneratePixAutomatic
  - `Method` string, required — Status da autorização da recorrência. **Obrigatório**. Erro: ISE0056 - Method não informado.
  - `PartnerId` integer, required — Identificador do parceiro integrador. **Obrigatório**. Erro: ISE0057 - PartnerId não informado.
  - `BusinessUnitId` integer, required — Identificador da unidade de negócio. **Obrigatório**. Erro: ISE0058 - BusinessUnitId não informado.
  - `Identifier` string, required — Identificador.
  - `Retry` boolean — Indica se deve tentar novamente em caso de falha. **Obrigatório**.
  - `Values` object, required
    - `FinalValue` string — Valor final da recorrência.
    - `MinimumValue` string — Valor máximo permitido.
  - `Receiver` object, required
    - `TaxNumber` string, required — CPF/CNPJ do pagador. **Obrigatório**. Erro: ISE0118 - É necessário informar o CPF/CNPJ.
    - `Name` string, required — Nome do pagador. **Obrigatório**. Erro: EXC0007 - É necessário informar a propriedade Name.
    - `ISPB` string — Código ISPB do recebedor. Apenas um dos campos é obrigatório, ISPB ou Banco.
    - `Bank` string, required — Código do banco do recebedor. Apenas um dos campos é obrigatório, ISPB ou Banco.
    - `BankBranch` string, required — Agência do banco do recebedor. **Obrigatório**. Erro: EXC0010 - É necessário informar a propriedade BankBranch.
    - `BankAccount` string, required — Conta do banco do recebedor. **Obrigatório**. Erro: EXC0019 - É necessário informar a propriedade BankAccount.
    - `BankAccountDigit` string, required — Dígito da conta do recebedor. **Obrigatório**. Erro: EXC0011 - É necessário informar a propriedade BankAccountDigit.
  - `Payer` object, required
    - `TaxNumber` string, required — CPF/CNPJ do pagador. **Obrigatório**. Erro: ISE0118 - É necessário informar o CPF/CNPJ.
    - `Name` string, required — Nome do pagador. **Obrigatório**.
    - `ISPB` string — Código ISPB do pagador.
    - `Bank` string — Código do banco do pagador.
    - `BankBranch` string — Agência do banco do pagador.
    - `BankAccount` string — Conta do banco do pagador.
    - `BankAccountDigit` string — Dígito da conta do pagador.
  - `Contract` object, required
    - `Identifier` string, required — Identificador do contrato. **Obrigatório**.
    - `Description` string — Descrição do contrato.
  - `Date` object, required
    - `Frequency` 'Weekly = 0' | 'Monthly = 1' | 'Quarterly = 2' | 'Semiannual = 3' | 'Annual = 4', required — Nova frequência da recorrência.
    - `InitialDate` string, date, required — Data inicial da recorrência. **Obrigatório**.
    - `EndDate` string, date — Data final da recorrência.
  - `SearchProtocol` integer, nullable — Protocolo único gerado após consulta de uma chave PIX. Exemplo: 5489665

## Response `200`

Recorrência Pix criada com sucesso

- GeneratePixAutomaticResponse
  - `Success` 'true' | 'false', required — Indica se a operação foi realizada com sucesso.
  - `Message` string, required — Mensagem de retorno da operação.
  - `RecurrenceId` string, nullable, required — Identificador da recorrência criada.

## Other responses

- `400` — Erro de validação

---

[API](https://skmtc.net/fitbank/apis/onboarding.md) · [All operations](https://skmtc.net/fitbank/apis/onboarding/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/fitbank/onboarding/revisions/f94d262a8f58/schema)