Contrapartes
Guia para Gerenciamento de Contrapartes no Aurix Pay
Este guia explica como visualizar, cadastrar e gerenciar contrapartes (clientes, fornecedores ou parceiros) e suas contas bancárias no sistema AurixPay, utilizando linguagem clara e não técnica.
1. Visualizar uma Contraparte Existente
Objetivo: Obter informações detalhadas sobre uma contraparte já cadastrada.
Como fazer:
Você precisará do ID único da contraparte (exemplo:
5d2811d0-c016-4bc9-bc53-848b1d0bc0c6).O sistema retornará:
Nome da contraparte.
CPF/CNPJ (sem pontuação).
Datas de criação e atualização.
Possíveis erros:
Acesso negado: Verifique sua chave de autenticação.
Contraparte não encontrada: Confira o ID informado.
2. Cadastrar ou Buscar uma Contraparte
Objetivo: Cadastrar uma nova contraparte ou localizar uma existente usando nome e CPF/CNPJ.
Como fazer:
Envie o nome e o CPF/CNPJ (sem pontuação).
Se a contraparte já existir, o sistema retornará os dados atuais.
Caso contrário, ela será cadastrada automaticamente.
Dados retornados:
ID único, nome, CPF/CNPJ e datas de registro.
Possíveis erros:
CPF/CNPJ inválido: Verifique o número digitado.
Permissão negada: Sua chave de API pode estar incorreta.
3. Atualizar o Limite Financeiro de uma Contraparte
Objetivo: Definir um valor máximo que a contraparte pode transacionar em uma conta específica.
Como fazer:
Informe:
ID da conta bancária vinculada à contraparte.
Tipo de documento (CPF ou CNPJ).
Valor máximo permitido (em centavos; ex: R$ 1.000,00 =
100000).
Possíveis erros:
Conta bancária não encontrada: Verifique o ID da conta.
Valor inválido: O limite deve ser um número positivo.
4. Cadastrar uma Conta Bancária para uma Contraparte
Objetivo: Vincular uma nova conta bancária a uma contraparte existente.
Como fazer:
Informe:
Agência (sem dígito, ex:
0001).Dígito da agência (opcional).
Número da conta (sem hífens).
Tipo de conta (
checkingpara corrente ousavingspara poupança).Código ISPB do banco (8 dígitos, disponível no site do Banco Central).
Nome do banco.
Dados retornados:
ID da conta, dados bancários e vínculo com a contraparte.
Possíveis erros:
Dados incompletos: Preencha todos os campos obrigatórios.
Contraparte não existe: Confira o ID fornecido.
5. Visualizar Todas as Contas Bancárias de uma Contraparte
Objetivo: Listar todas as contas bancárias registradas para uma contraparte.
Como fazer:
Informe o ID da contraparte.
O sistema retornará uma lista com:
Agência e número da conta.
Tipo de conta (corrente/poupança).
Dados do banco (nome e código ISPB).
Possíveis erros:
Nenhuma conta cadastrada: A contraparte ainda não tem contas vinculadas.
ID inválido: Verifique o código da contraparte.
6. Visualizar uma Conta Bancária Específica
Objetivo: Verificar informações detalhadas de uma conta bancária específica vinculada a uma contraparte.
Como fazer:
Informe o ID da contraparte e o ID da conta bancária.
O sistema retornará:
Número da agência e conta.
Tipo de conta.
Dados do banco (código ISPB e nome).
Possíveis erros:
Conta não encontrada: Verifique os IDs fornecidos.
Acesso negado: Sua chave de API pode estar incorreta.
Resumo das Operações
Visualizar contraparte
Verificar dados de um cliente/fornecedor.
Cadastrar/Buscar contraparte
Evitar cadastros duplicados.
Atualizar limite financeiro
Controlar valores máximos de transação.
Cadastrar conta bancária
Vincular uma nova conta a uma contraparte.
Listar contas bancárias
Ver todas as contas de uma contraparte.
Visualizar conta específica
Validar dados antes de uma transferência.
Dicas Importantes
✅ CPF/CNPJ: Sempre envie sem pontuação.
✅ Valores monetários: Use centavos (ex: R$ 100,00 = 10000).
✅ Código ISPB: Consulte no site do Banco Central.
Em caso de dúvidas, entre em contato com o suporte.
Last updated