Skip to main content
POST
Para o passo a passo completo, veja o guia Jornada 1: solicitação no app.

Headers

string
required
Sua API key, sem o prefixo Bearer.
string
required
Chave de idempotência. Use um valor novo a cada solicitação.

Body

string
Identificador da recorrência, 29 caracteres. Gerado pela API se omitido, com prefixo RR.
string
required
WEEKLY, MONTHLY, QUARTERLY, SEMIANNUAL ou ANNUAL. Se omitido, a API assume WEEKLY.
string
required
Data da primeira cobrança, YYYY-MM-DD.
string
Data final, YYYY-MM-DD.
number
Valor fixo de cada cobrança. Necessário para as cobranças automáticas.
number
Piso do valor máximo do pagador, para valor variável.
object
required
Dados da sua empresa. Sobrescritos com os dados da conta autenticada.
object
required
Dados bancários do pagador.
object
Devedor, se for diferente do pagador: type (NATURAL ou LEGAL), document e name.
string
required
Identificador do contrato, exibido ao pagador.
string
Descrição exibida ao pagador.
string
required
Data e hora de expiração da solicitação, em UTC (ISO 8601). No máximo 30 dias após o envio.

Response

string
Identificador da recorrência.
string
Data e hora do pedido, em UTC, no formato yyyy-MM-ddTHH:mm:ss.fff (sem Z).