Skip to main content
POST
Para o passo a passo completo, veja o guia Lado do pagador.

Headers

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

Path params

string
required
Identificador da recorrência, o recurrence.id da leitura do QR Code.

Body

Copie os dados do objeto recurrence retornado na leitura do QR Code.
number
required
Jornada: 2 ou 4.
string
required
WEEKLY, MONTHLY, QUARTERLY, SEMIANNUAL ou ANNUAL.
string
Data inicial, YYYY-MM-DD.
string
Data final, YYYY-MM-DD.
number
Valor fixo da recorrência.
number
Piso do valor máximo definido pelo recebedor.
number
Valor máximo escolhido pelo pagador.
object
required
Recebedor: ispb, document e name.
object
Devedor: type, document e name. Ignorado se o documento for igual ao do pagador.
string
required
Identificador do contrato.
string
Descrição do contrato.
string
Data e hora da liquidação do pagamento, quando a autorização vem depois de um pagamento (jornada 4).

Response

string
Identificador da recorrência.
string
Data e hora do pedido, em UTC, sem Z.