Listar contratos de Pix Automático

POST

/api/PixAutomatico/Recebedor/ListarRecorrencias

PixAutomatico

Funcionalidade principal

O endpoint Recebedor/ListarRecorrencias permite que a empresa (recebedor) consulte e liste todas as solicitações de recorrência enviadas. Ele funciona como um painel de controle para verificar quais clientes aceitaram a adesão, quais estão pendentes e quais cancelaram o vínculo de débito automático.

Casos de uso comuns

Dashboard de conversão: O sistema da empresa consulta a API para gerar relatórios de quantas novas assinaturas foram convertidas via Pix Automático no dia.

Sincronização de status: Verificação de recorrências que foram canceladas pelo pagador diretamente no banco dele, permitindo que a empresa suspenda o serviço imediatamente.

Auditoria de cobrança: Localizar o ID de uma recorrência específica antes de realizar um agendamento de valor variável.

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/Recebedor/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",
        "TipoRecorrencia": "string",
        "TipoFrequencia": "string",
        "DataInicioRecorrencia": "string",
        "HoraInicioRecorrencia": "string",
        "DataFimRecorrencia": "string",
        "HoraFimRecorrencia": "string",
        "Valor": 0,
        "RecebedorNome": "string",
        "DevedorNome": "string",
        "NumeroContrato": "string",
        "DescricaoContrato": "string",
        "DataCriacaoConfirmacao": "string",
        "HoraCriacaoConfirmacao": "string",
        "DataCriacaoRecorrencia": "string",
        "HoraCriacaoRecorrencia": "string",
        "DataExpiracaoConfirmacao": "string",
        "HoraExpiracaoConfirmacao": "string",
        "Status": "string"
    },
    "ResultCode": 0,
    "Message": "string",
    "ValidationData": {
        "ResultCode": 0,
        "Message": "string",
        "Errors": [
            {
                "ErrorMessage": "string",
                "FieldName": "string"
            }
        ]
    }
}

Modificado em 2026-03-03 15:16:00

Página anterior

Propor adesão ao Pix Automático (Push)

Próxima página

Lançar parcela de Pix Automático

Listar contratos de Pix Automático

Funcionalidade principal#

Casos de uso comuns#

Requisição

Respostas

Funcionalidade principal

Casos de uso comuns