Consultar a lista de favorecidos para Pix

POST

/api/Pix/ConsultarFavorecidoPix

Pix

Funcionalidade principal

O endpoint ConsultarFavorecidoPix recupera a lista de contatos (favorecidos) salvos por um cliente específico. Ele retorna todos os dados necessários para preencher uma ordem de pagamento, como o apelido, nome, CPF/CNPJ, banco e a chave Pix vinculada.

Casos de uso comuns

Carregamento da agenda: Exibição da lista de "Favoritos" ou "Contatos Salvos" na seção de transferências do aplicativo.

Autocompletar: Filtragem dinâmica de contatos conforme o usuário digita um nome ou CPF na tela de envio de Pix.

Gestão de favorecidos: Interface para o usuário conferir os dados salvos antes de decidir por uma exclusão ou edição.

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

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

{
    "Data": [
        {
            "IdFavorecido": 0,
            "ApelidoFavorecido": "string",
            "NomeRazaoSocial": "string",
            "CpfCnpj": "string",
            "Banco": 0,
            "Agencia": "string",
            "Conta": "string",
            "TipoPessoa": "string",
            "TipoConta": "string",
            "Tipokey": "string",
            "Key": "string"
        }
    ],
    "ResultCode": 0,
    "Message": "string",
    "ValidationData": {
        "ResultCode": 0,
        "Message": "string",
        "Errors": [
            {
                "ErrorMessage": "string",
                "FieldName": "string"
            }
        ]
    }
}

Modificado em 2026-03-03 15:14:35

Página anterior

Cadastrar novo favorecido para Pix

Próxima página

Remover favorecido para Pix

Consultar a lista de favorecidos para Pix

Funcionalidade principal#

Casos de uso comuns#

Requisição

Respostas

Funcionalidade principal

Casos de uso comuns