Consultar dados de uma recorrência

POST

/api/PixAutomatico/Pagador/ConsultarRecorrencia

PixAutomatico

Funcionalidade principal

O endpoint Pagador/ConsultarRecorrencia recupera informações minuciosas de um consentimento de recorrência, como o histórico de pagamentos (último e próximo), dados do recebedor e as regras de periodicidade estabelecidas. Ele é essencial para garantir que o pagador tenha controle total sobre os limites e condições da cobrança.

Casos de uso comuns

Tela de detalhes da assinatura: Quando o usuário clica em um item da lista de recorrências para ver o "contrato" completo.

Validação de limites: Conferir se o valor máximo (teto) definido para aquela recorrência ainda é adequado às necessidades do usuário.

Verificação de próximo débito: Confirmar a data exata em que o sistema realizará a próxima tentativa de cobrança automática.

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/ConsultarRecorrencia' \
--header 'UserName;' \
--header 'RequestOrigin;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "Data": {
        "CodigoCliente": 0,
        "CodigoCanal": 0,
        "IdRecorrencia": 0
    }
}'

Response Example

{
    "Data": {
        "Id": 0,
        "DataGravacao": "string",
        "TipoRecorrencia": "string",
        "TipoFrequencia": "string",
        "DataInicioRecorrencia": "string",
        "DataFimRecorrencia": "string",
        "Valor": 0,
        "RecebedorNome": "string",
        "RecebedorInstituicao": "string",
        "RecebedorCnpj": "string",
        "DevedorNome": "string",
        "DevedorCpfCnpj": "string",
        "NumeroContrato": "string",
        "DescricaoContrato": "string",
        "DataCriacaoConfirmacao": "string",
        "HoraCriacaoConfirmacao": "string",
        "DataCriacaoRecorrencia": "string",
        "HoraCriacaoRecorrencia": "string",
        "DataExpiracaoConfirmacao": "string",
        "HoraExpiracaoConfirmacao": "string",
        "DataProximoPagamento": "string",
        "DataUltimoPagamento": "string",
        "Status": "string"
    },
    "ResultCode": 0,
    "Message": "string",
    "ValidationData": {
        "ResultCode": 0,
        "Message": "string",
        "Errors": [
            {
                "ErrorMessage": "string",
                "FieldName": "string"
            }
        ]
    }
}

Modificado em 2026-03-03 15:20:26

Página anterior

Listar recorrências cadastradas e/ou canceladas

Próxima página

Editar uma recorrência cadastrada

Consultar dados de uma recorrência

Funcionalidade principal#

Casos de uso comuns#

Requisição

Respostas

Funcionalidade principal

Casos de uso comuns