Skip to main content
GET
Retrieve recurrence (Pix Automático)

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

idRec
string
obrigatório

Identificador da recorrência [a-zA-Z0-9]{29}.

Pattern: ^[a-zA-Z0-9]{29}$

Parâmetros de consulta

txid
string

txid de uma cobrança a compor com a recorrência (JORNADA_3/4). NÃO SERVIDO nesta superfície: informar txid resulta em 422.

Pattern: ^[a-zA-Z0-9]{26,35}$

Resposta

OK

atualizacao
object[]
obrigatório
calendario
object
obrigatório
idRec
string
obrigatório

Identificador da recorrência.

Pattern: ^[a-zA-Z0-9]{29}$
politicaRetentativa
enum<string>
obrigatório
Opções disponíveis:
NAO_PERMITE,
PERMITE_3R_7D
recebedor
object
obrigatório
status
enum<string>
obrigatório
Opções disponíveis:
CRIADA,
APROVADA,
REJEITADA,
EXPIRADA,
CANCELADA
vinculo
object
obrigatório
atestacaoTitularidade
object
ativacao
object
dadosQR
object

QR Composto da recorrência (Pix Automático). Ausente em duas situações: enquanto a recorrência não tem locrec vinculada, e enquanto a instituição não tiver registrado, para o CNPJ do recebedor desta recorrência, um único perfil de recebedor, de onde sai a cidade obrigatória do BR Code (tag 60). Uma recorrência tem conta e CNPJ, não chave Pix, e nada no fluxo de recorrência cria esse registro: sem ele, ou com mais de um perfil para o mesmo CNPJ, o QR é OMITIDO em vez de sair com uma cidade inventada. Registrar um perfil de recebedor com o CNPJ correspondente é o que passa a servir o QR.

encerramento
object
loc
object
pagador
object

Dados do usuário pagador informados pelo PSP pagador na confirmação da recorrência.

solicitacao
object[]
valor
object