Criar pagamentos

Nesta página, você encontrará um guia passo a passo sobre como criar um pagamento e as informações necessárias para realizar essa tarefa.

Requisitos

Antes de começar a seguir as etapas descritas neste guia, você precisa:

Acesse seu Credenciais da API no Painel de Controle da Yuno, que são compostos por:
- public-api-key
- private-secrete-key
- account_id
Configure suas conexões em sua conta do Yuno Dashboard.
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.

Certifique-se de preencher esses requisitos antes de seguir o guia de criação de pagamento.

📘
Explore as coleções de Yuno Postman
A Yuno fornece Postman Collections que você pode usar para replicar os casos de uso localmente.

Resumo das etapas

O processo de criação de pagamento normalmente requer a conclusão das quatro etapas listadas abaixo.

📘
Métodos de pagamento e funcionalidades adicionais
Diferentes métodos de pagamento, como carteiras específicas ou BNPL, ou funcionalidades, como pagamentos divididos, podem exigir etapas adicionais antes da criação do pagamento.

Criar um payment

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. Use o id para initialize o checkout.

Se você estiver criando um pagamento para um usuário existente, que foi criado anteriormente e já tinha uma conta de pagamento, você poderá criar uma conta de pagamento. id você pode pular esta etapa.

Etapa 2: Criar uma sessão de checkout

Com um cliente registrado, você pode criar uma sessão de checkout. O checkout é o momento em que o cliente finaliza o pedido e procede ao pagamento dos produtos ou serviços que deseja adquirir. Portanto, nessa etapa, você fornecerá informações sobre o valor do pagamento e o local onde ele está sendo criado.

Use o Criar sessão de checkout endpoint. 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 da solicitação para o Criar sessão de checkout você receberá o endpoint checkout_session informações. Elas serão usadas para criar o token de uso único (OTT) e o pagamento nas próximas etapas.

Etapa 3: Crie um token de uso único (OTT)

Um token de uso único é um identificador exclusivo que a Yuno gera para proteger a privacidade e a segurança de seus clientes. Ele serve como um identificador para detalhes de pagamentos e evita que dados confidenciais sejam armazenados em seus servidores. Portanto, você pode usar tokens de uso único para simplificar a repetição de pagamentos por seus clientes sem a necessidade de reinserir suas informações de pagamento, tornando o processo mais seguro e conveniente.

Você sempre obterá o token de uso único do SDK da Yuno em seu aplicativo. Ao usar o SDK da Yuno, cuidamos de cada cenário específico que diferentes métodos de pagamento podem ter. Isso nos permite:

Solicite as informações que faltam para o método de pagamento registrado, caso o provedor selecionado na rota CARD precise de alguns campos adicionais.
Suporte à triagem de fraudes
Suporte 3DS

Você sempre pode usar a lista Tipo Payment para verificar todos os tipos de pagamento disponíveis. Na resposta do SDK, você receberá o one-time-tokenque você usará para criar o pagamento.

📘
Teste de pagamentos com cartão de crédito
Lembre-se de que, para testar pagamentos com cartão de crédito, você pode definir o Yuno Test Payment Gateway como um provedor em sua rota de cartão.

Etapa 4: Criar um pagamento

Você criará um pagamento usando o endpoint Create Payment. Com o Yuno, você pode criar pagamentos com vários métodos de pagamento, usando pagamentos 3DS ou divididos. No entanto, este guia se concentra em um pagamento simples sem requisitos adicionais de autenticação, validação ou registro.

Abaixo, você encontrará uma descrição mais detalhada de como criar um pagamento.

4.1 Fornecer os atributos necessários

Fornecer informações relacionadas ao cliente, incluindo checkout_session da Etapa 2 até checkout.session e customer_payer que contém o objeto id da Etapa 1.

Alguns objetos não são obrigatórios ao criar um pagamento. No entanto, se você fornecer essas informações, a experiência de pagamento do usuário será aprimorada. Esteja ciente dos campos obrigatórios se você quiser fornecer essas informações.

4.2 Escolha o tipo de captura

A Yuno oferece duas opções de captura de pagamento:

Etapa única: A autorização e a captura são realizadas simultaneamente. Você só precisa criar o pagamento. A autorização e a captura são realizadas automaticamente. Para a opção de etapa única, você precisa enviar o atributo capture como true na solicitação.
Duas etapas: A autorização e a captura são realizadas em momentos diferentes. Depois de criar o pagamento, você precisará executar uma solicitação de autorização e uma solicitação de captura. Se você quiser processar o pagamento em duas etapas, envie capture como false e depois de criar o pagamento, use a opção Autorizar Payment e o Autorização de captura para concluir o processo.

4.3 Recursos adicionais

O Yuno também permite que você use alguns recursos adicionais que são compatíveis com o processo básico de criação de pagamentos:

vault_on_success: Se o seu cliente usar um cartão de crédito para fazer o pagamento, permitiremos que você registre esse método de pagamento para o cliente para compras futuras na mesma etapa.
installments: Caso ofereça parcelas aos seus clientes para os pagamentos e o processador escolhido as aceite, você pode nos enviar o valor das parcelas para criar o pagamento.

Ambos os campos podem ser encontrados na seção de detalhes payment_method do pagamento.

ℹ️
Para gerar e receber um vaulted_token quando vault_on_success = trueO pagamento deve fazer referência a um cliente Yuno existente por meio de customer_payer.id. Criar ou enviar os dados do cliente em linha dentro da solicitação de pagamento não cria o cliente do nosso lado, portanto, não ocorrerá nenhum armazenamento. Quando essas condições forem atendidas e o status do pagamento for SUCCEEDED, o vaulted_token será retornado na resposta de pagamento e poderá ser usado para transações futuras.

Etapa 5: Verifique o status do pagamento

Após realizar a solicitação ao Criar Payment você pode verificar o status endpoint pagamento analisando o status e sub_status da resposta. Verifique a página Status Payment para ver todas as opções que você pode receber em resposta à solicitação de criação de pagamento.

Dependendo do processador e do método de pagamento, o status pode levar algum tempo para ser atualizado. Portanto, talvez você precise usar endpoints para recuperar o status do pagamento. Para executar essa tarefa, você pode usar o Retrieve Payment by ID ou Retrieve Payment by merchant_order_id. Outra opção é usar webhooks para receber notificações após cada evento. A Yuno recomenda que você use webhooks para monitorar melhor os pagamentos assíncronos. Consulte o guia Webhooks para saber como configurar a solução de webhooks fornecida pela Yuno.

📘
Testar pagamentos com cartão
Se você precisar testar pagamentos com cartão em geral, a Yuno fornece o Yuno Test Payment Gateway. Ele funciona como uma conexão, no entanto, está disponível apenas no ambiente sandbox. Consulte a página do Yuno Test Payment Gateway para conhecer todas as funcionalidades ou vá diretamente para o guia sobre como testar pagamentos com cartão.