Saltar al contenido
Última actualización

Requisitos Previos para Pagos en Brasil

Antes de que puedas usar nuestra solución OFPI y comenzar a recibir pagos, necesitarás:

  1. Registrarte para obtener una Cuenta de Belvo.

  2. Crear tus claves secretas de Payments.

  3. Registrar tu webhook para que podamos informarte sobre eventos importantes durante el proceso de pago, como las confirmaciones de pago.

  4. Registrar una cuenta bancaria que recibirá los fondos.

  5. Preparar las URLs de callback. Estas son URLs a las que el usuario debe ser redirigido cuando complete o cancele un pago, o si ocurre un error durante el proceso de pago.

Regístrate para una Cuenta de Belvo

Para comenzar con Belvo, necesitas crear una cuenta de Belvo y generar tus claves de API.

  1. Ve a la página de registro de Belvo y completa los campos requeridos.
  1. Revisa tu bandeja de entrada para un correo electrónico de nosotros y confirma tu dirección de correo electrónico.
    La línea de asunto será: [Belvo] Please Confirm Your Email Address

✳️ ¡Genial! Una vez que hagas clic en el enlace del correo electrónico, serás redirigido al dashboard de Belvo. En el dashboard, puedes configurar tu cuenta, revisar tus registros de actividad y generar tus claves de API de Belvo.

Genera tus claves API

Ahora que tienes una cuenta, generemos algunas claves API para comenzar a trabajar con Belvo.

Para generar tus claves API:

  1. En el entorno de Producción, ve a la sección Herramientas para Desarrolladores - Claves API del dashboard.
  2. Haz clic en la pestaña Claves API de Pagos.
  3. Haz clic en Generar Claves API, lo que generará automáticamente tus claves API.
  4. En la ventana emergente, haz clic en el botón Descargar claves API. Asegúrate de guardarlas en un lugar seguro.
Colección de Postman

Para ayudarte con tus solicitudes diarias, tenemos una Colección Pública de Postman curada para que la uses. Solo asegúrate de tener una cuenta de Postman, luego:

  1. Haz un fork de la colección a tu espacio de trabajo (instrucciones oficiales para hacer fork de Postman).

  2. Haz un fork del archivo de variables de entorno en blanco a tu espacio de trabajo.

  3. Completa las variables de entorno con tus claves API de Belvo.

Registrar un webhook

Nuestras soluciones de pago utilizan webhooks para informarte sobre el progreso de tus pagos, cualquier error que ocurra y cuando un pago se completa exitosamente. Por lo tanto, necesitarás configurar al menos un webhook para recibir eventos de Belvo. Tu servidor debe responder con un 200 OK a nuestros eventos de webhook.

Múltiples URLs de Webhook

Puedes registrar múltiples URLs de webhook para tu organización. Cuando se registran múltiples URLs, todas las URLs de webhook registradas recibirán la misma notificación de evento para cada evento de webhook. Esto te permite enviar notificaciones a diferentes sistemas o entornos simultáneamente.

Si nuestro sistema no recibe un código de estado 200, intentará enviar la solicitud nuevamente automáticamente. Este proceso de reintento ocurrirá hasta tres veces, con cada intento espaciado 60 segundos. Por ejemplo, si el primer intento falla, nuestro sistema espera 60 segundos antes de intentar nuevamente y continuará este patrón hasta que reciba una respuesta exitosa o alcance el máximo de tres reintentos.

Puedes recibir eventos de webhook desde las siguientes direcciones IP:

  • 3.130.254.46
  • 18.220.61.186
  • 18.223.45.212

Recomendamos encarecidamente que pongas en lista blanca estas direcciones IP para que puedas recibir eventos de webhook.

Para agregar URLs de webhook al sistema de Belvo:

  1. En tu panel de control de Belvo, ve a la sección de webhooks de pagos.

  2. En la pestaña Open Payments Webhooks, haz clic en +Nuevo webhook.

  3. Completa el formulario de Nuevo webhook con la información requerida.

    • URL: la URL para recibir las notificaciones del webhook.
    • Authorization: un token bearer opcional para usar si tu URL está protegida.
  4. Haz clic en Crear webhook.

  5. Para registrar URLs de webhook adicionales, repite los pasos 2-4 para cada URL que desees agregar. Todas las URLs registradas recibirán los mismos eventos de webhook.

Registrar una cuenta bancaria beneficiaria

Para usar el producto OFPI de Belvo, necesitas registrar al menos una cuenta bancaria que recibirá fondos. El número de cuentas bancarias que necesitas registrar depende de tu caso de uso.

Caso de Uso 1

Caso de UsoInstrucciones
Siempre recibirás fondos en la misma cuenta bancaria.Solo necesitas registrar esa única cuenta bancaria donde deseas recibir tus fondos.

Caso de Uso 2

Caso de UsoInstrucciones
Eres un intermediario que procesa pagos para varios clientes y depositará dinero en las cuentas bancarias de tus clientes.Necesitas registrar una cuenta bancaria para cada cliente que recibirá dinero en su cuenta bancaria.

Caso de Uso 3

Caso de UsoInstrucciones
Ofreces una ‘billetera’ dentro de tu aplicación que tus clientes pueden ‘recargar’.Necesitas registrar una cuenta bancaria para cada ‘billetera’ de cliente.

Instrucciones

Para registrar una cuenta bancaria, necesitas realizar una solicitud POST Registrar una nueva cuenta bancaria.

Individual
{
  "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"
  }
}
Parámetro RequeridoDescripción
institutionsiEl id de Belvo para la institución donde se mantiene la cuenta bancaria. Para más información sobre cómo obtener este id, consulta nuestra documentación de List Payment Institutions.
external_idopcional (pero recomendado)Un identificador único adicional (UUID) para el recurso con fines internos. Esto puede ser útil para rastrear el recurso en tu sistema y para propósitos de depuración.
holder.typesiEn el parámetro type, necesitas indicar quién es el titular de la cuenta: INDIVIDUAL: El titular de la cuenta es un individuo. BUSINESS: El titular de la cuenta es un negocio. Dependiendo del tipo que indiques, necesitarás proporcionar diferentes detalles en el objeto information.
holder.informationsiEn el objeto information, necesitas proporcionar la siguiente información sobre el titular de la cuenta: Individual first_name: El nombre del individuo. last_name: El apellido del individuo. identifier_type: Para individuos, esto debe establecerse en CPF. identifier: El número de CPF (debe tener 11 caracteres de longitud). Business name: El nombre del negocio. identifier_type: Para negocios, esto debe establecerse en CNPJ. identifier: El número de CNPJ (debe tener 14 caracteres de longitud).
detailssiEn el objeto details, necesitas proporcionar la siguiente información sobre la cuenta bancaria: account_type: El tipo de cuenta. Puede ser: CHECKINGS, SAVINGS, SALARY, o PAYMENTS agency: El código de la sucursal donde se abrió la cuenta. number: El número de la cuenta bancaria.

Una vez que realices una solicitud exitosa, recibirás la siguiente respuesta de nuestra API. Asegúrate de guardar el id de la respuesta: lo usarás como el beneficiary_bank_account en el futuro cuando crees intenciones de pago.

{
  "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"
    }
  }
}
ParámetroTipoDescripción
idstringIdentificador único de Belvo para la cuenta bancaria. Necesitarás este ID al crear una intención de pago o un enlace de pago para indicar qué cuenta debe recibir los fondos.
created_atstring (date-time)La marca de tiempo ISO-8601 de cuándo se creó el punto de datos en la base de datos de Belvo.
created_bystringEl ID único para el usuario que creó este ítem.
institutionstringEl ID único de Belvo para la institución en la que se crea la cuenta bancaria.
detailsobjectDetalles sobre la cuenta bancaria (según lo proporcionado por ti en la llamada POST).
holderobjectDetalles sobre el titular de la cuenta (según lo proporcionado por ti en la llamada POST).

Crear URLs de callback

Tus usuarios necesitarán ser redirigidos de vuelta a tu aplicación una vez que hayan completado el proceso de pago.

API Directa (Intenciones de Pago)

Para las Intenciones de Pago, solo necesitas tener una URL a la cual redirigir al usuario una vez que hayan confirmado el pago en su institución (éxito o fallo).

¡Hecho!

Una vez que hayas completado todos estos requisitos previos, ahora puedes comenzar a procesar pagos utilizando la API de Belvo.