Enroll métodosPayment

Esta página o orientará na inscrição de um método de pagamento em uma conta de cliente e na obtenção de um vaulted_token para compras futuras.

📘

Token abobadado

Um Vaulted Token é criado quando um método de pagamento é registrado e armazenado com as informações do cliente. Você pode usar o Vaulted Token criado para identificar o método de pagamento em pagamentos futuros.

O serviço de tokenização e o cofre centralizado do Yuno permitem que você lide com pagamentos recorrentes, fallbacks e novas tentativas entre processadores sem comprometer a experiência do usuário. Os seguintes métodos de pagamento estão disponíveis para registro no Yuno:

Métodos de pagamento disponíveis para inscrição

(*) Somente SDK. Consulte a documentação do SDK para obter detalhes sobre a integração.

Requisitos

Antes de iniciar o processo de inscrição, você precisa:

• Acesse seu Credenciais da API no Painel de Controle da Yuno, que são compostos por:
  • public-api-key
  • private-secret-key
  • account_id
• Configure suas conexões em sua conta do Yuno Dashboard. Adicione um método de pagamento que exija registro.
• Crie uma rota para o método de pagamento para definir como ele será processado.
• Configure o construtor de checkout para disponibilizar seus pagamentos conectados.

Resumo das etapas

Para registrar um método de pagamento em uma conta de cliente, siga as etapas listadas abaixo.

1. Criar um cliente
2. Criar sessão do cliente (exclusivo para o fluxo de trabalho de checkout)
3. (Opcional) Recuperar métodos de pagamento disponíveis para inscrição - fluxo de trabalho de checkout
4. Inscrever fluxo de trabalho de checkout/fluxo detrabalho direto do método de pagamento
5. Recuperar métodos de pagamento - Fluxo de trabalho direto

Registrar um método de pagamento

Etapa 1: Criar um cliente

Use o Criar o cliente para registrar as informações do cliente. Você precisará fornecer informações pessoais do cliente. Além disso, você também precisará fornecer as merchant_customer_idO nome do cliente é um identificador exclusivo para o cliente usado em seu sistema.

📘

Informações complementares do cliente

Ao criar um cliente, algumas informações não são obrigatórias, mas podem melhorar a experiência de pagamento do usuário se forem fornecidas. Telefone, endereço de cobrança e endereço de entrega são exemplos de dados não obrigatórios que você pode fornecer. Se você adicionar informações opcionais, esteja ciente dos campos obrigatórios exigidos.

Ao final do processo de criação de um cliente, você receberá uma mensagem idque identifica o usuário no sistema Yuno. Se você estiver inscrevendo um método de pagamento para um usuário existente, que foi criado anteriormente e já tinha um idvocê pode pular esta etapa.

Etapa 2: Criar uma sessão de cliente

🚧

Requisitos de fluxo de trabalho

O fluxo de trabalho de inscrição varia de acordo com o tipo de método de pagamento:

• Fluxo de trabalho de checkout: Requer sessão do cliente para a maioria dos métodos de pagamento (cartões, Nupay, PayPal, Daviplata, métodos dLocal, Astropay, Adyen PIX Biométrico)
• Fluxo de trabalho direto: Disponível somente para cartões (comerciantes em conformidade com a PCI). Prossiga diretamente para a Etapa 3 usando a senha do cliente id gerado na Etapa 1.
• Fluxo de trabalho do SDK: Métodos de pagamento como Nequi e Bancolombia Tokenbox exigem a implementação do SDK. O WALLET_CONNECT (MercadoPago) é compatível com os fluxos de trabalho do SDK e do Checkout. Consulte a documentação do SDK para obter detalhes.
• Seamless SDKVocê pode cadastrar métodos de pagamento durante o fluxo de pagamento contínuo, definindo vault_on_success: true ao criar o pagamento. O método de pagamento será automaticamente registrado se o pagamento for bem-sucedido. Consulte Seamless SDK (pagamento via Web) para obter mais detalhes.

Depois de criar o cliente, você criará uma sessão de cliente para identificar e armazenar as informações dos clientes em relação às preferências de pagamento. Use o endpoint Criar sessão do cliente para executar a solicitação. Observe que o customer_id necessário para executar a solicitação é o id que você recebeu ao criar o cliente em Etapa 1.

Da resposta do endpoint Criar sessão do clientevocê receberá o customer_session. Ele será usado no processo de registro do método de pagamento.

Etapa 3: Recupere os métodos de pagamento para se inscrever

Essa é uma etapa opcional em que você pode listar todos os métodos de pagamento disponíveis nos quais o cliente pode se inscrever. Se você souber em qual método de pagamento o usuário se inscreverá, poderá prosseguir para a Etapa 4.

Para listar os métodos de pagamento disponíveis, você pode usar o endpoint Retrieve Payment Methods To Enroll (Recuperar métodos de pagamento para registro). Se você estiver usando o ponto de extremidade Fluxo de trabalho de checkoutVocê informará o customer_session na solicitação. O fluxo de trabalho Direct não suporta atualmente a recuperação de métodos de pagamento disponíveis para inscrição.

A resposta ao endpoint Recuperar métodos Payment para Enroll conterá apenas o payment_methods parâmetro. Ele fornecerá uma matriz de objetos com todos os métodos de pagamento disponíveis para registro. Você usará o parâmetro type informações para registrar o método de pagamento na próxima etapa.

📘

Métodos de pagamento disponíveis

Quando você recupera os métodos de pagamento disponíveis para inscrição, somente aqueles que você conectou, criou uma rota e adicionou ao checkout estarão presentes na resposta.

Etapa 4: Registre um método de pagamento

Depois de definir o método de pagamento, você pode realizar o registro usando um dos endpoints Enroll Payment Method:

• Fluxo de trabalho de checkout: Forneça o type relacionado ao método de pagamento escolhido para o parâmetro payment_method_type. Os tipos compatíveis incluem: CARD, NU_PAY_ENROLLMENT, PAYPAL_ENROLLMENT, DAVIPLATA_ENROLLMENT, WALLET_CONNECT, YAPE_ENROLLMENT, SMART_PIX, ASTROPAY_ENROLLABLE (com espaço), PIX_BIOMETRICO.
• Fluxo de trabalho direto: Forneça o type relacionado ao método de pagamento escolhido para o parâmetro type. (Disponível apenas para CARD métodos de pagamento para comerciantes em conformidade com a PCI)
• Fluxo de trabalho do SDK: Métodos de pagamento como NEQUI e BANCOLOMBIA_TOKENBOX exigem a implementação do SDK. WALLET_CONNECT (MercadoPago) suporta os fluxos de trabalho SDK e Checkout.

O usuário deve ser redirecionado para a página do provedor de pagamento para concluir o processo de inscrição. Você receberá esse URL na Etapa 5.

Etapa 5: Recuperar métodos de pagamento

Para se inscrever com sucesso no método de pagamento, o cliente deve fornecer autorização na página do provedor de pagamento. Para receber a URL, use um dos seguintes endpoints , dependendo do fluxo de trabalho que estiver usando:

• Fluxo de trabalho de checkout: A URL de registro é fornecida diretamente na resposta de registro da Etapa 4. O URL para redirecionar o usuário estará disponível no parâmetro provider.redirect.init_url.
• Fluxo de trabalho direto: No caso do fluxo de trabalho Direct, como ele só está disponível para inscrições de cartões, você receberá o status final na etapa anterior.

Redirecione o usuário para que ele forneça a autorização necessária. Após o registro, você pode prosseguir com a criação da sessão de checkout na próxima etapa.

Para confirmar a inscrição, você pode recuperar os métodos de pagamento inscritos. O status do método de pagamento registrado deve ser ENROLLED.

📘

Fingerprint

Quando um cartão de crédito é registrado, você também encontrará o fingerprint na resposta da API. É um campo que representa o cartão de seu cliente em toda a sua organização. Quando um cliente registra um cartão de crédito várias vezes relacionado a uma ou várias contas Yuno, vários vaulted_tokens serão gerados, mas a fingerprint permite identificar quando o mesmo cartão é usado em vários cenários.

Você também encontrará a fingerprint na resposta de pagamento quando uma transação for feita usando um cartão de crédito registrado.