Criar recorrência

Cria uma nova recorrência Pix Automático.

A recorrência ficará em status PENDING até que o pagador autorize via app do banco.
Após autorização pelo banco, o status muda para ACCEPTED (via webhook) e cobranças passam a ser geradas automaticamente pelo Billing Engine.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
number
required

Valor da cobrança (> 0)

string

Moeda (padrão BRL)

string
required

Periodicidade: DAILY, WEEKLY, MONTHLY, BIMONTHLY, QUARTERLY, BIANNUAL, ANNUAL

date
required

Data do primeiro débito (YYYY-MM-DD)

date

Data de expiração da recorrência (opcional)

string

Comportamento quando a data de vencimento cai em dia não útil

string
required

Nome completo do pagador

string
required

CPF ou CNPJ do pagador (somente números)

string

Descrição exibida ao pagador no app do banco

Responses

400

Parâmetros inválidos

403

Token inválido

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