Consultar listas de recorrência

Retorna todos os contratos de recorrência de forma paginada a partir das informações do pagador.

Ambiente	Método	Endpoint
Sandbox	GET	`https://api2.cielo.com.br/sandbox/cielo-pix/v1/rec`
Produção	GET	`https://api-mtls.cielo.com.br/cielo-pix/v1/rec`

AS periodicidades possíveis são:

Semanal;
Mensal;
Trimestral;
Semestral;
Anual.

Política de retentativa

Política	Definição
NÃO_PERMITE	Não será autorizado retentativas após o vencimento
PERMITE_3R_7D	Será permitida até 3 tentativas após o vencimento dentro de 7 dias corridos

Status de recorrência

Status	Definição
CRIADA	Recorrência criada pelo usuário recebedor
ENVIADA	Recorrência enviada ao PSP do pagador
RECEBIDA	Recorrência recebida pelo PSP do pagador
REJEITADA	Recorrência rejeitada pelo usuário pagador, apenas para a jornada 1, via notificação
ACEITA	Recorrência aceita pelo usuário pagador
EXPIRADA	Data da vigência da recorrência já expirada
CANCELADA	Recorrência cancelada pelo usuário pagador ou recebedor

Tipo de jornada

tipoJornada	Definição
JORNADA_1	Usuário pagador aceitou a recorrência através de notificação externa ao ecossistema
JORNADA_2	Usuário pagador aceitou a recorrência através de leitura de QR Code de recorrência
JORNADA_3	Usuário pagador iniciou a recorrência através de leitura de QR Code composto e pagamento de cobrança imediata. O uso desta jornada torna obrigatório o preenchimento de `dadosJornada.txid`
AGUARDANDO_DEFINICAO	Valor inicial posterior à criação e anterior à ativação da recorrência

Os possíveis solicitantes de cancelamento da cobrança recorrente são:

PSP_PAGADOR
USUARIO_PAGADOR
PSP_RECEBEDOR
USUARIO_RECEBEDOR

Códigos de cancelamento

Código	Descrição
ACCL	Fechamento de conta. Utilizado para transações relacionadas ao encerramento de uma conta bancária.
CPCL	Encerramento da empresa.
DCSD	Cancelamento por motivo de falecimento
FRUD	Utilizado para transações que foram identificadas como fraudulentas
SLCR	Solicitado pelo usuário pagador
SLDB	Solicitado pelo usuário recebedor