Criar recorrência

Cria uma recorrência Pix Automático (jornada de autorização sem pagamento imediato).

A resposta traz a recorrência com status SENT (enviada ao banco do pagador). Quando o
pagador decide, o status muda para APPROVED, REJECTED, CANCELLED_* ou EXPIRED, e
você recebe o webhook pix_automatic.recurrence_* no domínio pix-automatic
(PUT /v1/banking/webhooks/pix-automatic) — não é preciso consultar o GET. A partir da
aprovação as cobranças de cada ciclo são geradas e enviadas automaticamente pela Autra
(o integrador não precisa chamar POST /billings a cada mês), e cada desfecho chega como
pix_automatic.billing_completed, billing_failed ou billing_canceled.

Criação recusada fica com status FAILED.

Limites

  • documentNumber e documentDescription: até 35 caracteres cada (acento conta 1).
  • expirationDate (prazo para o pagador autorizar): até 30 dias.

Regras de data

  • startDate (obrigatório, YYYY-MM-DD) é a data da primeira cobrança e precisa ser
    pelo menos hoje + 2 dias. A primeira cobrança não é debitada na hora; para cobrar
    no ato da contratação use POST /v1/banking/pix/automatic/recurrences/immediate.
  • MONTHLY cobra todo mês no mesmo dia do startDate. Se o mês não tem esse dia
    (29, 30 ou 31), a cobrança vai para o último dia do mês (ex.: startDate dia 30 →
    30/11, 30/12, 30/01, 28/02). WEEKLY repete o dia da semana do startDate;
    ANNUAL, o mesmo dia e mês.
  • endDate (opcional) é a data limite: nenhuma cobrança é gerada depois dela. Use para
    limitar o número de parcelas (ex.: 5 parcelas mensais a partir de 28/10/2026 →
    endDate 2027-02-28).
  • Cada cobrança é enviada ao banco do pagador entre 10 e 2 dias antes do vencimento.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

CPF/CNPJ do recebedor (somente números)

string
enum
required
Allowed:
date
required

Data da primeira cobrança (mínimo hoje + 2 dias). Define o dia de cobrança dos ciclos seguintes.

date

Data limite da recorrência (opcional). Nenhuma cobrança é gerada depois dela.

date-time

Prazo para o pagador autorizar (opcional, RFC 3339).

number
required

Valor de cada cobrança (> 0)

string
string
length ≤ 35

Identificador do contrato no recebedor (opcional, até 35 caracteres; gerado quando omitido). Volta em operationData.documentNumber nos webhooks.

string
length ≤ 35

Descrição exibida ao pagador no app do banco (opcional, até 35 caracteres)

string

Política de nova tentativa (opcional; padrão RETRY_3RETRIES_7DAYS)

string
required

CPF/CNPJ do pagador (somente números)

string
required
string
required

ISPB do banco do pagador

string
required

Conta do pagador

string

Agência do pagador

string

E-mail do pagador para notificações (opcional)

string

Telefone do pagador para notificações (opcional)

boolean
integer

Avisar o pagador N dias antes do vencimento

boolean
boolean
integer
boolean
Responses

400

Parâmetros inválidos. Códigos: INVALID_JSON, MISSING_DOCUMENT_ID, MISSING_PERIODICITY,
MISSING_START_DATE, INVALID_AMOUNT, MISSING_PAYER_NATIONAL_REGISTRATION,
MISSING_PAYER_NAME, MISSING_PAYER_ISPB, INVALID_PAYER_ISPB (ISPB com 8 dígitos),
MISSING_PAYER_ACCOUNT_NUMBER, INVALID_DOCUMENT_NUMBER e INVALID_DOCUMENT_DESCRIPTION
(acima de 35 caracteres), INVALID_REQUEST; startDate antes de hoje + 2 dias também é recusado.

403

Token inválido

422

Recorrência recusada pelo processamento Pix (DOCK_REJECTED, com o código do motivo); a recorrência fica FAILED.

500

Erro interno ou na Autra

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json