Point-of-sale icon

Construa sua integração com a API de Terminais

Checklist para construir uma integração determinais com a API da Adyen.

Support

Artigos, FAQs e solicitação de suporte: Adyen Help

Uma integração com API de terminais da Adyen permite que você inicie os pagamentos de seu sistema de caixa registradora e processe esses pagamentos por meio da Adyen usando nossos terminais de pagamento.

Aqui, descrevemos como você pode construir tal integração em um ambiente de teste antes de ir ao ar.

Antes de você começar

Etapa 1: configure sua conta de teste da Adyen

Depois de se inscrever para uma conta de teste da Adyen, você tem acesso à sua test Customer Area. Neste ambiente de teste, você precisa configurar uma estrutura para sua conta da Adyen. A estrutura mais adequada para você atende às suas necessidades de negócios.

  1. Determine a estrutura de sua conta da Adyen, com base em nossa documentação sobre a conta da empresa, contas de comerciante e lojas.

  2. Solicite as merchant accounts que você precisa. Forneça o máximo de detalhes possível e certifique-se de enviar os documentos e links corretos. Isso tornará o processo de inscrição mais suave e rápido..

  3. Se você precisar de stores em sua estrutura de conta, aguarde a confirmação de que suas contas de comerciante foram criadas e envie seu formulário de solicitação de loja.

Você pode adicionar mais merchant accounts e stores posteriormente, mas a estrutura básica deve refletir a estrutura que você planeja ter quando entrar em operação.

Etapa 2: defina o escopo da integração da API de Terminais.

A próxima etapa é determinar o escopo de sua integração.

Este também pode ser um bom momento para aprender sobre nossa API de Terminais e o ciclo de vida dos pagamentos.

  1. Escolha sua arquitetura de integração:

    • Com as comunicações locais, sua caixa registradora se comunica diretamente com o terminal de pagamento em sua rede local.
    • Com as comunicações na nuvem, sua caixa registradora se comunica com o terminal por meio da plataforma de pagamentos da Adyen..

  2. Dê uma olhada na visão geral dos recursos de pagamento e siga os links dessa visão geral para entender os recursos aos quais deseja oferecer suporte. Por exemplo, métodos de pagamento adicionais, captura atrasada, processamento off-line, depósito e muito mais.

  3. Determine suas necessidades de segurança PCI. Por padrão, protegemos as mensagens de pagamento com nossa solução de criptografia ponto a ponto (E2EE), mas também oferecemos criptografia ponto a ponto (P2PE). Ambos são igualmente seguros. Se você precisar de P2PE, deverá nos informar, porque então precisaremos fornecer um software diferente em seus terminais de pagamento..

Etapa 3: faça o pedido de terminais de teste

Agora vamos nos concentrar nos dispositivos para processamento de pagamentos. Esses dispositivos às vezes são chamados de pin entry devices (PED) ou points of interaction (POI), mas os chamamos de terminais.

  1. Escolha os terminais que deseja usar. A Adyen possui uma ampla variedade de modelos de terminais para diferentes necessidades de negócios.

  2. Quando você souber quais terminais deseja, é hora de solicitar um cartão de teste e um ou mais terminais para teste.

Levará pelo menos quatro dias úteis para que seus terminais cheguem..

Etapa 4: prepare seus terminais

Antes de usar seus terminais, você precisa configurá-los em sua test Customer Area. Você pode fazer isso em diferentes níveis: nível de company account, nível de merchant account, nível de store, e a nível de terminal. As configurações no nível company aplicam-se a todos os terminais da empresa. As configurações no nível merchant account ubstituem as configurações herdadas do nível company, e assim por diante.

  1. Habilite a API de Terminais.

  2. Adicione métodos de pagamento e defina as configurações do terminal e recursos de pagamento que estão no escopo que você decidiu. Nossa Support Team irá ajudá-lo com quaisquer recursos que você não consiga configurar totalmente.

  3. Atribua os terminais de teste a uma loja. Isso torna mais fácil começar a usar os terminais quando você os recebe. Você pode atribuir terminais de sua área de cliente ou usando nosso Terminal Management API.

Etapa 5: configure sua integração

Agora você pode construir sua integração.

  1. Opcional. Adicione membros da equipe e credenciais de API à sua conta.

    • Você pode criar usuários adicionais da Área do Cliente para os membros da sua equipe.
    • Com sua conta de teste, você tem uma credencial de API padrão que usamos para fluxos que exigem autenticação, como processamento de pagamentos e pedidos de terminais de pagamento.
      Quando você entrar no ar, você desejará criar uma credencial de API além da padrão ou criar credenciais de API separadas para ponto de venda e comércio eletrônico. É uma boa prática (embora não obrigatório) fazer o mesmo em sua conta de teste..
  2. Dependendo da arquitetura de integração que você escolheu, configure uma integração local ou uma integração em nuvem. Você também precisa certificar-se de usar os endereços IP ou terminais corretos e a autenticação adequada. Por exemplo, para uma integração em nuvem, você precisa obter uma chave de API.
    Ao fazer isso, certifique-se de implementar nossas recomendações de rede.

  3. Ao receber os terminais de teste, siga as etapas no manual do modelo do terminal para colocá-los em funcionamento. As etapas são:

    • Inspecione o terminal para verificar se ele não foi adulterado.
    • Insira o rolo de papel de recibo.
    • Ligue o terminal.
    • Conecte o terminal à sua rede.
    • Embarque no terminal.
    • este a conexão com a plataforma de pagamentos da Adyen.

Etapa 6: teste sua integração

Agora é hora de testar exaustivamente todos os aspectos de sua integração, desde fazer um pagamento até a reconciliação.

  1. Faça vários tipos de transações de teste

  2. Aprenda como lidar com pagamentos falhados e outras condições de erro e como resolver problemas com seus terminais.

  3. Certifique-se de que sua reconciliação esteja funcionando.

    • Baixe o relatório de detalhes do acordo automaticamente.
    • Aprenda como automatizar sua reconciliação de pagamento.
    • Se você estiver usando IDs de loja ou conversão de moeda (DCC), peça à nossa Support Team para adicionar esses campos aos seus relatórios.

Ao vivo

Ao terminar o teste, primeiro você deve se inscrever para uma conta ativa e assinar o contrato antes de colocar sua integração ao vivo.