Listar recorrências cadastradas e/ou canceladas

POST

/api/PixAutomatico/Pagador/ListarRecorrencias

PixAutomatico

Funcionalidade principal

O endpoint Pagador/ListarRecorrencias recupera a lista de todos os consentimentos de recorrência (ativos, pendentes ou cancelados) vinculados ao CPF ou CNPJ do cliente. Ele é essencial para que o usuário possa gerenciar suas assinaturas e compromissos financeiros diretamente no aplicativo do banco.

Casos de uso comuns

Gestão de assinaturas: O usuário acessa a área "Pix Automático" do App para conferir quais serviços (Streaming, Academia, Energia) estão cadastrados.

Verificação de pendências: Consultar solicitações de empresas que ainda aguardam o aceite ou recusa do usuário (fluxo iniciado pelo recebedor).

Histórico de contratos: Visualizar recorrências que já foram encerradas ou canceladas para fins de conferência histórica.

Requisição

Authorization

Adicionar o parâmetro

Authorization

a Cabeçalhos, cujo valor é concatenar o Token após o Bearer.

Exemplo:

Authorization: Bearer ********************

Parâmetros Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200Correto

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api/PixAutomatico/Pagador/ListarRecorrencias' \
--header 'UserName;' \
--header 'RequestOrigin;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "Data": {
        "CodigoCliente": 0,
        "CodigoCanal": 0,
        "Status": "Todos"
    }
}'

Response Example

{
    "Data": {
        "Id": 0,
        "DataGravacao": "string",
        "TipoFrequencia": "string",
        "DataInicioRecorrencia": "string",
        "Valor": 0,
        "ValorPisoMaximo": 0,
        "RecebedorNome": "string",
        "RecebedorCnpj": "string",
        "DevedorNome": "string",
        "Status": "string",
        "DataProximoPagamento": "string",
        "DataUltimoPagamento": "string"
    },
    "ResultCode": 0,
    "Message": "string",
    "ValidationData": {
        "ResultCode": 0,
        "Message": "string",
        "Errors": [
            {
                "ErrorMessage": "string",
                "FieldName": "string"
            }
        ]
    }
}

Modificado em 2026-03-03 15:19:57

Página anterior

Atualizar status de uma recorrência

Próxima página

Consultar dados de uma recorrência

Listar recorrências cadastradas e/ou canceladas

Funcionalidade principal#

Casos de uso comuns#

Requisição

Respostas

Funcionalidade principal

Casos de uso comuns