Cadastrar novo favorecido para Pix

POST

/api/Pix/CadastrarFavorecidoPix

Pix

Funcionalidade principal

O endpoint CadastrarFavorecidoPix armazena os dados de um recebedor (nome, chave Pix e/ou dados bancários) na "agenda" do cliente. Ao salvar um favorecido, o sistema associa um apelido amigável aos dados técnicos, permitindo que o usuário localize o contato pelo nome em transações posteriores.

Casos de uso comuns

Agenda de contatos: Salvar familiares, amigos ou prestadores de serviços recorrentes (como diaristas ou terapeutas).

Gestão B2B: Empresas que salvam os dados de fornecedores frequentes para pagamentos rápidos.

Redução de erros: Garantir que o valor seja enviado para a conta correta, uma vez que os dados já foram validados e salvos anteriormente.

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/CadastrarFavorecidoPix' \
--header 'UserName;' \
--header 'RequestOrigin;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "Data": {
        "CodigoCanal": 0,
        "CodigoCliente": 0,
        "Apelido": "string",
        "CpfCnpjFavorecido": "string",
        "CodigoBanco": "string",
        "Agencia": "string",
        "Conta": "string",
        "TipoConta": "CACC",
        "NomeRazaoSocial": "string",
        "Tipokey": "CPF",
        "Key": "string"
    }
}'

Response Example

{
    "Data": {},
    "ResultCode": 0,
    "Message": "string",
    "ValidationData": {
        "ResultCode": 0,
        "Message": "string",
        "Errors": [
            {
                "ErrorMessage": "string",
                "FieldName": "string"
            }
        ]
    }
}

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

Página anterior

Cadastrar agendamento de um Pix

Próxima página

Consultar a lista de favorecidos para Pix

Cadastrar novo favorecido para Pix

Funcionalidade principal#

Casos de uso comuns#

Requisição

Respostas

Funcionalidade principal

Casos de uso comuns