Criar cobrança recorrente.

Endpoint para criar uma cobrança recorrente, neste caso, o txid deve ser definido pelo PSP.

Body Params

Dados para geração da cobrança recorrente.

Dados enviados para criação da cobrança recorrente via API Pix

string
required
length between 29 and 29
[a-zA-Z0-9]{29}

Identificador da Recorrência

Regra de formação:

  • RAxxxxxxxxyyyyMMddkkkkkkkkkkk (29 caracteres; "case sensitive", isso é, diferencia letras maiúsculas e minúsculas), sendo:
    • "R": fixo (1 caractere). "R" para a recorrência criada dentro do Pix;
    • "A": identificação da possibilidade de novas tentativas, sendo possíveis os valores "R" ou "N" (1 caractere). "R" caso a recorrência permita novas tentativas de pagamento pós vencimento, ou "N" caso não permita novas tentativas.
    • "xxxxxxxx": identificação do agente que presta serviço para o usuário recebedor que gerou o
    • "yyyyMMdd": data (8 caracteres) de criação da recorrência;
    • "kkkkkkkkkkk": sequencial criado pelo agente que gerou o

Dessa forma, o ID da recorrência deve ser formado de acordo com um dos tipos a seguir:

  • "RRxxxxxxxxyyyyMMddkkkkkkkkkkk"; para recorrência criada dentro do Pix e que permite novas tentativas de pagamento pós vencimento; ou
  • "RNxxxxxxxxyyyyMMddkkkkkkkkkkk"; para recorrência criada dentro do Pix e que não permite novas tentativas de pagamento pós vencimento.
string
length ≤ 140

Informações adicionais da fatura.

calendario
object
required
valor
object
required

Valor da cobrança recorrente

boolean
required
Defaults to true

Campo de ativação do ajuste da data de vencimento para próximo dia útil caso o vencimento corrente seja um dia não útil. O PSP Pagador deverá considerar os feriados locais com base no código município do usuário pagador.

recebedor
object
required

O objeto recebedor organiza as informações sobre o recebedor da cobrança.

devedor
object

O objeto devedor organiza as informações sobre o devedor da recorrência.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

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