WebCheckout

¿Qué es nuestro WebCheckout?

¿Cómo crear un link con valor fijo para el WebCheckout?

Inicialmente, tienes que crear una terminal seguido de esto tienes que crear un botón de pago  

Te diriges a nuestro menú en donde buscaras un apartado llamado "Links de pago"

En este apartado tendras dos opciones:

• Crear links masivos
• Crear link de pago

Crear links masivos

Esta función te permitirá crear links masivos para diferentes clientes en específico a partir de una plantilla de Excel 

Crear link de pago

Los links de pago te permitirán enviar un link para una persona específica (Llenando la información del pagador) o si se requiere para una persona no especifica esto gracias a que la información del pagador es opcional

Link generado

Una vez creado el link te aparecerá en la tabla mostrando la descripción, monto a pagar y la fecha de vencimiento y tendremos los links generados en los que tendrás 3 opciones

• Ver: Esta opción te abrirá el link hacia el WebCheckout
• Copiar: Esta opción te copiará el link en la clipboard, podrás pegarlo en cualquier parte que lo necesites, la diferencia con ver el link es que esta opción te generara un link recortado
• Compartir: Esta opción te abrirá un modal en el que podrás colocar el número del cliente y enviárselo, al igual que la opción de copiar te generara un link recortado

¿Cómo crear un link con valor dinamico para el WebCheckout?

Inicialmente, tienes que crear una terminal seguido de esto tienes que crear un botón de pago  

Te diriges a nuestro menú en donde buscaras un apartado llamado "Links de pago express"

Seleccionas la opción crear link de pago abierto.

se abrirá un modal, y habrá una opción llamada "¿Va a ser un monto fijo?" Selecciona "no" y ahora el monto del WebCheckout será seleccionado por los clientes

BOTÓN DE PAGO

< form method="Post" action="https://merchant.paymentsway.co/cartaspago/redirect">
                      <input name="merchant_id" type="hidden"  value="0">
                      <input name="form_id" type="hidden"  value="0">
                      <input name="terminal_id" type="hidden"  value="0">
                      <input name="order_number" type="hidden"  value="0">
                      <input name="amount" type="hidden"  value="0">
                      <input name="currency" type="hidden"  value="cop">
                      <input name="order_description" type="hidden"  value="Test de compra">
                      <input name="client_email" type="hidden" value="user@example.com">
                      <input name="client_phone" type="hidden" value="3000000000">
                      <input name="client_firstname" type="hidden" value="pepito perez">
                      <input name="client_lastname" type="hidden" value="ramirez ramirez">
                      <input name="client_doctype" type="hidden" value="4">
                      <input name="client_numdoc" type="hidden" value="1234567890">
                      <input name="response_url" type="hidden" value="http://www.test.com/response">
                      <input name="Submit" type="submit"  value="Enviar">
</form>

Parámetros mínimos a enviar en el formulario:

Tipo de documento del cliente

Este campo se debe generar con su id correspondiente dependiedo de la descripción para el tipo de documento de la siguiente manera:

• id="1": Pasaporte.
• id="4": Cédula de ciudadanía.
• id="5": Cédula de extranjería.
• id="6": NIT.

Currency

Este campo se debe generar con su value correspondiente dependiedo de la descripción del tipo de moneda de la siguiente manera:

• value="COP": Pesos colombianos.
• value="USD": Dolares americanos.
• value="EUR": Euros.

Modo de uso

Una vez copiado el código en su pagina web o E-commerce usted podrá visualizar el siguiente botón: ((Recuerde que el botón tendrá los estilos que usted desee implementar en su pagina Web o E-commerce).)

Modificando el atributo   <name=”currency”>  dentro   <form>  usted podrá cambiar la moneda con la cual se efectuará su pago.

• Hará Clic en el botón enviar, el cual lo re direccionará a la pasarela de pagos, donde procederá a elegir el método de pago (Tarjeta, Pse o Efectivo) y finalmente realizar su pago.

BOTÓN DE PAGOS ABIERTOS

<form method="post " action="https://merchant.paymentsway.co/cartaspago/redirect">
                      <input name="merchant_id" type="hidden"  value="0" >
                      <input name="form_id" type="hidden"  value="0" >
                      <input name="terminal_id" type="hidden"  value="0" >
                      <input name="order_number" type="hidden"  value="1254>"
                      <input name="amount" type="hidden"  value="0" >
                      <input name="currency" type="hidden"  value="cop" >
                      <input name="type_method" type="hidden"  value="0" >
                      <input name="amount_1" type="hidden"  value="10000" >
                      <input name="amount_2" type="hidden"  value="20000" >
                      <input name="amount_3" type="hidden"  value="30000" >
                      <input name="amount_4" type="hidden"  value="40000" >
                      <input name="min_amount" type="hidden"  value="10000" >
                      <input name="max_amount" type="hidden"  value="40000" >
                      <input name="client_email" type="hidden" value="user@example.com" >
                      <input name="client_phone" type="hidden" value="3000000000" >
                      <input name="client_firstname" type="hidden" value="pepito perez" >
                      <input name="client_lastname" type="hidden" value="ramirez ramirez" >
                      <input name="client_doctype" type="hidden" value="4" >
                      <input name="client_numdoc" type="hidden" value="1234567890" >
                      <input name="response_url" type="hidden" value="http://www.test.com/response" >
                      <input name="Submit" type="submit"  value="Enviar" >
</ form>

Parámetros mínimos a enviar en el formulario:

Tipo de documento del cliente

Este campo se debe generar con su id correspondiente dependiedo de la descripción para el tipo de documento de la siguiente manera:

• id="1": Pasaporte.
• id="4": Cédula de ciudadanía.
• id="5": Cédula de extranjería.
• id="6": NIT.

Currency

Este campo se debe generar con su value correspondiente dependiedo de la descripción del tipo de moneda de la siguiente manera:

• value="COP": Pesos colombianos.
• value="USD": Dolares americanos.
• value="EUR": Euros.

MODO DE USO

Una vez copiado el código en su pagina web o E-commerce usted podrá visualizar el siguiente botón: (Recuerde que el botón tendrá los estilos que usted desee implementar en su pagina Web o E-commerce).

Haciendo clic en el botón enviar, usted será re direccionado a la pasarela de pagos abiertos, la cual se visualizará de la siguiente manera:

Para escoger los montos a pagar usted encontrará dos maneras de hacerlo:

• La primera será seleccionando alguna de las cuatro opciones que se muestran en pantalla.



Con el botón de pago, su cliente tendrá la opción de elegir el monto con el cual desea realizar el pago. Estos valores podrán ser modificados de manera manual cambiando los parámetros del amount.

<input name=" amount_1" type="hidden"   value="10000" >
<input name=" amount_2" type="hidden"   value="20000" >
<input name=" amount_3" type="hidden"   value="30000" >
<input name=" amount_4" type="hidden"   value="40000" >

• En nuestra segunda opción su cliente podrá elegir de manera manual un monto en un intervalo mínimo y máximo, este valor se le ira indicado con una barra medidora la cual ira mostrando los montos elegidos en la parte superior.



Para modificar el rango mínimo y máximo del monto con el cual desea realizar el pago usted debería cambiar de manera manual los parámetros del amount.

    <input name="min_amount"  type="hidden"  value="10000">
    <input name="max_amount"  type="hidden"  value="40000">

• Una vez elegido el monto para realizar el pago, su cliente podrá elegir la opción de “Realizar pagos recurrentes” donde también podrá elegir el intervalo de tiempo por el cual se efectuarán esos pagos (Mensual, Trimestral, Semestral o Anual).



• Para finalizar, su cliente deberá elegir el método de pago que mas cómodo le quede (Tarjeta crédito/debito, Pse o Efectivo).

WIDGET

Acepte pagos en su sitio web en minutos, utilizando nuestra opción de Checkout; Permita que sus clientes completen un pago sin salir de su sitio web, simplemente incluyendo una etiqueta   <script>  dentro su página web. Para el uso del widget, inicialmente agregue en su documento lo siguiente:

1. En la parte del   <head>   agregaremos el siguiente css

  <link rel="stylesheet" href="https://merchant.paymentsway.co/assetsWidget/css/index.css " />

2. Agregamos el siguiente script hasta el final del   <body>  , para que pueda cargar correctamente el script

  <script src="https://merchant.paymentsway.co/assetsWidget/js/index.js">  </script>

3. Una vez agregados los hipervinculos y definido el espacio donde se visualizará nuestro widget, usted deberá anexar el siguiente código:

  <div id="payment-widget" >  </div>

4. Creara en su proyecto un  <script>  en el   <body>  . Es importante que se haga el llamado .Una vez creada la etiqueta, pondra la implementación del widget con el siguiente codigo

const checkout = new widgetCheckout({
    merchant_id : 'su Merchant id' ,
    form_id : 'su form id',
    terminal_id : 'su terminal id',
    order_number : 'su order number',
    amount : 'finalPrice',
    currency : 'COP',
    order_description : 'Test de compra',
    apikey : Apikey,
    ip : '192.158.1.38',
    additionalData : {...},
});

Parámetros a enviar en el widget:

const checkout = new widgetCheckout({
        ...InformacionDelComercio,
        name : 'Nombre del cliente' ,
        lastName : 'Apellido del cliente',
        email : 'Correo electrónico del cliente',
        identification : 'Identificación del cliente',
        identificationType : Tipo de identificación,
        sameData : 'Booleano que identifica si la información del usuario es la misma, haciendo que sea mas rapido el proceso de compra',
    });

Tipos de identificación que se pueden enviar en el widget

Metodos

Actualizar monto de la transacción

const checkout = new widgetCheckout({
                    ...InformacionDelComercio,
                    name : 'Nombre del cliente' ,
                    lastName : 'Apellido del cliente',
                    email : 'Correo electrónico del cliente',
                    identification : 'Identificación del cliente',
                    identificationType : Tipo de identificación,
                });

al definir la variable que inicializa el widget, vas a poder tener un metodo para actualizar. En este caso llamamos la variable checkout

checkout.updateAmount(10000)

¿Como obtener los datos para la implementación del widget?

1. Para obtener los datos, tendremos que ingresar a la consola de PaymentsWay, usted deber ingresar con su usuario y contraseña.



2. Estando en la consola, usted dará click en el botón "Botones de pago"



3. Seleccionara el botón de pago que haga referencia a su comercio y a la función que desea cumplir



4. Una vez seleccionado el botón de pago de su comercio, al instante se abrirá una ventana en la cual usted podrá encontrar la información completa de su botón.
• Ubicaremos en el código el espacio  <merchant_id>  y copiaremos lo que esta dentro de las comillas del  <value="70">  (El número a copiar será el cual le indique la información de su botón de pago ya creado) a nuestro script y lo pegaremos en  <merchant_id> 



• Ubicaremos en el código el espacio  <form_id>  y copiaremos lo que esta dentro de las comillas del  <value="123">  (El número a copiar será el cual le indique la información de su botón de pago ya creado) a nuestro script y lo pegaremos en  <form_id> 



• Ubicaremos en el código el espacio  <terminal_id>  y copiaremos lo que esta dentro de las comillas del  <value="103">  (El número a copiar será el cual le indique la información de su botón de pago ya creado) a nuestro script y lo pegaremos en  <terminal_id> 



• Para el  <order_number>  recomendamos implementar un algoritmo para crear el mismo, esto debido a que no puede haber dos order_number con el mismo nombre

generateRandomString = (num) => {
    const characters =
        'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
    let result1 = Math.random().toString(36).substring(num);
    return result1;
};

• Para el  amount  se pondra el monto a pagar segun requiera su comercio. (Tenga en cuenta que puede ser cambiado de acuerdo a su necesidad)
•  currency  Este hará referencia al tipo de moneda con la cual usted recibira el dinero de su comercio ("COP", "USD", "EUR").
• En  order_description  usted podra poner la descripción correspondiente a su comercio.
• Para obtener la información de su  apikey  usted se redireccionara a la parte del inicio de la consola, en donde encontrara un espacio unico con la información del apikey.

MODO DE USO

Una vez implementado el WIDGET a su comercio, usted lo podrá visualizar con un botón de la siguiente manera:

A continuación, le explicaremos el paso a paso de lo que vera al realizar pagos.

• Elegirá el método de pago por el cual se realizará la transacción.

¿Cómo crear una carta de pago?

Inicialmente, tienes que crear una terminal seguido de esto tienes que dirigirte a nuestro menú en donde buscaras un apartado llamado "Botones de pago". Una vez estés en la página. Selecciona el botón "Crear Botón de pago"

seleccionas después la opción "carta de pago" y podras crear tu carta de pago

¿Cómo usar una carta de pago?

Una vez creada la carta de pago, tendrás el listado de todas las cartas de pago y botones de pago que se hayan creado, podrás identificar que es una carta de pago de un botón de pago con el atributo de la tarjeta "Carta de pago". Podrás dar clic a la tarjeta y se abrirá un modal en el que puedes editar la carta de pago, adicional a esto hay dos botones 

• Copiar embebido: con este botón se copiará un código HTML para que puedas insertarlo en tu HTML.
• Copiar URL: Te copiará solamente la URL.

Introducción

A continuación, usted encontrará una guía con el paso a paso de como Incluir el plugin PaymentsWay con WooCommerce y lograr una integración satisfactoria con su Ecommerce. Ofrezca a sus clientes la posibilidad de generar pagos en línea de manera segura y confiable mediante la pasarela de pago PaymentsWay. Para mas información puede consultar: PaymentsWay

Moneda

Para el correcto uso del plugin, usted debe utilizar una de las siguientes monedas: COP, USD y EUR.

Requisitos

• Acceso a cuenta PaymentsWay
• Acceso a administrador wordpress

1. Para el correcto ACCESO a la consola de PaymentsWay, usted deber ingresar con su usuario y contraseña.
2. Acceso a administrador wordpress





3. Suba el plugin, Instale y active.



4. Diríjase al apartado de wordpress y seleccione ajustes.



5. Accedemos al apartado de pagos



6. Activamos PaymentsWay como pasarela de transacciones y guardamos cambios, una vez guardados los cambios Acedemos al apartado de configuración.



7. Ubique en configuración el campo obligatorio ID MERCHANT



• Ubique en la pasarela el campo obligatorio ID MERCHANT



8. Ubique en configuración el campo obligatorio ID TERMINAL



• Ubique en la pasarela el campo obligatorio ID TERMINAL



9. Ubique en configuración el campo obligatorio ID BOTON DE PAGO



• Ubique en la pasarela ID BOTON DE PAGO



10. Ubique en configuración el campo obligatorio APIKEY



• Ubique en la pasarela APIKEY



11. Ubique en configuración el campo obligatorio URL de retorno al ecommerce



12. Diríjase a su respectiva página de tienda.



13. Nos fijamos en la Url de nuestra tienda, tendran que copiar la URL completa de la página de destino



14. Por último, guardamos los cambios desde el administrador de wordpress

Introducción

A continuación, usted encontrará una guía con el paso a paso de como Incluir el plugin PaymentsWay con PrestaShop y lograr una integración satisfactoria con su Ecommerce. Ofrezca a sus clientes la posibilidad de generar pagos en línea de manera segura y confiable mediante la pasarela de pago PaymentsWay. Para mas información puede consultar: PaymentsWay

Moneda

Para el correcto uso del plugin, usted debe utilizar una de las siguientes monedas: COP, USD y EUR.

Requisitos

• Acceso a cuenta
• Acceso a administrador PrestaShop.

Instalación

Paso 1: Subir el Plugin

1. Navega hasta la sección "Módulos" y selecciona "Administrador de Módulos" en tu panel de Prestashop.

   

2. Haz clic en "Subir un módulo" y elige el archivo .zip del plugin Payments Way.
3. Una vez cargado el archivo, espera a que el proceso de instalación se complete automáticamente.

Paso 2: Configuración de la Pasarela de Pagos

1. En el mismo panel de Módulos, localiza el plugin Payments Way y selecciona "Configurar".

   

2. Ingresa las claves de acceso y demás información requerida para la pasarela de pagos en los campos correspondientes.

   

3. Verifica que todos los datos sean correctos y, a continuación, haz clic en "Guardar" para aplicar los cambios.

Paso 3: Ajuste de Preferencias de Pago

1. Dirígete a "Pagos" y luego a "Preferencias" en el menú principal de Prestashop.

   

2. Dentro de Preferencias, ajusta todas las opciones relacionadas con los pagos, incluyendo restricciones por moneda, grupos de usuarios, países y transportadoras.
   

   

3. Después de configurar cada opción, asegúrate de guardar los cambios para que se apliquen correctamente.

Introducción

POST Crear link de pago con redirección

      https://merchant.paymentsway.co/link-de-pago/create

Headers

Para consumir el servicio "" necesitaremos en el   header   de la petición su   Api_key  

Parametrización

Cuerpo de la petición

{
    "form_id" : "",
    "terminal_id" :  "" ,
    "order_number" : "ORD-456789",
    "amount" : 55000,
    "currency" : "COP",
    "merchant_id" : 7890,
    "order_description" : "Compra de productos",
    "client_email" : "cliente@example.com",
    "client_phone" : "5555555555",
    "client_firstname" : "Juan",
    "client_lastname" : "Pérez",
    "client_numdoc" : "123456789",
    "response_url" : "https://example.com/response",
    "additional_data" : {
        "CualquierCosa" : "ValorAleatorio"
    }
    }
    

Ejemplo de la petición

    var myHeaders =  new  Headers();
    myHeaders.append ("Authorization", "Api_key");

    var  requestOptions = {
    method: 'POST',
    headers: myHeaders,
    redirect: 'follow'
    };

    fetch("https://merchant.paymentsway.co/link-de-pago/create", requestOptions)
    .then(response => response.text())
    .then(result => console.log(result))
    .catch(error => console.log('error', error));

Errores

Si la petición presenta algún error, el API retornará un status 400 con el siguiente formato json

    {
        "error" : true ,
        "data" : "",
    }
    

POST Crear link de pago

      https://merchant.paymentsway.co/cartaspago/returnUrl

Headers

Para consumir el servicio "" necesitaremos en el   header   de la petición su   Api_key  

Parametrización

Cuerpo de la petición

{
    "form_id" : "",
    "terminal_id" :  "" ,
    "order_number" : "ORD-456789",
    "amount" : 55000,
    "currency" : "COP",
    "merchant_id" : 7890,
    "order_description" : "Compra de productos",
    "client_email" : "cliente@example.com",
    "client_phone" : "5555555555",
    "client_firstname" : "Juan",
    "client_lastname" : "Pérez",
    "client_numdoc" : "123456789",
    "response_url" : "https://example.com/response",
    "additional_data" : {
        "CualquierCosa" : "ValorAleatorio"
    }
    }
    

Ejemplo de la petición

    var myHeaders =  new  Headers();
    myHeaders.append ("Authorization", "Api_key");

    var  requestOptions = {
    method: 'POST',
    headers: myHeaders,
    redirect: 'follow'
    };

    fetch("https://merchant.paymentsway.co/link-de-pago/create", requestOptions)
    .then(response => response.text())
    .then(result => console.log(result))
    .catch(error => console.log('error', error));

Errores

Si la petición presenta algún error, el API retornará un status 400 con el siguiente formato json

    {
        "error" : true ,
        "data" : "",
    }
    

Checksum

Para garantizar la integridad de los datos enviados y recibidos en las transacciones, le recomendamos el uso de un checksum. este checksum se puede utilizar en la api de link de pago y link de pago redirección

El checksum se genera a partir de los siguientes datos:

• idForm
• apikey
• idMerchant
• amount
• externalOrder

La generación del checksum se realiza con el algoritmo sha256

Ejemplo de uso

const createChecksum = (idForm, idMerchant, apikey, amount, externalOrder) =>
sha256(`${idForm};${apikey};${idMerchant};${amount};${externalOrder}`).toString();

const result = createChecksum(
    '1',
    '2',
    'YzZhNj0NjM1YzRhNWE5NmAS0sa2Sg=',
    '1',
    '1'
);

console.log(result);
                

GET Obtener Tipos Identificación

  https://serviceregister.paymentsway.co/ClientAPI/ObtenerTiposIdentificacion

Headers

Para consumir el servicio "obtener tipos identificación" necesitaremos en el   header   de la petición su   Api_key  

Ejemplo de la petición

var myHeaders =  new  Headers();
myHeaders.append ("Authorization", "Api_key");

var  requestOptions = {
  method: 'GET',
  headers: myHeaders,
  redirect: 'follow'
};

fetch("https://serviceregister.paymentsway.co/ClientAPI/ObtenerTiposIdentificacion", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

GET Obtener Tipos de estados

  https://serviceregister.paymentsway.co/ClientAPI/GetAllTransactionStatuses

Headers

Para consumir el servicio "obtener tipos de respuestas" necesitaremos en el   header   de la petición su   Api_key  

Ejemplo de la petición

var myHeaders =  new  Headers();
myHeaders.append ("Authorization", "Api_key");

var  requestOptions = {
  method: 'GET',
  headers: myHeaders,
  redirect: 'follow'
};

fetch("https://serviceregister.paymentsway.co/ClientAPI/GetAllTransactionStatuses", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

POST Crear Persona

 https://serviceregister.paymentsway.co/ClientAPI/CrearPersona

Parametrización

Ejemplo de la petición

var myHeaders =  new  Headers();
myHeaders.append ("x-api-key", "Api_key");

var cuerpo = {
    {
        "firstname" : "Nombre",
        "lastname" : "Apellidos",
        "ididentificationtype" : "4",
        "identification" : "10000000",
        "email" : "correo@Prueba.com",
        "phone" : "30900000",
        "state" : "",
        "city" : "",
        "address" : "",
        "zipcode" : "",
    }
}

var  requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: cuerpo
  redirect: 'follow'
};

fetch("https://serviceregister.paymentsway.co/ClientAPI/CrearPersona", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

Posibles estados

200 || 500

GET Obtener Transacción

  https://serviceregister.paymentsway.co/ClientAPI/ObtenerTransaccionByExternalOrder?external_order=asdasda-a26f-4153-9c6e-ff242d752b02

Headers

Para consumir el servicio "obtener transacción" necesitaremos en el   header   de la petición su   Api_key  

Ejemplo de la petición

var myHeaders =  new  Headers();
myHeaders.append ("Authorization", "Api_key");

var  requestOptions = {
  method: 'GET',
  headers: myHeaders,
  redirect: 'follow'
};

fetch("https://serviceregister.paymentsway.co/ClientAPI/ObtenerTransaccionByExternalOrder?external_order=(external order)", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

POST Obtener Persona Por Documento

 https://serviceregister.paymentsway.co/ClientAPI/ObtenerPersonaPorDocumento

Headers

Para consumir el servicio de "obtener persona por documento" necesitaremos en el   header   de la petición su   Api_key  

Parametrización

Cuerpo de la peticion

Para consumir el servicio "obtener persona por documento" en el   body   de la petición colocara los siguientes datos:

{
        "nroDocumento" : 1012427594,
}

Ejemplo de la petición

var myHeaders =  new  Headers();
myHeaders.append ("x-api-key", "Api_key");

var cuerpo = {
    "nroDocumento" : 1012427594,
}

var  requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: cuerpo
  redirect: 'follow'
};

fetch("https://serviceregister.paymentsway.co/ClientAPI/ObtenerPersonaPorDocumento", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

POST Crear Transaccion Tarjeta de Crédito

 https://serviceregister.paymentsway.co/ClientAPI/CrearTransaccionTC

Headers

Para consumir el servicio de "crear transacción tarjeta de crédito" necesitaremos en el   header   de la petición su   Api_key  

Parametrización

Cuerpo de la peticion

Para consumir el servicio "crear transacción tarjeta de credito" en el   body   de la petición colocara los siguientes datos:

{
        "amount" : 300000,
        "firstname" : "",
        "lastname" : "",
        "card_identification" : "",
        "identification_type" : 4,
        "card_holder" : "PEPITO PEREZ PA",
        "card_pan" : "411111111111",
        "card_expiry_year" : "26",
        "card_expiry_month" : "06",
        "card_cvv" : "123",
        "url_ok" : "https://mysite.com/payment/success",
        "url_ko" : "https://mysite.com/payment/error",
        "description" : "order's description test",
        "installments" : 3,
        "external_order" : "trc231566" ,
        "dynamic_descriptor" : "Prueba PayLands",
        "terminal_id" : 34,
        "form_id" : 34,
        "ip" : "192.168.0.1",
        "additionalData" : {
            "CualquierCosa" : "Cualquiecosa"   
        },
        "autorizacionDatos" : true
}

Ejemplo de la petición

var myHeaders =  new  Headers();
myHeaders.append ("x-api-key", "Api_key");

var cuerpo = {
    "amount" : 300000,
    "firstname" : "",
    "lastname" : "",
    "card_identification" : "",
    "identification_type" : 4,
    "card_holder" : "PEPITO PEREZ PA",
    "card_pan" : "411111111111",
    "card_expiry_year" : "26",
    "card_expiry_month" : "06",
    "card_cvv" : "123",
    "url_ok" : "https://mysite.com/payment/success",
    "url_ko" : "https://mysite.com/payment/error",
    "description" : "order's description test",
    "installments" : 3,
    "external_order" : "trc231566" ,
    "dynamic_descriptor" : "Prueba PayLands",
    "terminal_id" : 34,
    "form_id" : 34,
    "ip" : "192.168.0.1",
    "additionalData" : {
        "CualquierCosa" : "Cualquiecosa"   
    },
    "autorizacionDatos" : true
}

var  requestOptions = {
    method: 'POST',
    headers: myHeaders,
    body: cuerpo
    redirect: 'follow'
};

fetch("https://serviceregister.paymentsway.co/ClientAPI/CrearTransaccionTC", requestOptions)
    .then(response => response.text())
    .then(result => console.log(result))
    .catch(error => console.log('error', error));

POST Reversar Transaccion

 https://serviceregister.paymentsway.co/ClientAPI/ReversarTransaccion

idTransaction, Identificador de la transaccion de PaymentsWay, se obtiene al recibir la respuesta de "Crear Transaccion tarjeta de credito"

Headers

Para consumir el servicio de "reversar transacción" necesitaremos en el   header   de la petición su   Api_key  

Parametrización

Cuerpo de la peticion

Para consumir el servicio "reversar transacción" en el   body   de la petición colocara el siguiente dato

{
        "idTransaction" : 1360,
}

Ejemplo de la petición

var myHeaders =  new  Headers();
myHeaders.append ("Authorization", "Api_key");
 
var cuerpo = {
    "idTransaction" : 1360,
}

var  requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: cuerpo
  redirect: 'follow'
};

fetch("https://serviceregister.paymentsway.co/ClientAPI/ReversarTransaccion", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

Para poder tokenizar una tarjeta de crédito primero debes crear una persona, al crear la persona te retorna un ID este deberás pasarlo al siguiente endpoint.

POST Tokenizar Persona

 https://serviceregister.paymentsway.co/ClientAPI/TokenizarDatosPersona

Headers

Para consumir el servicio necesitaremos en el   header   de la petición su   Api_key  

Parametrización

Cuerpo de la peticion

{
                    "documento" : "10000000",
                    "identification_type" : 4,
                    "idperson" : 8,
                    "url" : "url.com",
                    "form_id" : 368,
                    "amount" : "100",
                    "external_order" : "Test_02",
                    "ip" : "127.0.0.1",
                    "additionalData" : "",
                    "currencycode" : "COP",
                    "description" : "Some Desc",
                    "installments" : 1
}

Ejemplo de la petición

var myHeaders =  new  Headers();
myHeaders.append ("Authorization", "Api_key");
 
var cuerpo = {
    "documento" : "10000000",
    "identification_type" : 4,
    "idperson" : 8,
    "url" : "url.com",
    "form_id" : 368,
    "amount" : "100",
    "external_order" : "Test_02",
    "ip" : "127.0.0.1",
    "additionalData" : "",
    "currencycode" : "COP",
    "description" : "Some Desc",
    "installments" : 1
}

var  requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: cuerpo
  redirect: 'follow'
};

fetch("https://serviceregister.paymentsway.co/ClientAPI/TokenizarDatosPersona", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

Integracion del emebed

Una vez enviada la petición te retornará un objeto que tiene dentro un "data", tendrás que copiar el token generado en donde tendrás que concatenar la variable en la siguiente URL: "https://merchant.paymentsway.co/tokenizacion/?p=" un código de ejemplo de como podrías hacerlo:

<body	>
    <embed id="embed"  type="" width="500px" height="320px"	>
    </body	>
    <script defer>
        const token = 'El token generado'
        document.getElementById('embed').src = `https://merchant.paymentsway.co/tokenizacion/?p=${token}`
    </script>
                  

Cuando el usuario realice la transacción se podra acceder a una varibale llamada finishTransaction en   true   esta inicialmente no estara definida a menos que el integrado la asigne como un   let   en   false  

Transacciones aprobadas

Cuando una transacción es aprobada podrá identificarla con los siguientes códigos o con las siguientes descripciones

Transacciones declinadas

Cuando una transacción es declinada podrá identificarla con los siguientes códigos o con las siguientes descripciones

GET Obtener Listado de Bancos

 https://serviceregister.paymentsway.co/ClientAPI/ObtenerListadoBancos

Ejemplo de la petición

var myHeaders =  new  Headers();
myHeaders.append ("Authorization", );

var  requestOptions = {
    method: 'GET',
    headers: myHeaders,
    redirect: 'follow'
};

fetch("https://serviceregister.paymentsway.co/ClientAPI/ObtenerListadoBancos", requestOptions)
    .then(response => response.text())
    .then(result => console.log(result))
    .catch(error => console.log('error', error));

POST Crear Transacción PSE

 https://serviceregister.paymentsway.co/ClientAPI/CrearTransaccionPSE

Headers

Para consumir el servicio de "crear transacción PSE" necesitaremos en el   header   de la petición su   Api_key  

Parametrización

Cuerpo de la petición

Para consumir el servicio "crear transacción PSE" en el   body   de la petición colocara los siguientes datos:

{
        "amount" : 30000,
        "PersonType" : "0",
        "identification_type" : 4,
        "Documento" : "",
        "Correo" : "",
        "Nombres" : "Ana",
        "Apellidos" : "Perez",
        "Celular" : 3167225855,
        "Direccion" : "Calle 32 # 74 -31",
        "external_order" : "26",
        "CodigoBanco" : "10512",
        "NombreBanco" : "BANCO DAVIVIENDA",
        "entityurl" : "https://mysite.com/payment/success",
        "terminal_id" : 34
        "form_id" : 34
        "ip" : "192.168.0.1"
        "additionalData" : {
            "CualquierCosa" : "CualquierCosa"
        }
}

Ejemplo de la petición

var myHeaders =  new  Headers();
myHeaders.append ("x-api-key", "Api_key");

var cuerpo = {
    "amount" : 30000,
    "PersonType" : "0",
    "identification_type" : 4,
    "Documento" : "",
    "Correo" : "",
    "Nombres" : "Ana",
    "Apellidos" : "Perez",
    "Celular" : 3167225855,
    "Direccion" : "Calle 32 # 74 -31",
    "external_order" : "26",
    "CodigoBanco" : "10512",
    "NombreBanco" : "BANCO DAVIVIENDA",
    "entityurl" : "https://mysite.com/payment/success",
    "terminal_id" : 34
    "form_id" : 34
    "ip" : "192.168.0.1"
    "additionalData" : {
        "CualquierCosa" : "CualquierCosa"
    }
}

var  requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: cuerpo
  redirect: 'follow'
};

fetch("https://serviceregister.paymentsway.co/ClientAPI/CrearTransaccionPSE", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

GET Obtener Medios De Pago

  https://serviceregister.paymentsway.co/ClientAPI/ObtenerMediosDePago

Headers

Para consumir el servicio "obtener los medios de pago" necesitaremos en el   header   de la petición su   Api_key  

Ejemplo de la petición

var myHeaders =  new  Headers();
myHeaders.append ("Authorization", "Api_key");

var  requestOptions = {
    method: 'GET',
    headers: myHeaders,
    redirect: 'follow'
};

fetch("https://serviceregister.paymentsway.co/ClientAPI/ObtenerMediosDePago", requestOptions)
    .then(response => response.text())
    .then(result => console.log(result))
    .catch(error => console.log('error', error));

POST Crear Transaccion Cash

 https://serviceregister.paymentsway.co/ClientAPI/CrearTransaccionCash

Headers

Para consumir el servicio de "crear transacción PSE" necesitaremos en el   header   de la petición su   Api_key  

Parametrización

Cuerpo de la peticion

Para consumir el servicio "crear transacción PSE" en el   body   de la petición colocara los siguientes datos:

{
    "amount" : 30000,
    "external_order" : 26,
    "description" : "any description test",
    "method" : "efecty",
    "iva" : 0,
    "user_identificatio" : "",
    "identification_type" : "CC",
    "user_name" : "Andres Camil",
    "user_last_name" : "Perez",
    "user_email" : "andres.ochoa0@gmail.com",
    "user_phone" : "3227358312",
    "user_address" : "cra 8b 17 15",
    "terminal_id" : 34,
    "form_id" : 34
    "ip" : "192.168.0.1"
    "additionalData" : {
        "CualquierCosa" : "CualquierCosa"
    }
}

Ejemplo de la petición

var myHeaders =  new  Headers();
myHeaders.append ("x-api-key", "Api_key");

var cuerpo = {
    "amount" : 30000,
    "external_order" : 26,
    "description" : "any description test",
    "method" : "efecty",
    "iva" : 0,
    "user_identificatio" : "",
    "identification_type" : "CC",
    "user_name" : "Andres Camil",
    "user_last_name" : "Perez",
    "user_email" : "andres.ochoa0@gmail.com",
    "user_phone" : "3227358312",
    "user_address" : "cra 8b 17 15",
    "terminal_id" : 34,
    "form_id" : 34
    "ip" : "192.168.0.1"
    "additionalData" : {
        "CualquierCosa" : "CualquierCosa"
    }
}

var  requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: cuerpo
  redirect: 'follow'
};

fetch("https://serviceregister.paymentsway.co/ClientAPI/CrearTransaccionCash", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

POST WebHook

EL WEBHOOK de notificaciones es el entorno que permite recibir la información de la notificación de la transacción y su estado. Este es un método de llamado asincrónico de tipo REST que recibe como parámetro de entrada un JSON que contiene el estado de ejecución de la transacción. La página de notificación permite actualizar las bases de datos de tu sistema; por esto, no debe incluir código HTML ya que nunca será visible al comprador. Cuando una transacción finaliza, es decir cuando es aprobada ,rechazada, cancelada o en espera (efectivo), nuestra plataforma envía las variables por medio del método HTTP POST.

Los posibles valores de status son:

 1 "Creada"
34 "Exitosa"
35 "Pendiente"
36 "Fallida"
38 "Cancelada"
39 "Reembolsada"
40 "Pendiente efectivo"

Como responder al webhook

Para el correcto uso del webhook tienes que enviar un status 200 únicamente cuando el estado de la transacción es exitosa (id 34) para el resto de estados debe ser respondido con un status 201

Campos que se envian en el WebHook

Ejemplo del body

{
    "id" : Identificador interno,
    "amount" : Valor de la transaccion,
    "externalorder" : Identificador externo,
    "ip" : Ip del usuario pagador,
    "fullname" : nombres del pagador,
    "additionaldata" : Informacion adicional,
    "idstatus" : Datos del estado de la transaccion
        {
            "id" : Identificador de estado
            "nombre" : Nombre del estado
        }
    "idperson" : Datos del pagador
    {
        "id" : Identificador
        "firstname" : Nombres
        "lastname" : Apellidos
        "identification" : Numero de documento
        "email" : Correo electronico
        "phone" : Numero de telefono
    }
    "paymentmethod" : {
        "id" : id del metodo de pago
        "nombre" : Nombre del metodo de pago
    }
    "idmerchant" : Id merchant
}

{
    "id" : "822",
    "ammount" : 4000,
    "externalorder" : "12001",
    "ip" : "172.0.0.1",
    "fullname" : "",
    "additionaldata" : null,
    "idstatus" : 
        {
            "id" : 34
            "nombre" : "Exitosa"
        }
    "idperson" : 
    {
        "id" : "60"
        "firstname" : "Ejemplo nombre"
        "lastname" : "Ejemplo apellido"
        "identification" : "1200345601"
        "email" : ""
        "phone" : ""
    }
    "paymentmethod" :  {
        "id" : 2
        "nombre" : "PSE"
    }
    "idmerchant" : "1"
}

                {
                    "id": 'id',
                    "amount": 100,
                    "externalorder": 'external',
                    "ip": '127.0.0.1',
                    "fullname": '',
                    "jsonresponse": '{"MESSAGE":"Información obtenida correctamente.","STATUS":true,"ID":"id","CODE":"code","PRICE":100,"DATA":{"returnCode":"SUCCESS","errorDetails":null,"trazabilityCode":"9999","ticketId":"ticketid","entityCode":"entity","financialInstitutionCode":"1","serviceCode":"1","transactionValue":"100.0","vatValue":"0.0","soliciteDate":"2023-09-18T00:00:00","bankProcessDate":"2023-09-18T14:33:43.117","transactionCycle":"4","transactionState":"NOT_AUTHORIZED","authorizationID":"00001","serviceNIT":"1","serviceName":"Nombre","userType":"person","paymentDescription":"","referenceNumber1":"","referenceNumber2":"CedulaDeCiudadania","referenceNumber3":"999","paymentOrigin":"3","paymentMode":"15","identificationType":"CedulaDeCiudadania","identificationNumber":"999","fullName":"nombre","cellphoneNumber":"","address":"kr","email":"email"}}',
                    "innerexception": { codigo: '00001', causal: 'CUENTA NO EXISTE' },
                    "additionaldata": {},
                    "idstatus": { "id": 36, "nombre": 'Fallida' },
                    "idperson": {
                        "id": '',
                        "firstname": '',
                        "lastname": '',
                        "identification": '',
                        "email": '',
                        "phone": ''
                    },
                    "paymentmethod": Services { id: 2, nombre: 'PSE' },
                    "idsubscripcion": null,
                    "idmerchant": ''
                }
                

Botón de pago

Una vez seleccionado el botón de “Crear botón de pago”, diligenciaremos el formulario.

• Ingrese el nombre del botón de pago, el cual hará referencia al comercio ya inscrito.



• Seleccione la terminal la cual hace referencia a su comercio (Una vez usted realice su registro y le sean enviadas las credenciales de ingreso PaymentsWay, La terminal será creada de manera automática).



• Usted podrá elegir si el botón de pago será “Test” o “Producción” (Cuando lo desee usted podrá cambiar el re direccionamiento del botón)



• Elija los medios de pagos que se ajusten a su comercio.
• Una vez seleccionados los medios de pagos, Creamos el Botón de pago.

Botón de pago Abiertos

Con PaymentsWay usted tiene la posibilidad de crear un botón de pagos abiertos. Una vez seleccionado el botón de “Crear botón de pago”, diligenciará el formulario.

• Ingrese el nombre del botón de pago, el cual hará referencia al comercio ya inscrito.



• Seleccione la terminal la cual hace referencia a su comercio (Una vez usted realice su registro y le sean enviadas las credenciales de ingreso PaymentsWay, La terminal será creada de manera automática).



• Selecciona la opción “Botón de pago Abierto”.



• Usted podrá elegir si el botón de pago será “Test” o “Producción” (Cuando lo desee usted podrá cambiar el re direccionamiento del botón).



• Elija los medios de pagos que se ajusten a su comercio.
• Una vez seleccionados los medios de pagos, Creamos el Botón de pago.

PayOuts

PayOuts Service proporciona los servicios de necesarios para realizar la carga de una dispersión, descarga del archivo para envío al banco y cargar la respuesta del banco, además proporciona un servicio de login que otorgara el token necesario para el consumo de los demás servicios. La especificación de este servicio, se puede encontrar en la siguiente dirección:

English

Español