Guía de integración WebServices

1. Pasarela Brinks

Descripción general

La pasarela Brinks es una plataforma de pago que permite a los vendedores recibir pagos en efectivo, para esto cuenta con dos métodos de pago, Recaudo en Punto y Recaudo Domiciliado.

Nuestra plataforma permite llegar a muchos clientes que no están bancarizados o que prefieren realizar sus transacciones en efectivo.

Con Brinks al ser en efectivo no tiene que capturar ni almacenar información de tarjetas de crédito en su sitio web ni certificarse lo que hace el proceso de integración más sencillo y rápido para los desarrolladores.

Para brindar una mayor seguridad en las transacciones están nunca deben realizarse de manera anónima, es por esto que para poder realizar pagos en Brinks es necesario crear un usuario, este usuario puede consultar las transacciones que ha realizado, agregar y administrar las direcciones de recaudo y generar reportes de sus compras.

Los vendedores cuentan con un módulo donde pueden generar reportes, obtener los datos de configuración los diferentes tipos de integración, para poder integrarse es necesario que los vendedores sean creados en la plataforma de Brinks.

2. Medios de recaudo

Recaudo Domiciliado

Es el proceso por el cual un recurso logístico se dirige hasta la ubicación en que se realiza la solicitud o la ubicación que determine el cliente y recauda a domicilo, estos procesos son seguros y una vez el recurso recaude el dinero se notifica al comercio para que realice el despacho de los productos o servicios adquiridos por el cliente del comercio.

Recaudo en Punto

Es el proceso por el cual un cliente genera una solicitud y de acuerdo a una ubicación ingresada se le muestran los puntos de recaudo cercanos a su ubicación donde se puede dirigir a realizar el pago, en cuanto registra el pago en uno de estos puntos aliados de Brinks se notifica al comercio, cabe destacar que los puntos de recaudo varían de país a país (Contacte a su ejecutivo de cuenta para obtener más información de nuestras redes aliadas).

3. Integración WebServices Comercios

Flujo de servicios

La opción de integración de WebServices es ideal para aquellos comercios/vendedores que desean mayor control sobre el flujo de compra de los clientes, con esta opción Brinks brinda todos los servicios y el comercio es el encargado de hacer la implementación del flujo, esta opciones puede no ser la ideal para los desarrolladores que no se sientan cómodos consumiendo servicios.

La gran ventaja que brinda esta integración es que el usuario nunca debe salir del sitio del comercio lo que brinda una experiencia de pago más integrada y natural para el cliente.

El flujo de lo servicios que se deben consumir es el siguiente:

Se debe tener en cuenta que todos los servicios en esta integración se realizan con el protocolo HTTP POST.

Brinks cuenta con dos ambientes el primero e certificación o sandbox es el siguiente:

http://api.devel.logisticappweb.com/

El de producción es el siguiente:

http://apicashco.logisticappweb.com

Cabe destacar que los servicios que acá se explican tienen por defecto la url de producción

Generación solicitud

Este es el servicio que se utilizar para validar la autenticidad del comercio que redirecciona a la plataforma.

Url : http://apicashco.logisticappweb.com/clientgateway/validatesignature

Parámetros de entrada requeridos:

commerce_id = Id del comercio
transaction = Referencia transacción del comercio
signature = Firma
ammount = Valor total


Parámetros de salida:

{
"return": true,
"data": {
"commerce": {
"commerce_id": ,
"commerce_name": ,
"state": ,
"signature_key": ,
"image": " }
},
"status": 200
}

En caso de error:

{
"return": false,
"message": "Error de autenticación",
"status": 409
}

Parámetros de entrada requeridos:

Parámetros de salida:

Login Clientes

Este es el servicio que se utilizar para que los usuarios puedan iniciar sesión con un usuario(Correo electrónico) y una contraseña.

Url : http://apicashco.logisticappweb.com/clientgateway/login

Parámetros de entrada requeridos:

pass = Contraseña
email = Email usuario
commerce_id = Id del comercio
transaction = Referencia transacción del comercio
signature = Firma
ammount = Valor total 2147483647


Parámetros de salida:

{
"return": true,
"data": {
"commerce": {
"commerce_id": ,
"commerce_name": ,
"state": ,
"signature_key": ,
"image": " }
},
"status": 200
}

En caso de error:

{
"return": false,
"message": "Error de autenticación",
"status": 409
}

Parámetros de entrada:

Parámetros de salida:

Login clientes Facebook

Este es el servicio que se utilizar para que los usuarios puedan iniciar sesión con su cuenta de Facebook.

Url : http://apicashco.logisticappweb.com/clientgateway/loginFacebook

Parámetros de entrada requeridos:

pass = Token Facebook
email = Email usuario
commerce_id =Id del comercio
transaction = Referencia transacción del comercio
signature = Firma
ammount = Valor total transacción


Login clientes Google

Este es el servicio que se utilizar para que los usuarios puedan iniciar sesión con su cuenta de Google.

Url : http://apicashco.logisticappweb.com/clientgateway/loginGoogle

Parámetros de entrada requeridos:

pass = Token Google
commerce_id =Id del comercio
transaction = Referencia transacción del comercio
signature = Firma
ammount = Valor total transacción


Registro Clientes

Este es el servicio que se utilizar para que los usuarios puedan registrarse en la pasarela con un usuario(Correo electrónico) y una contraseña.

Url: http://apicashco.logisticappweb.com/clientgateway/post

Parámetros de entrada requeridos:

pass = Contraseña
name = Nombres completos usuario
email = Email usuario
commerce_id = Id del comercio
transaction = Referencia transacción del comercio
signature = Firma
ammount = Valor total transacción


Registro clientes Facebook

Este es el servicio que se utilizar para que los usuarios puedan registrarse en la pasarela con su cuenta de Facebook.

Url: http://apicashco.logisticappweb.com/clientgateway/postFacebook

Parámetros de entrada requeridos:

pass = Token Facebook
email = Email usuario
name = Nombres completos usuario
commerce_id = Id del comercio
transaction = Referencia transacción del comercio
signature = Firma
ammount = Valor total transacción


Registro clientes Google

Este es el servicio que se utilizar para que los usuarios puedan registrarse en la pasarela con su cuenta de Google.

Url: http://apicashco.logisticappweb.com/clientgateway/postGoogle

Parámetros de entrada requeridos:

pass = Token Google
commerce_id = Id del comercio
transaction = Referencia transacción del comercio
signature = Firma
ammount = Valor total transacción


Parámetros requeridos servicios de registro:

Respuesta servicios de Login y Registro

En caso de que sea exitosa la petición:

{
"return": true,
"data": {
"email": "",
"name": "",
"client_id": "",
"commerce": {
"commerce_id": ,
"commerce_name": "",
"state": ,
"date_register": "",
"date_update": "",
"signature_key": "",
"image": "",
"payment_type": [
{
"type_payment_id":,
"tipo_pago": "",
"image": "",
"type_code":
}
],
"answer_page": ""
}
},
"status": 200
}

En caso registrar cliente ya registrado:

{
"return": false,
"message": "El cliente ya se encuentra registrado",
"status": 409
}

En caso de error:

{
"return": false,
"message": "Error de autenticación",
"status": 409
}

En caso de Ingresar con datos erróneos:

{
"return": false,
"message": "Credenciales invalidas",
"status": 200
}

Listar direcciones usuario

Este servicio permite listar todas las direcciones guardadas por un usuario.

Url : http://apicashco.logisticappweb.com/location/listLocationGatewayByUser

Parámetros de entrada requeridos:

user = email de usuario
commerce_id = Id del comercio
transaction = Referencia transacción del comercio
signature = Firma
ammount = Valor total transacción


Parámetros de salida:

En caso de que sea exitosa la petición:

{
"return": true,
"data": [
{
"id":,
"commerce_id": ,
"user": ,
"name_address": " ",
"address": "",
"detail_address": "",
"latitude": "",
"longitude": "",
"country": null,
"city":,
"contact_phone": ""
},
{
// direccion 2 …..
}
],
"message": "Lista de direcciones",
"status": 200
}

En caso de error:

{
"return": false,
"message": "No se encontraron direcciones",
"status": 409
}

Parámetros de entrada requeridos:

Parámetros de salida requeridos:

Guardar dirección usuario

Este es el servicio que se utilizar para guardar una dirección y asociarla a un usuario:

Url : http://apicashco.logisticappweb.com/location/postGateway

Parámetros de entrada requeridos:

user = email usuario
name_address = nombre dirección (Oficina, Casa, etc )
address = dirección
detail_address = detalle de la dirección
latitude = latitud
logitude = longitud
commerce_id = Id del comercio
transaction = Referencia transacción del comercio
signature = Firma
ammount = Valor total transacción


Parámetros opcionales:

id_location = id de location
country = id pail
city = id ciudad
contact_phone = teléfono usuario


Parámetros de salida:

{
"return": true,
"data": [
{
"id":,
"address": ,
}
],
"message": "Dirección creada exitosamente",
"status": 200
}


En caso de error

{
"return": false,
"message": "No se pudo crear la dirección",
"status": 409
}

Parámetros de entrada:

Parámetros de salida:

Generar Pin de Pago

Este es el servicio que se utilizar para generar pin de pago una vez el usuario ya ha seleccionado el método de pago y la dirección.

Url : http://apicashco.logisticappweb.com/cashtransaction/post

Parámetros de entrada:

client_gateway_id = id del usuario
description = Descripción de la transacción comercio
commerce_id = Id del comercio
transaction = Referencia transacción del comercio
signature = Firma
ammount = Valor total transacción


Parametros de salida:

{
"return": true,
"message": "Trasaccion generada exitosamente",
"data": {
"pin": "",
"ammount": "",
"generate_date": "2018-03-26 15:39:16",
"expiration_date": "2018-03-29 15:39:16",
"transaction_id":,
"transaction_commerce": "",
"response_page": ""
},
"status": 200
}


En caso de error:

{
"return": false,
"message": "No se pudo crear la dirección",
"status": 409
}


Parámetros de entrada requeridos:

Parámetros de salida:

Obtener puntos cercanos de recaudo

Este servicio permite buscar puntos cercanos de recaudo de unas coordenadas dadas.

Url : http://apicashco.logisticappweb.com/Subsidiarygateway/findSubsidiaries

Parámetros de entrada:

latitud = latitud
longitud = longitud
commerce_id = Id del comercio
transaction = Referencia transacción del comercio
signature = Firma
ammount = Valor total transacción


Parámetros de salida:

{
"return": true,
"message": "Se encontraron 2 puntos",
"data": [
{
"id": 251,
"name": "EPAGO SOACHA",
"distance": 6.71,
"latiud": "4.7045789",
"longitud": "-74.1090399",
"address": "Cra. 94 #75c-2 a 75c-90, Bogotá, Colombia",
"phone": "123",
"image": "http://www.buscayllama.com/wp-content/uploads/cache/images/EPAGOMETROMALL/EPAGOMETROMALL-691832237.jpg",
"schedule": "Abierto hasta 4pm"
},
{
"id": 252,
"name": "Punto prueba",
"distance": 3.77,
"latiud": "4.7121481879276",
"longitud": "-74.071841239929",
"address": "Cra. 58 #127-59",
"phone": null,
"image": "",
"schedule": "Abierto hasta 4pm"
}
],
"status": 200
}


En caso de error

{
"return": false,
"message": "No se encontraron puntos cerca",
"status": 200
}


Parámetros de entrada:

Parámetros de salida: