Braintree
Nesta página
Braintree é um conector de autoatendimento baseado em três valores: um ID de comerciante, uma chave pública e uma chave privada. O que decide se a conexão é boa é a função de acesso limitado que você atribui ao usuário da API – se errar, domínios inteiros chegarão vazios sem erros.
O que você ganha#
Transações com dados de pagamento mascarados, registros de cobrança recorrente e assinatura, disputas, registros de clientes e métodos de pagamento, verificações e dados de extratos e relatórios. As definições em nível de campo residem em Dicionário de dados Athia.
Mais forte para assinaturas. Braintree carrega detalhes de faturamento recorrente que a maioria dos conectores de cartão não tem, o que o torna a fonte de referência para o sucesso da renovação e para a rotatividade involuntária de refaturas malsucedidas.
Mais fraco onde as permissões são restritas. A cobertura é uma função direta da função que você concede; disputas e clientes são os domínios que mais frequentemente desaparecem.
Antes de começar#
No console Braintree, crie um função de acesso limitado para Athia e atribuí-lo ao usuário da API. A função precisa de:
- Transações: Baixar transações com dados de pagamento mascarados
- Relatórios: Criar, executar e baixar relatórios; Ver gráficos do painel
- Faturamento recorrente: Baixar registros de assinatura, visualizar modificações, visualizar planos de assinatura, visualizar assinaturas, pesquisar assinaturas
- Gestão de disputas: Visualize, gerencie e conteste disputas
- Webhooks: Gerenciar Webhooks (Adicionar/Editar/Excluir)
- Declarações: Ver declarações
- Acesso somente leitura: Ver endereço, ver clientes, ver contas de comerciante, ver métodos de pagamento, ver transações, ver verificações, baixar arquivos
- Pesquisar: Transações de pesquisa, verificações de pesquisa
Ver endereço e Ver clientes são os dois mais frequentemente deixados de lado. Sem eles, as tabelas de endereços e clientes são sincronizadas vazias e nenhum erro é gerado.
Em seguida, atribua o usuário da API a tudo contas de comerciante – o Braintree define o acesso por conta de comerciante, portanto, uma conta deixada de lado não contribui em nada.
Crie o usuário e as chaves da API#
- Faça login no painel de controle do Braintree como administrador e crie a função acima.
- Crie um novo usuário e habilite Acesso à API para esse usuário.
- Atribua a função de acesso limitado que você criou.
- Selecione todas as contas de comerciante.
- Saia e faça login novamente como o novo usuário, em seguida, gere e copie o Merchant ID, Chave Pública e Chave privada.
Credenciais que Athia pede#
| Campo | Obrigatório | O que é / onde encontrar |
|---|---|---|
| Nome | Sim | Sua etiqueta para esta conexão – identifique o comerciante Braintree |
| Cronograma | Não | Com que frequência Athia pesquisa Braintree |
| ID do comerciante | Sim | O ID do comerciante Braintree que esta conexão cobre |
| Chave Pública | Sim | Emitido com o usuário da API — consulte a documentação do Braintree para saber onde ele é encontrado |
| Chave privada | Sim | A chave privada correspondente para esse usuário da API |
Configurando a conexão#
- Crie a função, atribua-a ao usuário da API e atribua esse usuário a cada conta de comerciante.
- Em Configurações → Conexões, escolha + Adicionar conexão e selecione Braintree.
- Ativado Configurar conector, insira um Nome e escolha um Cronograma.
- Ativado Insira as credenciais, insira o ID do comerciante, Chave Pública e Chave privada.
- Escolha Verifique a conexão.
A conexão então aparece como ACTIVE e a primeira sincronização começa. Verifique se as disputas e os clientes estão realmente preenchidos – essa é a confirmação mais rápida de que a função está correta.
Registre o webhook Athia no Braintree#
Braintree envia atualizações de transações, assinaturas e disputas para Athia em tempo real assim que o destino é registrado.
- No assistente de conexão, copie o URL de destino do Webhook de Athia.
- Faça login no painel de controle do Braintree como usuário de acesso limitado e crie um webhook.
- Cole o URL do Athia em URL de destino.
- Abaixo Notificações, habilitar tudo opções de eventos de notificação.
- Teste e salve e ative o webhook.
Cadência de sincronização#
Escolha um Cronograma isso corresponde ao quão próximo você monitora a aceitação. Os registros de assinatura e disputa avançam nos ciclos de cobrança e disputa do próprio Braintree, independentemente da sua escolha.
Limites e coisas para saber#
- Permissões ausentes produzem domínios vazios, não erros. Sem direitos de leitura, as disputas e a sincronização dos clientes ficam vazias enquanto a verificação ainda é bem-sucedida.
- A cobertura segue a atribuição da conta do comerciante. As contas às quais o usuário da API não está atribuído estão ausentes.
- Produção e Sandbox são conexões separadas. Cada ambiente emite seu próprio ID de comerciante e par de chaves. Crie uma conexão por ambiente e nunca misture credenciais entre eles.
- Campos de liquidação e desembolso têm atraso de até dois dias por trás da transação. Leia os números de liquidação nos dias vencidos, não nos dias de hoje.
- Os valores são decimais - nunca divida por 100.
- Os dados do cartão são minimizados. A função acima concede apenas dados de pagamento mascarados.
Solução de problemas#
| O que você vê | Causa provável | O que fazer |
|---|---|---|
| Disputas ou clientes vazios após uma sincronização | Função ausente de gerenciamento de disputas ou direitos somente leitura | Adicione as permissões e reconecte |
Relacionado#
Outros provedores e caminhos de ingestão estão listados em Conectores Athia. Para descartes de arquivos e alternativas de armazém para armazém para um conector direto, consulte Integrando Athia.