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

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Path Parameters

idRec
string
required

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

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

Query Parameters

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}$

Response

OK

atualizacao
object[]
required
calendario
object
required
idRec
string
required

Identificador da recorrência.

Pattern: ^[a-zA-Z0-9]{29}$
politicaRetentativa
enum<string>
required
Available options:
NAO_PERMITE,
PERMITE_3R_7D
recebedor
object
required
status
enum<string>
required
Available options:
CRIADA,
APROVADA,
REJEITADA,
EXPIRADA,
CANCELADA
vinculo
object
required
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