API Pagos - Autorización

API Pagos - Autorización

Consideraciones

Se debe haber creado una Orden de pago previamente para poder realizar un cobro por API V2

Endpoints 

Para invocar el Api de pagos se debe considerar lo siguiente

  1. Utilizar el servicio en los endpoints: 

Info
Ambiente de desarrollo o sandbox: https://checkoutv2.greenpaysbx.me                   

IdeaAmbiente productivo: https://checkoutv2.greenpay.me                                        

2. Tener los valores de session y token de una orden de pago, que se ha creado en el paso previo y que no haya excedido los 30 minutos establecidos para el vencimiento.


Pasos para el uso del servicio


1. Incluir el Data Collector (En su frontend)

Visite la sección  DataCollector Antifraude

Info
Solo aplica si usará el servicio de antifraude de transacciones que facilita GreenPay

Info
El datacollector solo funciona en aplicaciones web                                                        


2. Estructura de los datos

 Crear Objeto JSON para los datos de la tarjeta

El objeto JSON con los datos de la tarjeta debe tener la siguiente estructura:


  1. {
  2.     card: {
  3.          cardHolder: "John Doe",
  4.          expirationDate:  {
  5.               month:   "12",
  6.                year:   "31",
  7.          },
  8.         cardNumber: "5597270000001815",
  9.         cvc: "196",
  10. },
  11. additional:   {  channelData:    {   channel:  "01",   source:   "API_CARD"  }   },
  12. kountSession: "58218d22a34f42cda041789b3abc9d50", // Antifraud value

Info
Datos obligatorios                                                                                                                                       
  • card.cardHolder: String. Nombre del dueño de la tarjeta. De 5 a 50 caracteres. 
  • card.expirationDate.month: String. Número que indica el mes de vencimiento de la tarjeta, este parámetro debe tener cifras entre 1 y 12.
  • card.expirationDate.year: String. Número que indica el año de vencimiento de la tarjeta, este parámetro debe tener cifras de 2 dígitos, los últimos 2 dígitos del año en que vence la tarjeta.
  • card.cardNumber: String. Corresponde al número de la tarjeta
  • card.cvc : String. Código de seguridad de la tarjeta.
  • additional: Object. Debe ser la misma estructura del ejemplo, requerido por GreenPay
  • kountSession: String. Es el valor params.MercSessId que se obtienen del Data Collector.
InfokountSession es requerido si utilizará el antifraude y si sus sistemas son aplicaciones web (a la hora de realizar un pago) para correr el script

3. Cifrar el objeto tipo JSON que contiene la información de la tarjeta

Por razones de seguridad, tanto para GreenPay como para proteger las transacciones de su comercio, se requiere que la información de la tarjeta o el token se envíe de forma segura, utilizando conexión segura TLS 1.2.  Y cómo un método extra de seguridad, la información de la tarjeta se debe enviar codificada en base64.

En BITBUCKET podrá encontrar ejemplos de integración desarrollados en NodeJS.
A continuación, se muestran los pasos a seguir para cifrar la información de la tarjeta.
 
  • Utilizando Javascript
const cardData = {
  card: {
    cardHolder: "Angel Gonzalez",
    expirationDate: {
      month: "03",
      year: "25",
    },
    cardNumber: "5597270000001815",
    cvc: "196",
  },
  additional: { channelData: { channel: "01", source: "API_CARD" } },
  kountSession: "58218d22a34f42cda041789b3abc9d50",
};

const base64 = Buffer.from(JSON.stringify(cardData)).toString("base64");

console.log(base64);




Info

Donde eyJjYXJkIjp7ImNhcmRIb2xkZXIiOiJBbmdlbCBHb256YWxleiIsImV4cGlyYXRpb25EYXRlIjp7Im1vbnRoIjoiMDMiLCJ5ZWFyIjoiMjUifSwiY2FyZE51bWJlciI6IjU1OTcyNzAwMDAwMDE4MTUiLCJjdmMiOiIxOTYifSwiYWRkaXRpb25hbCI6eyJjaGFubmVsRGF0YSI6eyJjaGFubmVsIjoiMDEiLCJzb3VyY2UiOiJBUElfQ0FSRCJ9fSwia291bnRTZXNzaW9uIjoiNTgyMThkMjJhMzRmNDJjZGEwNDE3ODliM2FiYzlkNTAifQ== es el resultado que se necesitará



4. Crear un objeto de tipo JSON con los datos cifrados anteriormente.

Se debe crear un objeto de tipo JSON que contenga los resultados del proceso de cifrado anterior (ed) y la sesión obtenida en el artículo "Crear una orden de pago", este JSON debe estar estructurado de la siguiente forma:

 

Ejemplo del JSON con la estructura de los datos cifrados

  1. {
  2. "session": "sesión obtenida en 1. Crear Orden de pago",
  3. "ed": "datos de la tarjeta cifrados en formato base64"
  4. }

 

Valores del JSON:

  1. session: String con el valor de la session obtenida de la respuesta del envío de una solicitud de orden de pago  Crear Orden de Pago

       2. ed: String en formato base64 que se obtiene al cifrar los datos de la tarjeta.


5.  Enviar la solicitud de pago.

POSTMAN COLLECTION




Se debe enviar una solicitud HTTP de tipo POST al endpoint de pagos con el objeto JSON que contiene los datos cifrados y la sesión obtenida en el paso anterior, este JSON se envía en el cuerpo de la solicitud.

A esta solicitud se le debe agregar el header session-token, este header debe contener el token obtenido en la solicitud de creación de una orden de pago.  Puede ver el siguiente ejemplo 


Notes
Una vez se ha enviado la solicitud de pago y esta se haya realizado con éxito, se obtiene un objeto de tipo JSON como respuesta.




Respuesta autorización exitosa


Info
La autorización exitosa responde con un HTTP Code 200



  1. {
  2.       "status": 200,
  3.        "orderId": "compra-2024-10-23-USD-265",
  4.        "authorization": "445000",
  5.        "amount": 302,
  6.        "currency": "USD",
  7.        "token": "0c86cae0-917b-11ef-8500-27f1ad691f71",
  8.         "internalRef": 10819032514292,
  9.         "transactionId": "beb386d4-0595-49b1-a7a9-e23876cf0b97",
  10.          "errors": [],
  11.          "last4": "1815",
  12.          "brand": "Mastercard",
  13.          "statusCode": 200
  14. }

Respuesta autorización fallida

AlertLa autorización fallida responde con un HTTP Code 400 o 500


  1. {
  2.        "message": "terminal not found",
  3.        "status": "fail"
  4. }

Con la respuesta obtenida, el comercio deberá actualizar la compra de la transacción respectiva


    • Related Articles

    • API Pagos - Autorización con Token

      Consideraciones Se debe haber creado una orden de pago previamente para poder realizar un cobro por API V2 1. Autorización con Token Consideraciones Para utilizar el API de pago con Token se debe considerar lo siguiente: Se debe haber tokenizado una ...

    • API Pagos V2 Webhook

      Autorizacion respuesta webhook En este apartado encontrá información acerca de la respuesta del webhook de una autorizacion Si su webhook configurado es el siguiente https://mywebhook.com/ la respuesta de la autorización por API llegará a esa url ...

    • Tokenizacion API V2 webhook

      En este apartado encontrará información acerca de la respuesta del webhook para tokenización por API V2 de GreenPay Si su webhook configurado es el siguiente https://mywebhook.com/ la respuesta de la tokenizacion por API llegará a la url ...

    • Tokenización con API V2

      Consideraciones Para utilizar el API de tokenización de tarjetas se debe considerar lo siguiente: El API para crear una orden de tokenización está disponible en: Sandbox: https://tokenization.greenpaysbx.me/tokenizeOrder Producción: ...

    • Webhook V2

      En este apartado encontrará información para poder recibir la respuesta de los diferentes flujos de pago/tokenización con los que cuenta GreenPay en su versión 2 API Pagos V2 Webhook Tokenizacion V2 Webhook Checkoutform webhook 1. Descripción Si el ...