Pré-requisitos para Pagamentos no Brasil

Antes de poder usar nossa solução OFPI e começar a coletar pagamentos, você precisará:

1. Inscrever-se para uma Conta Belvo.

2. Criar suas chaves secretas de Payments.

3. Registrar seu webhook para que possamos informá-lo sobre eventos importantes durante o processo de pagamento, como confirmações de pagamento.

4. Registrar uma conta bancária que receberá os fundos.

5. Preparar URLs de callback. Estas são URLs para as quais o usuário deve ser redirecionado quando completar ou cancelar um pagamento, ou se ocorrer um erro durante o processo de pagamento.

Inscreva-se para uma Conta Belvo

Para começar a usar o Belvo, você precisa criar uma conta Belvo e gerar suas chaves de API.

1. Acesse a página de inscrição do Belvo e preencha os campos obrigatórios.

1. Verifique sua caixa de entrada para um e-mail nosso e confirme seu endereço de e-mail.
   A linha de assunto será: [Belvo] Please Confirm Your Email Address

✳️ Incrível! Assim que você clicar no link no e-mail, será redirecionado para o dashboard do Belvo! No dashboard, você pode configurar sua conta, verificar seus registros de atividade e gerar suas chaves de API do Belvo.

Crie suas chaves secretas de pagamentos

Agora que você tem uma conta - vamos gerar algumas chaves de API para começar a trabalhar com a Belvo.

Para gerar suas chaves de API:

1. No ambiente de Produção, vá para a seção Desenvolvedores - Chaves de API do dashboard.
2. Clique na aba Chaves de API de Pagamentos.
3. Clique em Gerar Chaves de API, o que gerará automaticamente suas chaves de API.
4. No pop-up, clique no botão Baixar chaves de API. Certifique-se de armazená-las em um local seguro.

Registrar um webhook

Nossas soluções de pagamento utilizam webhooks para informá-lo sobre o progresso de seus pagamentos, quaisquer erros que ocorram e quando um pagamento é concluído com sucesso. Assim, você precisará configurar um webhook para receber eventos da Belvo. Seu servidor deve responder com um 200 OK aos nossos eventos de webhook.

Se nosso sistema não receber o código de status 200, ele tenta automaticamente enviar a solicitação novamente. Este processo de tentativa ocorrerá até três vezes, com cada tentativa espaçada por 60 segundos. Por exemplo, se a primeira tentativa falhar, nosso sistema espera 60 segundos antes de tentar novamente e continuará esse padrão até que receba uma resposta bem-sucedida ou atinja o máximo de três tentativas.

Você pode receber eventos de webhook dos seguintes endereços IP:

• 3.130.254.46
• 18.220.61.186
• 18.223.45.212

Para adicionar sua URL de webhook ao sistema da Belvo:

1. No seu dashboard da Belvo, vá para a seção de webhooks de pagamento.

2. Na aba Open Payments Webhooks, clique em +New webhook.

   

3. Preencha o formulário New webhook com as informações necessárias.

   • URL: a URL para receber as notificações de webhook.
   • Authorization: um token bearer opcional para usar se sua URL estiver protegida.

4. Clique em Create webhook.

   

Registrar uma conta bancária beneficiária

Para usar o produto OFPI da Belvo, você precisa registrar pelo menos uma conta bancária que receberá fundos. O número de contas bancárias que você precisa registrar depende do seu caso de uso.

Caso de Uso 1

Caso de Uso 2

Caso de Uso 3

Instruções

Para registrar uma conta bancária, você precisa fazer uma solicitação POST Registrar uma nova conta bancária.

{
  "institution": "f512d996-583a-4a91-8b5b-eba2e103b068",
  "external_id": "2c75c041-9cc7-430a-84e9-3b234aae76a2",
  "holder": {
    "type": "INDIVIDUAL",
    "information": {
      "first_name": "Caetano",
      "last_name": "Veloso",
      "identifier_type": "CPF",
      "identifier": "12345678901"
    }
  },
  "details": {
    "account_type": "CHECKINGS",
    "agency": "0444",
    "number": "457220"
  }
}

Uma vez que você faça uma solicitação bem-sucedida, você receberá a seguinte resposta da nossa API. Certifique-se de salvar o id da resposta - você o usará como beneficiary_bank_account no futuro ao criar links de pagamento ou intents de pagamento.

{
  "id": "1c83ead8-6665-429c-a17a-ddc76cb3a95e",
  "created_at": "2020-04-23T21:30:20.336854+00:00",
  "created_by": "62053a72-e2d5-4c95-a578-6b16616900ac",
  "institution": "f512d996-583a-4a91-8b5b-eba2e103b068",
  "details": {
    "country": "BRA",
    "account_type": "CHECKINGS",
    "agency": "0444",
    "number": "45722-0"
  },
  "holder": {
    "type": "BUSINESS",
    "information": {
      "identifier_type": "CNPJ",
      "name": "Caetano Veloso Entertainment Universe",
      "identifier": "23100299900"
    }
  }
}

Criar URLs de callback

Seus usuários precisarão ser redirecionados de volta para o seu aplicativo assim que concluírem o processo de pagamento. As URLs de callback que você fornece dependem se você está usando uma integração de API Direta ou usando nosso widget de Links de Pagamento.

API Direta (Payment Intents)

Para Payment Intents, você só precisa ter uma URL para redirecionar o usuário assim que ele confirmar o pagamento em sua instituição (sucesso ou falha).

Payment Links

Para Payment Links, você precisará fornecer duas URLs:

• success: A URL para onde o usuário deve ser redirecionado após completar o fluxo no widget do payment link.
• cancel: A URL para onde o usuário deve ser redirecionado se sair do widget antes de completar o fluxo.

Feito!

Depois de concluir todos esses pré-requisitos, você pode agora começar a processar pagamentos usando a API da Belvo.