Empezar

         API Endpoint

             https://bizumpay.com/api/
     

La presente documentación pretende describir la manera en la cual se puede integrar la API de Bizumpay, iniciando por la autenticación y posteriormente las operaciones que se pueden hacer mediante el consumo de los diferentes End-Points.

Bizumpay te permite recibir transferencias de Bizum y retirarlas en la cuenta de banco de tu preferencia.

Autenticación

Autenticación Web

Para tener acceso a la API de bizumpay debes poseer una cuenta registrada en el sitio web oficial, si no tienes una, puedas crear una con el enlace:
bizumpay.com/register

         bizumpay.com/register
     

register bizumpay register snapshot

Autenticación API

Una vez te hayas registrado y autenticado en bizumpay podras acceder también a la API del sistema, pero antes de hacerlo debes autenticarte en tu sistema con las mismas credenciales con las que te registraste(correo y contraseña) en Bizumpay.com. Para esta autenticación debes llamar al siguiente end-point de la API.

https://bizumpay.com/api/auth/login

 Login API

     POST    https://bizumpay.com/api/auth/login
         
             
Headers :

{
"Content-Type" : "application/json",
"X-Requested-With" : "XMLHttpRequest"
}
             
         

{your_email}: Correo electrónico con el que te encuentras registrado en Bizumpay.
{your_password}: Contraseña asignada a tu cuenta de bizumpay. {your_access_token}: Token con el cual te puedes autenticar en la API. Importante: Guarda el token para que posteriormente hagas tus peticiones a la API, sin el no tendras acceso a las funcionalidades.


                         
Body :

{
"email": "{your_email}",
"password": "{your_password}"
}
             
         

             
Ejemplo Response :

{
"access_token": "{your_access_token}",
"token_type": "Bearer",
"expires_at": "2022-02-23 21:15:14"
}
             
         

Consumo de API

 API Endpoint

     https://bizumpay.com/api/{end_points}
     

Para realizar una solicitud de API REST, puedes utilizar los metódos HTTP: GET, POST, PUT, PATCH o DELETE, la URL al servicio API, la URI a un recurso para consultar, enviar datos, actualizar o eliminar, y uno o más encabezados de solicitud HTTP.

{end_points}: Es la parte de la URL que va cambiar dependiendo los diferentes end-points de la API que se pueden consultar.

Integración Pagos Mediante Bizum

Bizumpay provee de dos metódos para recibir pagos de usuarios en nuestra cuenta, estos son popup y Web redirect, el primero básicamente es el que permite recibir pagos desde una cuenta de BIZUM y el segundo permite recibir pagos desde la cuenta de Bizumpay, a continuación se detallan mejor estos metódos de pago y como implementarlos utilizando la API de Bizumpay:

Pago Mediante Popup

{your_access_token}: Token con el cual te puedes autenticar en la API. Importante: Guarda el token para que posteriormente hagas tus peticiones a la API, sin el no tendras acceso a las funcionalidades.
{expected_value}: Valor que se espera sea enviado mediante Bizum, es un campo numérico que representa la cantidad de dinero esperada.

 Pagar con Popup

     GET   https://bizumpay.com/api/payment/popup
     
         
Headers :

{
"Authorization" : "Bearer {your_access_token}",
"Content-Type" : "application/json",
"X-Requested-With" : "XMLHttpRequest"
}
         
     

                     
Body :

{
"value": "{expected_value}"
}
         
     

         
Ejemplo Response :

{
"status": "OK",
"code": 200,
"data": {
 "code": "LP56g",
 "expected_value": 10,
 "currency": "USD",
 "phone": "659776245",
 "user_id": 1000,
 "updated_at": "2021-03-03T16:03:02.000000Z",
 "created_at": "2021-03-03T16:03:02.000000Z",
 "id": 1
}
}
         
     

Un popup es una especie de notificación modal, Bizumpay provee una plantilla de ejemplo que puedes utilizar y modificar a tu gusto, puedes descargarla Aqui: popup
Antes de mostrar el popup en tu sistema debes llamar el endpoint(/payment/popup) y enviarle la cantidad de dinero que esperas recibir, si todo sale bien te retornara los datos faltantes de la transacción, estos datos son:

Teléfono: Número de teléfono al que debes enviar el pago via Bizum.
Código: Se trata de 5 caracteres que debes adjuntar en la nota que Bizum permite adjuntar junto con toda transferencia, este código lo debes escribir tal cual(respetando mayusculas y minusculas) cuando se realice el pago mediante Bizum.
Como se puede notar en la llave data se puede obtener toda la información necesaria para mostrar el popup al usuario con los datos completos.

Una vez el cliente haya realizado el pago mediante Bizum al número de teléfono obtenido en el response y adjuntando el código de 5 carácteres en la nota de Bizum, recibiras una notificación en tu dashboard de Bizumpay con la transacción que se acaba de realizar y se actualizará tu balance con el nuevo saldo.