Generalidades

Términos y definiciones

• Sistema — la pasarela de pagos de TipTop Pay.
• Comercio — el cliente de TipTop Pay que usa el Sistema.
  
• Panel de control — el panel de control del Comercio en el sistema situado en merchant.tiptoppay.mx
• Tarjeta — la tarjeta bancaria de los sistemas de pago Visa, MasterCard, American Express or Carnet.
• Adquirente — el banco de pago.
  
• Emisor — el banco emisor de la tarjeta.
• Titular de la tarjeta — el propietario de la tarjeta emitida por un banco.
• Widget — el formulario de pago utilizado por el sistema para la introducción de los datos de la tarjeta por su titular y la autorización del pago posterior.
• 3-D Secure — el protocolo de verificación del titular por el emisor.
  

Tipos de transacciones

El sistema incluye dos tipos de operaciones: el pago y el reembolso. En el primero de los casos, el dinero se transfiere de la cuenta del titular a la del Comercio, en el segundo – al revés. El Comercio realiza el reembolso si el comprador quiere devolver la mercancía, siempre está asociado a la transacción de pago, cuyo importe se le devuelve al titular. Es posible hacer el reembolso de la totalidad del importe de pago o de su parte. Habitualmente el dinero vuelve a la tarjeta del titular el mismo día, pero en algunos casos (dependiendo del emisor) puede tardar hasta 3 días.

Métodos de pago

Existen los siguientes métodos de pago:

• Por medio de formulario de pago o widget. Añade un script para abrir un formulario de pago seguro (iframe) para introducir los datos de la tarjeta.

3-D Secure

3-D Secure es un nombre común de los programas del Codigo Seguro Verificado por Visa y MasterCard. En líneas generales, esos programas realizan la autentificación del titular de la tarjeta (para protegerle del uso no autorizado de su tarjeta) de cualquier emisor antes del pago. Actualmente funciona de la siguiente manera: el titular de la tarjeta introduce los datos de su tarjeta. Hecho eso, se abre el sitio web del emisor para que el titular de la tarjeta introduzca una contraseña o un código secreto (habitualmente, es un código enviado en forma de un mensaje de texto corto). Si el código es correcto, el pago se efectúa exitosamente. En el caso contrario se rechaza.

Plugins para CMS

WooCommerce

Todas las versiones son compatibles.

Las instrucciones para la instalación se encuentran en el archivo.

PrestaShop

Versiones actualmente compatibles – 1.7 o posterior.

Por favor, contacte [email protected] para obtener ayuda con la instalación del plugin para este CMS.

Magento

Versiones actualmente compatibles – 2.0 o posterior.

Por favor, contacte [email protected] para obtener ayuda con la instalación del plugin para este CMS.

Ecwid / Lightspeed E-Series

Por favor, contacte [email protected] para obtener ayuda con la instalación del plugin para este CMS.

Widget de pago

El Widget de pago es un formulario emergente para la introducción de los datos de la tarjeta y del correo electrónico del pagador. El widget determina automáticamente el tipo del sistema de pago: Visa, MasterCard, American Express o Carnet, el banco emisor de la tarjeta y los logos correspondientes. El formulario está optimizado para su uso con cualesquiera navegadores y dispositivos móviles. Dentro del widget se abre un iframe que garantiza la seguridad de los datos de la tarjeta enviados y no requiere ninguna certificación para su uso por el Comercio.

Instalación del widget

Para instalar el widget necesitarás añadir un script a la parte de head de tu sitio web:

<script src="https://widget.tiptoppay.mx/bundles/widget.js"></script>

Define una función para escoger entre los métodos charge a la hora de activar el formulario de pago:

this.pay = function () {
    var widget = new tiptop.Widget();
    widget.pay('charge',
        { //options
            publicId: 'test_api_00000000000000000000001',  //id of site (from panel de control)
            description: 'Payment example (no real withdrawal)', // purpose/justification/description
            amount: 10,
            currency: 'MXN',
            accountId: '[email protected]', //customer's/user's/payer's ID (optional)
            invoiceId: '1234567', // order number  (optional)
            data: {
                myProp: 'myProp value' //arbitrary set of parameters
            }
        },
        {
            onSuccess: function (options) { // success
                //action upon successful payment
            },
            onFail: function (reason, options) { // fail
                //action upon unsuccessful payment
            },
            onComplete: function (paymentResult, options) { //It is called as soon as the widget receives a response from api.tiptoppay with the result of the transaction.
                //e.x. calling your Facebook Pixel analytics
            }         
        }
    )
};    

La función se activará por un evento, por ejemplo, cuando se hace el click en el botón «Pagar»:

$('#checkout').click(pay);

Parámetros

Activando la función charge defines el esquema de pago:

• charge corresponde al esquema de una sola fase

Puedes definir el comportamiento del formulario en el caso de pagos exitoso y no exitoso utilizando los siguientes parámetros:

Localización de widget

Por defecto el widget está en español. Para localizar el widget necesitarás añadir el parámetro language:

var widget = new tiptop.Widget({language: "es-ES"});

Lista de lenguas disponibles:

Checkout

DEMO CHECKOUT

Para las pruebas se pueden utilizar tanto datos reales como datos ficticios de tarjetas. No se realizará ningún cargo de fondos.

REQUERIMIENTOS

REQUERIMIENTOS PARA EL FORMULARIO:

• Debe funcionar a través de una conexión HTTPS con un certificado SSL válido.
• Los campos no deben contener el atributo "name" — esto evita que los datos de la tarjeta se transmitan al servidor al enviar el formulario.
• El campo para ingresar el número de tarjeta debe permitir entre 16 y 19 dígitos.

REQUERIMIENTOS PARA EL CRIPTOGRAMA:

• Debe ser generado únicamente por el script original checkout, cargado desde las direcciones del sistema.
• El criptograma no puede guardarse después del pago y no puede reutilizarse.

REQUERIMIENTOS DE SEGURIDAD SEGÚN EL ESTANDAR PCI DSS:

Según el estandar PCI DSS, este método de conexión se clasifica como "E-commerce merchants who outsource all payment processing to PCI DSS validated third parties, and who have a website(s) that doesn’t directly receive cardholder data but that can impact the security of the payment transaction. No electronic storage, processing, or transmission of any cardholder data on the merchant’s systems or premises.", es decir, el procesamiento de los datos de pago lo realiza un tercero, pero el sitio web influye en la seguridad de los datos de la tarjeta.

Para cumplir con los requerimientos del estándar, es necesario completar la hoja de autoevaluación SAQ-EP y superar pruebas ASV cada tres meses.

Para más información sobre el cumplimiento del estándar PCI DSS, consulte la sección PCI DSS.

INSTALACIÓN

Para generar un criptograma, es necesario incluir el script checkout en la página del formulario de pago:

<script src="https://checkout.tiptoppay.mx/checkout.js"></script>

Elija una opción que le resulte más cómoda para transferir los datos de la tarjeta:

• Transferencia a un script
• Formulario para ingresar los datos

A continuación, se debe enviar el criptograma generado de la tarjeta al servidor y llamar al método de pago a través de la API.

OPCIÓN DE TRANSFERENCIA DE LOS DATOS DE LA TARJETA DIRECTAMENTE A UN SCRIPT

1) Inicializar el script checkout

const checkout = new tiptop.Checkout({
    publicId: 'test_api_000000000000000002',
});

2) Llamar al método de generación de criptogramas, transfiriendo a él los datos de la tarjeta

const fieldValues = {
    cvv: '911',
    cardNumber: '4242 4242 4242 4242',
    expDateMonth: '12',
    expDateYear: '24',
}

checkout.createPaymentCryptogram(fieldValues)
    .then((cryptogram) => {
        console.log(cryptogram);
    }).catch((errors) => {
        console.log(errors)
    });

OPCIÓN UTILIZANDO EL FORMULARIO:

1) Crear un formulario para ingresar los datos de la tarjeta: Los campos para ingresar los datos de la tarjeta deben estar etiquetados con atributos:

<form id="paymentFormSample" autocomplete="off">
    <input type="text" data-ttp="cardNumber">
    <input type="text" data-ttp="expDateMonth">
    <input type="text" data-ttp="expDateYear">
    <input type="text" data-ttp="cvv">
    <input type="text" data-ttp="name">
    <button type="submit">Оплатить 100 р.</button>
</form>

• data-ttp="cardNumber" — campo con el número de tarjeta;
• data-ttp="expDateMonth" — campo del mes de la fecha de caducidad;
• data-ttp="expDateYear" — campo del año de la fecha de caducidad;
• data-ttp="cvv" — campo con el código CVV;
• data-ttp="name" — campo con el nombre y apellidos del titular de la tarjeta.

2) Inicializar el script checkout

const checkout = new tiptop.Checkout({
    publicId: 'test_api_000000000000000002',
    container: document.getElementById("paymentFormSample")
});

3) Llamar al método de generación de criptogramas

checkout.createPaymentCryptogram()
    .then((cryptogram) => {
        console.log(cryptogram); // cryptogram
    }).catch((errors) => {
        console.log(errors)
    });

AL DISEÑAR UN FORMULARIO PROPIO O TRANSFERIR DATOS A UN SCRIPT, TENGA EN CUENTA LOS SIGUIENTES ASPECTOS:

• La longitud del número de tarjeta varía entre 16 (15 para tarjetas AMEX) y 19 dígitos. Más información aquí;
  
• El script checkout no funciona en navegadores anticuados e inseguros que no son compatibles con los protocolos de cifrado TLS versión 1.1 o superior. Por ejemplo, en Internet Explorer 7;
• la ventana 3DS se puede mostrar tanto en una nueva ventana como en un marco sobre la página. El tamaño de la ventana debe ser de al menos 500x500 píxeles.

MÉTODOS

MÉTODO ASÍNCRONO PARA LA GENERACIÓN DE CRIPTOGRAMAS.

En este método en caso de error de validación de los datos de la tarjeta, en lugar de un mensaje localizado se generará un código de error, consulte el ejemplo a continuación.

async createPaymentCryptogram(fieldValues: CardData): Promise<string>

МEl método devuelve Promise que contiene el criptograma. Si se transmiten datos incorrectos, Promise será rechazada con un error que incluirá el objeto con una lista de errores.

const checkout = new tiptop.Checkout({
    publicId: 'test_api_000000000000000002'
});

const fieldValues = {
    cvv: '911',
    cardNumber: '4242 4242 4242 4242',
    expDateMonth: '12',
    expDateYear: '24',
}

checkout.createPaymentCryptogram(fieldValues)
    .then((cryptogram) => {
        console.log(cryptogram);
    });

DESCRIPCIÓN DEL OBJETO CARDDATA:

export interface CardData {
    cvv?:  string; // Código CVV/CVC
    cardNumber?: string; // Número de tarjeta, los espacios no tienen importancia
    expDateMonth?: string; // Fecha de caducidad de la tarjeta — mes
    expDateYear?: string; // Fecha de caducidad de la tarjeta — año
    expDateMonthYear?: string; // Fecha de caducidad de la tarjeta, se ignoran todos los caracteres excepto los dígitos, 
    //Si la cadena tiene 2, 3 o 5 caracteres, el primer dígito se considera como el mes, los restantes como el año.  
    //Si la cadena tiene 4 o 6 caracteres, los dos primeros caracteres se consideran el mes y los dos restantes el año.
}

expDateMonth y expDateYear expDateMonthYear | Fecha de caducidad de la tarjeta, se ignoran todos los caracteres excepto los dígitos. Si la cadena tiene 2, 3 o 5 caracteres, el primer dígito se considera como el mes y los restantes como el año. Si la cadena tiene 4 o 6 caracteres, los dos primeros se consideran el mes y los restantes el año. | string | No es obligatorio si el campo está vinculado en el formulario o si se transmiten los campos expDateMonth у expDateYear name | Nombre del titular de la tarjeta | string | No

GESTIÓN DE ERRORES EN LA VALIDACIÓN DE DATOS DE TARJETAS:

const fieldValues = {
    cvv: '91', // CVV no válido
    cardNumber: '4242 4242 4242 424', // Número de tarjeta no válido
    expDateMonth: '12',
    expDateYear: '24',
}

checkout.createPaymentCryptogram(fieldValues)
    .then((cryptogram) => {
        console.log(cryptogram);
    })
        .catch((errors) => {
                console.log(errors);
             /* Resulta
                {
            cardNumber: "CardNumber_Invalid",
            cvv: "Cvv_Invalid"
                }
                */
});

MÉTODO PARA LA GENERACIÓN DE CRIPTOGRAMAS

El método devuelve un criptograma en caso de generación exitosa y un objeto con una lista de errores en caso de que existan errores en los datos de la tarjeta

Este método puede tomar como entrada un objeto con datos de la tarjeta y puede utilizarse en un esquema antiguo vinculado a un formulario HTML. Si se utiliza la vinculación del formulario y este mismo parámetro se encuentra en el objeto CardData, se producirá un error al intentar generar un criptograma.

Script para la creación del criptograma:

this.createCryptogram = function () {
    var result = checkout.createCryptogramPacket();

    if (result.success) {
        // Se ha creado el criptograma
        alert(result.packet);
    }
    else {
        // se han detectado errores en los datos introducidos, objeto `result.messages` con formato: 
        // { name: "Hay demasiados caracteres en el nombre del titular de la tarjeta», cardNumber: "Número de tarjeta incorrecto" }
        // donde `name`, `cardNumber` corresponden a los valores de los atributos `<input ... data-ttp="cardNumber">`

       for (var msgName in result.messages) {
           alert(result.messages[msgName]);
       }
    }
};

$(function () {
    /* Creación de checkout */
    checkout = new tiptop.Checkout(
    // public id la cuenta personal
    "test_api_00000000000000000000001",
    // Etiqueta que contiene los campos con datos de la tarjeta
    document.getElementById("paymentFormSample"));
});

API

API: interfaz de programación del sistema para interactuar con los sistemas de empresas comerciales y de servicios.

La interfaz opera en api.tiptoppay.mx es compatible con funciones para realizar pagos, cancelar pagos, reembolsar dinero, completar pagos en dos pasos, crear y cancelar suscripciones con pagos recurrentes, así como enviar facturas por correo.

Principio de funcionamiento

• Los parámetros se transmiten utilizando el método POST en el cuerpo de la consulta según el formato "clave=valor" o en JSON.

• La API no puede procesar más de 150,000 campos en una sola consulta. El tiempo de espera para obtener una respuesta de la API es de 5 minutos.

• En todas las consultas a la API, si se transfiere un número con una parte fraccionaria a un campo entero, no se producirá ningún error, pero sí un redondeo matemático.

• La API limita el número máximo de consultas simultáneas a 5 para terminales de prueba y a 30 para terminales operativos. Si el número de consultas al sitio web que se están procesando es superior al límite - la API devolverá una respuesta con el código HTTP 429 (Too many Requests) hasta que se complete el procesamiento de al menos una consulta. Si necesita modificar los límites, contacte a su gestor personal o a [email protected].

La elección del formato de transferencia de parámetros se determina en el lado del cliente y se gestiona a través del encabezado de la consulta Content-Type.

• Para los parámetros clave=valor» Content-Type: application/x-www-form-urlencoded;
  
• Para los parámetros JSON Content-Type Content-Type: application/json;

El sistema devuelve la respuesta en formato JSON, que incluye como mínimo dos parámetros: Success y Message:

{ "Success": false, "Message": "Invalid Amount value" }

Autenticación de consultas

Para autenticar una consulta se utiliza HTTP Basic Auth, que envía el nombre de usuario y la contraseña en el encabezado de la consulta HTTP. En calidad de nombre de usuario se utiliza Public ID y como contraseña se utiliza API Secret. Ambos valores se pueden obtener en el área personal del usuario de el panel de TipTop Pay.

Idempotencia de la API

Idempotencia: es una propiedad de la API que permite obtener en una consulta repetida el mismo resultado que en la consulta inicial, sin necesidad de volver a procesar. Esto significa que puede enviar varias consultas al sistema con el mismo identificador, pero solo se procesará una consulta exitosa y todas las respuestas serán idénticas. De esta forma se implementa la protección contra los errores de red que pueden causar duplicación de registros y acciones.

Para habilitar la idempotencia, deberá transferir en la consulta a la API un encabezado con la clave X-Request-ID que contenga un identificador único. La creación del identificador de la consulta queda de su parte: ésta puede ser un GUID, una combinación de número de pedido, fecha e importe o cualquier otro valor a su discreción.

Cada nueva consulta que necesite procesarse debe incluir un nuevo valor X-Request-ID. El resultado procesado se guarda en el sistema durante 1 hora.

Método de prueba

Para verificar la interacción con la API se puede recurrir a un método de prueba.

Dirección del método
https://api.tiptoppay.mx/test

Parámetros de la consulta:
Ninguno.

Ejemplo de respuesta:
Como respuesta, el método devuelve el estado de la consulta.

{"Success":true,"Message":"bd6353c3-0ed6-4a65-946f-083664bf8dbd"}

Pago mediante criptograma

Método para realizar pagos mediante un criptograma resultante de un algoritmo de cifrado. Para generar el criptograma, utilice el script Checkout.

Direcciones de los métodos::
https://api.tiptoppay.mx/payments/cards/charge

Parámetros de la consulta:

En respuesta, el servidor devuelve un JSON con tres componentes:

• campo success — resultado de la consulta;
• campo message — descripción del error;
• objeto model — información detallada.

Posibles variantes de respuesta:

• Consulta creada incorrectamente:
  success — false
  message — descripción del error
  
• Se requiere autenticación 3-D Secure:
  success — false
  model — información para realizar la autenticación
• Operación rechazada:
  success — false
  model — información sobre la operación y el código de error
• Operación aceptada: success — true
  model — información sobre la operación

Ejemplo de consulta para el pago mediante criptograma:

{
    "Amount":10,
    "Currency":"MXT",
    "InvoiceId":"1234567",
    "IpAddress": "123.123.123.123",
    "Description":"Test",
    "AccountId":"user_x",
    "Name":"CARDHOLDER NAME", 
    "CardCryptogramPacket":"01492500008719030128SMfLeYdKp5dSQVIiO5l6ZCJiPdel4uDjdFTTz1UnXY+3QaZcNOW8lmXg0H670MclS4lI+qLkujKF4pR5Ri+T/E04Ufq3t5ntMUVLuZ998DLm+OVHV7FxIGR7snckpg47A73v7/y88Q5dxxvVZtDVi0qCcJAiZrgKLyLCqypnMfhjsgCEPF6d4OMzkgNQiynZvKysI2q+xc9cL0+CMmQTUPytnxX52k9qLNZ55cnE8kuLvqSK+TOG7Fz03moGcVvbb9XTg1oTDL4pl9rgkG3XvvTJOwol3JDxL1i6x+VpaRxpLJg0Zd9/9xRJOBMGmwAxo8/xyvGuAj85sxLJL6fA=="
    "Payer":
      { 
        "FirstName":"Test",
        "LastName":"Test",
        "MiddleName":"Test",
        "Birth":"1955-02-24",
        "Address":"test address",
        "Street":"Street",
        "City":"City",
        "Country":"MX",
        "Phone":"123",
        "Postcode":"345"
    }
}

Ejemplo de respuesta: consulta incorrecta:

{"Success":false,"Message":"Amount is required"}

Ejemplo de respuesta: se requiere autenticación 3-D Secure:

{
    "Model": {
        "TransactionId": 891463508,
        "PaReq": "+/eyJNZXJjaGFudE5hbWUiOm51bGwsIkZpcnN0U2l4IjoiNDI0MjQyIiwiTGFzdEZvdXIiOiI0MjQyIiwiQW1vdW50IjoxMDAuMCwiQ3VycmVuY3lDb2RlIjoiUlVCIiwiRGF0ZSI6IjIwMjEtMTAtMjVUMDA6MDA6MDArMDM6MDAiLCJDdXN0b21lck5hbWUiOm51bGwsIkN1bHR1cmVOYW1lIjoicnUtUlUifQ==",
        "GoReq": null,
        "AcsUrl": "https://demo.tiptoppay.mx/acs",
        "ThreeDsSessionData": null,
        "IFrameIsAllowed": true,
        "FrameWidth": null,
        "FrameHeight": null,
        "ThreeDsCallbackId": "7be4d37f0a434c0a8a7fc0e328368d7d",
        "EscrowAccumulationId": null
    },
    "Success": false,
    "Message": null
}

Ejemplo de respuesta: operación rechazada. En el campo código de error ReasonCode (consulte el manual):

{
    "Model": {
        "ReasonCode": 5051,
        "PublicId": "pk_**********************************",
        "TerminalUrl": "http://test.test",
        "TransactionId": 891583633,
        "Amount": 10,
        "Currency": "MXN",
        "CurrencyCode": 0,
        "PaymentAmount": 10,
        "PaymentCurrency": "MXN",
        "PaymentCurrencyCode": 0,
        "InvoiceId": "1234567",
        "AccountId": "user_x",
        "Email": null,
        "Description": "Test",
        "JsonData": null,
        "CreatedDate": "/Date(1635154784619)/",
        "PayoutDate": null,
        "PayoutDateIso": null,
        "PayoutAmount": null,
        "CreatedDateIso": "2021-10-25T09:39:44",
        "AuthDate": null,
        "AuthDateIso": null,
        "ConfirmDate": null,
        "ConfirmDateIso": null,
        "AuthCode": null,
        "TestMode": true,
        "Rrn": null,
        "OriginalTransactionId": null,
        "FallBackScenarioDeclinedTransactionId": null,
        "IpAddress": "123.123.123.123",
        "IpCountry": "CN",
        "IpCity": "Beijing",
        "IpRegion": "Beijing",
        "IpDistrict": "Beijing",
        "IpLatitude": 39.9289,
        "IpLongitude": 116.3883,
        "CardFirstSix": "400005",
        "CardLastFour": "5556",
        "CardExpDate": "12/25",
        "CardType": "Visa",
        "CardProduct": null,
        "CardCategory": null,
        "EscrowAccumulationId": null,
        "IssuerBankCountry": "US",
        "Issuer": "ITS Bank",
        "CardTypeCode": 0,
        "Status": "Declined",
        "StatusCode": 5,
        "CultureName": "kk",
        "Reason": "InsufficientFunds",
        "CardHolderMessage": "InsufficientFunds",
        "Type": 0,
        "Refunded": false,
        "Name": "CARDHOLDER NAME",
        "Token": "tk_255c42192323f2e09ea17635302c3",
        "SubscriptionId": null,
        "GatewayName": "Test",
        "ApplePay": false,
        "AndroidPay": false,
        "WalletType": "",
        "TotalFee": 0
    },
    "Success": false,
    "Message": null
}

Ejemplo de respuesta: operación aceptada:

{
    "Model": {
        "ReasonCode": 0,
        "PublicId": "pk_********************************",
        "TerminalUrl": "http://test.test",
        "TransactionId": 891510444,
        "Amount": 10,
        "Currency": "MXN",
        "CurrencyCode": 0,
        "PaymentAmount": 10,
        "PaymentCurrency": "MXN",
        "PaymentCurrencyCode": 0,
        "InvoiceId": "1234567",
        "AccountId": "user_x",
        "Email": null,
        "Description": "Test",
        "JsonData": null,
        "CreatedDate": "/Date(1635150224630)/",
        "PayoutDate": null,
        "PayoutDateIso": null,
        "PayoutAmount": null,
        "CreatedDateIso": "2021-10-25T08:23:44",
        "AuthDate": "/Date(1635150224739)/",
        "AuthDateIso": "2021-10-25T08:23:44",
        "ConfirmDate": null,
        "ConfirmDateIso": null,
        "AuthCode": "A1B2C3",
        "TestMode": true,
        "Rrn": null,
        "OriginalTransactionId": null,
        "FallBackScenarioDeclinedTransactionId": null,
        "IpAddress": "123.123.123.123",
        "IpCountry": "CN",
        "IpCity": "Beijing",
        "IpRegion": "Beijing",
        "IpDistrict": "Beijing",
        "IpLatitude": 39.9289,
        "IpLongitude": 116.3883,
        "CardFirstSix": "411111",
        "CardLastFour": "1111",
        "CardExpDate": "11/25",
        "CardType": "Visa",
        "CardProduct": "C",
        "CardCategory": "Visa Signature (Signature)",
        "EscrowAccumulationId": null,
        "IssuerBankCountry": "MX",
        "Issuer": "TipTop Pay",
        "CardTypeCode": 0,
        "Status": "Authorized",
        "StatusCode": 2,
        "CultureName": "kk",
        "Reason": "Approved",
        "CardHolderMessage": "Payment success",
        "Type": 0,
        "Refunded": false,
        "Name": "CARDHOLDER NAME",
        "Token": "0a0afb77-8f41-4de2-9524-1057f9695303",
        "SubscriptionId": null,
        "GatewayName": "Test",
        "ApplePay": false,
        "AndroidPay": false,
        "WalletType": "",
        "TotalFee": 0
    },
    "Success": true,
    "Message": null
}

Procesamiento Secure 3-D

Para realizar la autenticación 3-D Secure, deberá enviar al pagador a la dirección especificada en el parámetro AcsUrl de la la respuesta del servidor con siguientes parámetros:

• MD — Parámetro TransactionId de la respuesta del servidor;
• PaReq — parámetro homónimo de la respuesta del servidor;
• TermUrl — dirección en su sitio web para redirigir al pagador después de la autenticación.

EJEMPLO DE FORMULARIO:

<form name="downloadForm" action="AcsUrl" method="POST">
    <input type="hidden" name="PaReq" value="eJxVUdtugkAQ/RXDe9mLgo0Z1nhpU9PQasWmPhLYAKksuEChfn13uVR9mGTO7MzZM2dg3qSn0Q+X\nRZIJxyAmNkZcBFmYiMgxDt7zw6MxZ+DFkvP1ngeV5AxcXhR+xEdJ6BhpEZnEYLBdfPAzg56JKSKT\nAhqgGpFB7IuSgR+cl5s3NqFTG2NAPYSUy82aETqeWPYUUAdB+ClnwSmrwtz/TbkoC0BtDYKsEqX8\nZfZkDGgAUMkTi8synyFU17V5N2nKCpBuAHRVs610VijCJgmZu17UXTxhFWP34l7evYPlegsHkO6A\n0C85o5hMsI3piNIZHc+IBaitg59qJYzgdrUOQK7/WNy+3FZAeSqV5cMqAwLe5JlQwpny8T8HdFW8\netFuBqUyahV+Hjf27vWCaSx22fe+KY6kXKZfJLK1x22TZkyUS8QiHaUGgDQN6s+H+tOq7O7kf8hd\nt30=">
    <input type="hidden" name="MD" value="504">
    <input type="hidden" name="TermUrl" value="https://example.com/post3ds?order=1234567">
</form>
<script>
    window.onload = submitForm;
    function submitForm() { downloadForm.submit(); }
</script>

Para completar su pago, utilice el siguiente método Post3ds.

Dirección del método:
https://api.tiptoppay.mx/payments/cards/post3ds

Parámetros de la consulta:

En respuesta a una consulta correctamente formulada, el servidor devolverá información sobre la transacción exitosa o sobre la operación rechazada.

Pago con token (pago recurrente)

Método de pago mediante un token obtenido al pagar con criptograma o a través de la notificación Pay.

Dirección del método::
https://api.tiptoppay.mx/payments/tokens/charge

Parámetros de la consulta:

En respuesta, el servidor devuelve un JSON con tres componentes: el campo success — resultado de la consulta, el campo message — descripción del error, el objeto model — información detallada.

POSIBLES OPCIONES

• Consulta creada incorrectamente:
  success — false
  message — descripción del error
• Operación rechazada:
  success — false
  model — información sobre la operación y el código de error
• Operación aceptada:
  success — true
  model — información sobre la operación

Ejemplo de consulta de pago por token:

{
    "Amount":59,
    "Currency":"MXN",
    "InvoiceId":"1234567",
    "Description":"Description example",
    "AccountId":"user_x",
    "Token":"success_1111a3e0-2428-48fb-a530-12815d90d0e8",
    "Payer":
      { 
        "FirstName":"Test",
        "LastName":"Test",
        "MiddleName":"Test",
        "Birth":"1955-02-24",
        "Address":"test address",
        "Street":"Street",
        "City":"City",
        "Country":"MX",
        "Phone":"123",
        "Postcode":"345"
    }
}

Ejemplo de respuesta: consulta incorrecta

{"Success":false,"Message":"Amount is required"}

Ejemplo de respuesta: operación rechazada. En el campo código de error ReasonCode (consulte el manual)

{
    "Model": {
        "ReasonCode": 5051,
        "PublicId": "pk_**********************************",
        "TerminalUrl": "http://test.test",
        "TransactionId": 891583633,
        "Amount": 100,
        "Currency": "MXN",
        "CurrencyCode": 0,
        "PaymentAmount": 100,
        "PaymentCurrency": "MXN",
        "PaymentCurrencyCode": 0,
        "InvoiceId": "1234567",
        "AccountId": "user_x",
        "Email": null,
        "Description": "Decription test",
        "JsonData": null,
        "CreatedDate": "/Date(1635154784619)/",
        "PayoutDate": null,
        "PayoutDateIso": null,
        "PayoutAmount": null,
        "CreatedDateIso": "2021-10-25T09:39:44",
        "AuthDate": null,
        "AuthDateIso": null,
        "ConfirmDate": null,
        "ConfirmDateIso": null,
        "AuthCode": null,
        "TestMode": true,
        "Rrn": null,
        "OriginalTransactionId": null,
        "FallBackScenarioDeclinedTransactionId": null,
        "IpAddress": "123.123.123.123",
        "IpCountry": "CN",
        "IpCity": "Beijing",
        "IpRegion": "Beijing",
        "IpDistrict": "Beijing",
        "IpLatitude": 39.9289,
        "IpLongitude": 116.3883,
        "CardFirstSix": "400005",
        "CardLastFour": "5556",
        "CardExpDate": "12/25",
        "CardType": "Visa",
        "CardProduct": null,
        "CardCategory": null,
        "EscrowAccumulationId": null,
        "IssuerBankCountry": "US",
        "Issuer": "ITS Bank",
        "CardTypeCode": 0,
        "Status": "Declined",
        "StatusCode": 5,
        "CultureName": "mx",
        "Reason": "InsufficientFunds",
        "Type": 0,
        "Refunded": false,
        "Name": "CARDHOLDER NAME",
        "Token": "tk_255c42192323f2e09ea17635302c3",
        "SubscriptionId": null,
        "GatewayName": "Test",
        "ApplePay": false,
        "AndroidPay": false,
        "WalletType": "",
        "TotalFee": 0
    },
    "Success": false,
    "Message": null
}

Ejemplo de respuesta: operación aceptada

 {
    "Model": {
        "ReasonCode": 0,
        "PublicId": "pk_**************************",
        "TerminalUrl": "http://test.test",
        "TransactionId": 897728064,
        "Amount": 59,
        "Currency": "MXN",
        "CurrencyCode": 0,
        "PaymentAmount": 59,
        "PaymentCurrency": "MXN",
        "PaymentCurrencyCode": 0,
        "InvoiceId": 1234567,
        "AccountId": "user_x",
        "Email": null,
        "Description": "Decription test",
        "JsonData": null,
        "CreatedDate": "/Date(1635562705992)/",
        "PayoutDate": null,
        "PayoutDateIso": null,
        "PayoutAmount": null,
        "CreatedDateIso": "2021-10-30T02:58:25",
        "AuthDate": "/Date(1635562706070)/",
        "AuthDateIso": "2021-10-30T02:58:26",
        "ConfirmDate": "/Date(1635562706070)/",
        "ConfirmDateIso": "2021-10-30T02:58:26",
        "AuthCode": "A1B2C3",
        "TestMode": true,
        "Rrn": null,
        "OriginalTransactionId": null,
        "FallBackScenarioDeclinedTransactionId": null,
        "IpAddress": "87.251.91.164",
        "IpCountry": "MX",
        "IpCity": "City",
        "IpRegion": "Region",
        "IpDistrict": "District",
        "IpLatitude": 55.03923,
        "IpLongitude": 82.927818,
        "CardFirstSix": "424242",
        "CardLastFour": "4242",
        "CardExpDate": "12/25",
        "CardType": "Visa",
        "CardProduct": "I",
        "CardCategory": "Visa Infinite Infinite",
        "EscrowAccumulationId": null,
        "IssuerBankCountry": "MX",
        "Issuer": "TipTop Pay",
        "CardTypeCode": 0,
        "Status": "Completed",
        "StatusCode": 3,
        "CultureName": "mx",
        "Reason": "Approved",
        "CardHolderMessage": "Payment has been successfully completed",
        "Type": 0,
        "Refunded": false,
        "Name": "SER",
        "Token": "success_1111a3e0-2428-48fb-a530-12815d90d0e8",
        "SubscriptionId": null,
        "GatewayName": "Test",
        "ApplePay": false,
        "AndroidPay": false,
        "WalletType": "",
        "TotalFee": 0
    },
    "Success": true,
    "Message": null
}

Confirmación de pago

Para los pagos realizados bajo el esquema de dos etapas, se requiere la confirmación del pago, que puede realizarse a través del Área personal o utilizando un método API.

Dirección del método:
https://api.tiptoppay.mx/payments/confirm

Parámetros de la consulta:

Ejemplo de consulta:

{"TransactionId":455,"Amount":65.98}

Ejemplo de respuesta:

{"Success":true,"Message":null}

Anulación del pago

La cancelación del pago se puede realizar a través del Área personal o utilizando un método API.

Dirección del método:
https://api.tiptoppay.mx/payments/void

Parámetros de la consulta:

Ejemplo de consulta:

{"TransactionId":455}

Ejemplo de respuesta:

{"Success":true,"Message":null}

Reembolso de fondos

El reembolso se puede efectuar a través del Área personal o utilizando un método API.

Dirección del método:
https://api.tiptoppay.mx/payments/refund

Parámetros de la consulta:

Ejemplo de consulta:

{"TransactionId":455, "Amount": 100}

Ejemplo de respuesta:

{
    "Model": {
        "TransactionId": 568
    },
    "Success": true,
    "Message": null
}

Cash payments

Dirección del método:
https://api.tiptoppay.mx/payments/altpay/pay

Ejemplo de consulta:

{
  "PublicId": "pk_**************************",
  "Amount": 100,
  "Currency": "MXN",
  "Description": "A basket of oranges",
  "CultureName": "en",
  "PaymentUrl": "https://www.google.com",
  "InvoiceId": "42",
  "AccountId": "[email protected]",
  "Scenario": 3,
  "AltPayType": "CashOxxo",
  "Scheme": 0,
  "ReturnRedirectUrl": "{redirectUrl}"
  "Email": "[email protected]",
  "Payer": {
    "FirstName": "Client",
    "Email": "[email protected]"
  }
}

Dependiendo de la tienda seleccionada en la consulta POST: /payments/altpay/pay, se enviará uno u otro AltPayType

• Convenience Store: AltPayType = CashCStores

• OXXO: AltPayType = CashOxxo

Pago SPEI

Dirección del método:
https://api.tiptoppay.mx/payments/altpay/pay

Ejemplo de consulta:

{
  "PublicId": "pk_**************************",
  "AltPayType": 5,
  "Scenario": 3,
  "Amount": 111,
  "Currency": "MXN",
  "Description": "SPEI",
  "Email": "[email protected]",
  "InvoiceId": "20",
  "JsonData": null,
  "CultureName": "es-ES"
}

Ejemplo de respuesta:

{ 
  "Model": {
    "transactionId": 0,
    "providerTransactionId": "string",
    "status": "Unknown",
    "statusCode": 0,
    "extensionData": {
      "clabe": 0,
      "expiredDate": "2022-07-10T05:05:40.078Z",
      "link": "string",
      "gateway": "string"
    },
    "amount": 0,
  },
  "Success": true,
  "Message": "string"
}

Ejemplo de respuesta: en caso de formato incorrecto de consulta

{
  "ErrorCode": "400",
}

Ejemplo de respuesta: ya se ha generado una cuenta CLABE para este transactionId

{
  "ErrorCode": "401",
  "ErrorMessage": "CLABE account has already been generated for this TransactionID"
}

Ejemplo de respuesta: todos los valores únicos para la cuenta CLABE están ocupados

{
  "ErrorCode": "402",
  "ErrorMessage": "All unique values for the CLABE account are occupied"
}

Ejemplo de respuesta: error interno del servidor

{
  "ErrorCode": "500",
}

Creación de una suscripción con pagos recurrentes

Método para creación de una suscripción con pagos recurrentes.

Dirección del método:
https://api.tiptoppay.mx/subscriptions/create

Parámetros de la consulta:

En respuesta a una consulta generada correctamente, el sistema devolverá un mensaje sobre una operación completada correctamente y el identificador de la suscripción.

Ejemplo de consulta:

{  
   "token": "477BBA133C182267FE5F086924ABDC5DB71F77BFC27F01F2843F2CDC69D89F05",
   "accountId": "user_x",
   "description": "Subscription on example.com",
   "email": "[email protected]",
   "amount": 399,
   "Currency": "MXN",
   "requireConfirmation": false,
   "startDate": "2021-11-02T21:00:00",
   "interval": "Day",
   "period": 5
}

Ejemplo de respuesta:

 {
    "Model": {
        "Id": "sc_221da6421dc44dbd2cc3464f6f083",
        "AccountId": "user_x",
        "Description": "Subscription on example.com",
        "Email": "[email protected]",
        "Amount": 399,
        "CurrencyCode": 0,
        "Currency": "MXN",
        "RequireConfirmation": false,
        "StartDate": "/Date(1635886800000)/",
        "StartDateIso": "2021-11-02T21:00:00",
        "IntervalCode": 2,
        "Interval": "Day",
        "Period": 5,
        "MaxPeriods": null,
        "CultureName": "mx",
        "StatusCode": 0,
        "Status": "Active",
        "SuccessfulTransactionsNumber": 0,
        "FailedTransactionsNumber": 0,
        "LastTransactionDate": null,
        "LastTransactionDateIso": null,
        "NextTransactionDate": "/Date(1635886800000)/",
        "NextTransactionDateIso": "2021-11-02T21:00:00",
        "FailoverSchemeId": null
    },
    "Success": true,
    "Message": null
}

Solicitud de información sobre la suscripción

Método para obtener información sobre el estado de la suscripción.

Dirección del método:
https://api.tiptoppay.mx/subscriptions/get

Parámetros de la consulta:

Ejemplo de consulta:

{"Id":"sc_8cf8a9338fb8ebf7202b08d09c938"}

Ejemplo de respuesta:

{
    "Model": {
        "Id": "sc_8cf8a9338fb8ebf7202b08d09c938",
        "AccountId": "user_x",
        "Description": null,
        "Email": "[email protected]",
        "Amount": 399,
        "CurrencyCode": 0,
        "Currency": "MXN",
        "RequireConfirmation": false,
        "StartDate": "/Date(1635886800000)/",
        "StartDateIso": "2021-11-02T21:00:00",
        "IntervalCode": 2,
        "Interval": "Day",
        "Period": 5,
        "MaxPeriods": null,
        "CultureName": "mx",
        "StatusCode": 3,
        "Status": "Cancelled",
        "SuccessfulTransactionsNumber": 0,
        "FailedTransactionsNumber": 0,
        "LastTransactionDate": null,
        "LastTransactionDateIso": null,
        "NextTransactionDate": null,
        "NextTransactionDateIso": null,
        "Receipt": null,
        "FailoverSchemeId": null
    },
    "Success": true,
    "Message": null
}

Búsqueda de suscripciones

Método para obtener una lista de suscripciones para una cuenta específica.

Dirección del método:
https://api.tiptoppay.mx/subscriptions/find

Parámetros de la consulta:

Ejemplo de consulta:

{"accountId":"[email protected]"}

Ejemplo de respuesta:

{
    "Model": [
{
            "Id": "sc_221da6421dc44dbd2cc3464f6f083",
            "AccountId": "user_x",
            "Description": null,
            "Email": "[email protected]",
            "Amount": 399,
            "CurrencyCode": 0,
            "Currency": "MXN",
            "RequireConfirmation": false,
            "StartDate": "/Date(1635886800000)/",
            "StartDateIso": "2021-11-02T21:00:00",
            "IntervalCode": 2,
            "Interval": "Day",
            "Period": 5,
            "MaxPeriods": null,
            "CultureName": "mx",
            "StatusCode": 3,
            "Status": "Cancelled",
            "SuccessfulTransactionsNumber": 0,
            "FailedTransactionsNumber": 0,
            "LastTransactionDate": null,
            "LastTransactionDateIso": null,
            "NextTransactionDate": null,
            "NextTransactionDateIso": null,
            "FailoverSchemeId": null
        },
        {
            "Id": "sc_3ffc96c001e152b341817341b075a",
            "AccountId": "user_x",
            "Description": null,
            "Email": "[email protected]",
            "Amount": 999,
            "CurrencyCode": 0,
            "Currency": "MXN",
            "RequireConfirmation": false,
            "StartDate": "/Date(1635973200000)/",
            "StartDateIso": "2021-11-03T21:00:00",
            "IntervalCode": 2,
            "Interval": "Day",
            "Period": 5,
            "MaxPeriods": null,
            "CultureName": "mx",
            "StatusCode": 0,
            "Status": "Active",
            "SuccessfulTransactionsNumber": 0,
            "FailedTransactionsNumber": 0,
            "LastTransactionDate": null,
            "LastTransactionDateIso": null,
            "NextTransactionDate": "/Date(1635973200000)/",
            "NextTransactionDateIso": "2021-11-03T21:00:00",
            "FailoverSchemeId": null
        }
    ],
    "Success": true,
    "Message": null
}

Modificación de una suscripción con pagos recurrentes

Método para modificar una suscripción creada previamente.

Dirección del método:
https://api.tiptoppay.mx/subscriptions/update

Parámetros de la consulta:

En respuesta a una consulta generada correctamente, el sistema devolverá un mensaje sobre una operación completada correctamente y los parámetros de la suscripción.

Ejemplo de consulta:

{  
   "Id":"sc_3ffc96c001e152b341817341b075a",
   "description":"cambio de recurrencia",
   "amount":499,
   "Currency":"MXN"
}

Ejemplo de respuesta:

{
    "Model": {
        "Id": "sc_3ffc96c001e152b341817341b075a",
        "AccountId": "user_x",
        "Description": "cambio de recurrencia",
        "Email": "[email protected]",
        "Amount": 499,
        "CurrencyCode": 0,
        "Currency": "MXN",
        "RequireConfirmation": false,
        "StartDate": "/Date(1635973200000)/",
        "StartDateIso": "2021-11-03T21:00:00",
        "IntervalCode": 2,
        "Interval": "Day",
        "Period": 2,
        "MaxPeriods": null,
        "CultureName": "mx",
        "StatusCode": 0,
        "Status": "Active",
        "SuccessfulTransactionsNumber": 0,
        "FailedTransactionsNumber": 0,
        "LastTransactionDate": null,
        "LastTransactionDateIso": null,
        "NextTransactionDate": "/Date(1635973200000)/",
        "NextTransactionDateIso": "2021-11-03T21:00:00",
        "FailoverSchemeId": null
    },
    "Success": true,
    "Message": null
}

Cancelación de una suscripción con pagos recurrentes

Método de cancelación de una suscripción con pagos recurrentes.

Dirección del método:

https://api.tiptoppay.mx/subscriptions/cancel
Parámetros de la consulta:

En respuesta a una consulta generada correctamente, el sistema devolverá un mensaje sobre la operación completada correctamente.

Ejemplo de consulta:

{"Id":"sc_cc673fdc50b3577e60eee9081e440"}

Ejemplo de respuesta:

{"Success":true,"Message":null}

Solicitud de ajustes del terminal

Método para obtener los métodos de pago disponibles por el ID público del terminal, que se transmite en el parámetro query.

Dirección del método:

https://api.tiptoppay.mx/merchant/configuration/?terminalPublicId=?&paymentUrl=?&language=?

Parámetros de la solicitud:

Ejemplo de solicitud:

https://api.tiptoppay.mx/merchant/configuration/?terminalPublicId=pk_798df82a361070a52485c827dc6f4&paymentUrl=https%3A%2F%2Fdemo-pre-mx.tiptoppay.mx&language=es

Ejemplo de respuesta:

{
  "Model": {
    "LogoUrl": "https://static.tiptoppay.mx/test_api_00000000000000000000002/logo.PNG",
    "TerminalUrl": "demo.tiptoppay.mx",
    "TerminalFullUrl": "https://demo.tiptoppay.mx",
    "WidgetUrl": "https://widget.tiptoppay.mx/",
    "IsCharity": false,
    "IsTest": true,
    "TerminalName": "Demo site",
    "SkipExpiryValidation": true,
    "AgreementPath": "",
    "IsCvvRequired": true,
    "ExternalPaymentMethods": [
      {
        "Type": 16,
        "Enabled": true
      }
    ],
    "Features": {
      "IsAllowedNotSanctionedCards": true,
      "IsQiwi": false,
      "IsForeignCurrencyGateway": false,
      "IsSaveCard": 2,
      "IsPayOrderingEnabled": true,
      "IsThreeCardInput": true
    },
    "SupportedCards": [
      0,
      1,
      2,
      3,
      4,
      5,
      6,
      7,
      8,
      9,
      10,
      11,
      12,
      13,
      14,
      15,
      16,
      17,
      100
    ],
    "DisplayAdvertiseBannerOnWidget": false,
    "BannerAdvertiseUrl": null,
    "Status": 0
  },
  "Success": true,
  "Message": null,
  "ErrorCode": null
}

Obtención de datos para el pago a plazos con tarjeta

Endpoint está diseñado para obtener los periodos de pago a plazos disponibles para las compras a plazos y el importe mensual aproximado de pago para estos periodos.

Dirección del método:

https://api.tiptoppay.mx/installments/calculate/sum-by-period?amount=&terminalPublicId=

Parámetros de la solicitud:

Ejemplo de solicitud:

https://api.tiptoppay.mx/installments/calculate/sum-by-period?terminalPublicId=pk_798df82a361070a52485c827dc6f4&amount=110

Ejemplo de respuesta:

{
    "Model": {
        "IsCardInstallmentAvailable": true,
        "Configuration": [
            {
                "Term": 3,
                "MonthlyPayment": 36.67
            }
        ]
    },
    "Success": true,
    "Message": null,
    "ErrorCode": null
}

Verificación de tarjeta por bin

El método está destinado a obtener información precisa sobre una tarjeta bancaria a partir de sus seis, siete u ocho primeros dígitos.

Dirección del método:

https://api.tiptoppay.mx/bins/info?Bin=&currency=&amount=&isAllowedNotSanctionedCards=&isQiwi=&IsCheckCard=&TerminalPublicId=&SevenNumberHash=&EightNumberHash=

Parámetros de la solicitud:

Ejemplo de solicitud:

https://api.tiptoppay.mx/bins/info?Bin=400000&currency=MXN&amount=110&isAllowedNotSanctionedCards=true&isQiwi=false&IsCheckCard=true&TerminalPublicId=pk_798df82a361070a52485c827dc6f4&SevenNumberHash=5033663954b22fc24d494bbf51402ee403bafc1ff40f35b7a1f5ae4e9e4b0ffe7598574ea0c8e56597f69b6f617a5fb37c278b3273c3ff6df3d6f9f4e16af052&EightNumberHash=68a1a1fd4de784e3a2e0e956d0a63ac4ca540ef90e7fd9a2ddc92cf68e52e29792db64f6615054a6e5460467f0b7abe055c899136d98ce6ebab3d580bc55ec86

Ejemplo de respuesta:

{
    "Model": {
        "LogoUrl": "",
        "BankName": "Bank Banorte Mexico",
        "Currency": null,
        "ConvertedAmount": null,
        "HideCvvInput": false,
        "CardType": null,
        "CountryCode": 484,
        "IsCardAllowed": true
    },
    "Success": true,
    "Message": null,
    "ErrorCode": null
}

Notificaciones

La notificación es una solicitud HTTP del sistema a tu sitio web. A las solicitudes similares también las llaman callback or webhook. El sistema dispone de varios tipos de notificaciones: para chequear la posibilidad de realizar un pago, para informar sobre pagos exitosos y no exitosos.

Chequeo

La notificación de chequeo se realiza en cuanto el titular de la tarjeta acaba de llenar el formulario de pago y pulsa el botón «Pagar». Sirve para validar el pago: el sistema envía una solicitud con la información de pago al sitio web del Comercio y el sitio web la valida y define si hay que confirmar el pago o rechazarlo.

La lista de parámetros transmitida en el cuerpo de la solicitud está expuesta en la tabla:

El sistema espera una respuesta en el formato JSON con el code de parámetro requerido:

{"code":0}

El code define el resultado de pago y puede tener los siguientes valores:

Pago

La notificación del pago se efectúa realizado exitosamente el pago y recibida la autorización del emisor.

Sirve para informar sobre el pago: el sistema envía una solicitud con la información de pago al sitio web del Comercio y el sitio web del Comercio debe registrar el hecho de pago.

La lista de parámetros transmitida en el cuerpo de la solicitud está expuesta en la tabla:

El sistema espera una respuesta en el formato JSON con el code de parámetro requerido:

{"code":0}

El code define el resultado de pago y puede tener sólo un valor:

Falla

La notificación sobre la Falla se efectúa en el caso de pago rechazado y se usa para analizar el número y las causas de las fallas.

Hay que tomar en consideración que el rechazo no es definitivo, ya que el usuario puede volver a pagar la segunda vez.

La lista de parámetros transmitida en el cuerpo de la solicitud está expuesta en la tabla:

El sistema espera una respuesta en el formato JSON con el code de parámetro requerido:

{"code":0}

El code define el resultado de pago y puede tener sólo un valor:

Reembolso

La notificación de Reembolso se efectúa en el caso de reembolso (parcial o completo) de un pago bajo tu iniciativa por medio de Panel de control.

La lista de parámetros transmitida en el cuerpo de la solicitud está expuesta en la tabla:

El sistema espera una respuesta en el formato JSON con el code de parámetro requerido:

{"code":0}

El code define el resultado de pago y puede tener sólo un valor:

Validación de la notificación

Todas las notificaciones — chequeo, pago, falla y reembolso - tienen cabeceras HTTP X-Content-HMAC y Content-HMAC que contienen un valor de validación de la solicitud que se calcula con uso del algoritmo HMAC. La única diferencia consiste en que la primera se genera a base de los parámetros descodificados (o no codificados) de URL, y la segunda se genera a base de los parámetros codificados de URL (lo que puede causar problemas). Si necesitas verificar la autenticidad y la integridad de las notificaciones, puedes calcular el valor de la validación en tu lado y compararlo con el valor de la solicitud. La coincidencia confirma que has recibido la notificación que hemos enviado en formato original.

Por favor, presta atención a los siguientes puntos realizando la validación de notificación:

• En el caso de las notificaciones enviadas por el método POST el mensaje está representado por el cuerpo de la solicitud. En el caso del método GET se trata de los parámetros de la cadena;
• Calculando el HMAC utiliza la codificación UTF8;
• Calculando el Hash usa la función SHA256;
  
• El API secreto sirve como la llave, se obtiene en tu Panel de control;
  
• El valor calculado está en la codificación base64.

Ejemplos de cálculo de HMAC en diferentes lenguajes de programación.

El sistema envía las notificaciones de las siguientes direcciones: 54.176.98.0/32.

Para ti significa que:

• Si no utilizas las notificaciones de pago/chequeo/falla/reembolso, no tienes que hacer nada;
• Si utilizas por lo menos una de esas notificaciones, tendrás que chequear que protocolos de encriptado de https admite tu servidor. Si tu servidor admite solo SSL3, tendrás que actualizarlo por lo menos hasta TLS11. Mejor sería que lo actualizaras hasta TLS13. Como última opción puedes pasar las notificaciones al protocolo http.

Más información sobre la exclusión de SSL3. Después del 8 de junio es posible que las notificaciones https no lleguen a los servidores que admiten sólo el SSL3.

Pago a plazos con tarjeta

TipTopPay ofrece el método de pago: pago a plazos con tarjeta. El pago a plazos con tarjeta solo está disponible para los titulares de tarjetas de crédito emitidas por un banco mexicano. Para activar el pago a plazos, debe ponerse en contacto con un gestor personal de TipTopPay.

Pago a plazos en el widget

Si el pago por un producto en el sitio web está disponible a plazos, el cliente verá un botón "Pagar en meses sin intereses" en el widget, al pulsarlo el cliente pasará a una página separada del widget.

En la página de pago a plazos, el cliente deberá introducir los datos de la tarjeta*, seleccionar el periodo de pago a plazos* y pulsar en Pagar.

*Los requerimientos para los datos de la tarjeta, y los plazos disponibles pueden ser precisados por su gestor personal en TipTopPay.

Para integrar el pago a plazos con tarjeta, debe realizar el siguiente procedimiento:

1. Verifique si su sitio web permite el pago a plazos con tarjeta, para realizar la verificación necesita llamar al método GET: /merchant/configuration/?terminalPublicId=&paymentUrl=&language=
   1. Si en la respuesta aparece la matriz "ExternalPaymentMethods" con { "Type": 16, "Enabled": true }, significa que el pago a plazos está permitido en su sitio web. Es necesario para pasar al siguiente paso del algoritmo.
   2. En caso contrario, el pago a plazos no está disponible en su terminal.
2. Obtenga los periodos disponibles para el pago a plazos y el importe mensual aproximado de dichos periodos para el pago de esta compra. Para ello, se debe llamar al método GET: api/installments/calculate/sum-by-period?amount=&terminalPublicId=
   1. Si la respuesta es IsCardInstallmentAvailable:false, no será posible pagar esta compra a plazos.
   2. Si la respuesta es IsCardInstallmentAvailable:true, en la matriz Configuration se mostrarán los periodos para pagar esta compra a plazos y el importe mensual aproximado de pago para cada periodo.
3. Para realizar un pago a plazos, el cliente debe introducir los datos de la tarjeta que cumplan los requerimientos para el pago a plazos, seleccionar el periodo de pago a plazos y pulsar Pagar.
   1. Puede verificar los datos de la tarjeta por su cuenta o utilizar nuestro mecanismo para verificar la posibilidad de pagar a plazos.
      • Para verificar los datos de la tarjeta y determinar la posibilidad de pagar a plazos con tarjetas en el sistema Tiptoppay, es necesario hacer una llamada a GET bins/info y a Path params además de los campos con el número de la tarjeta se debe transmitir IsCheckCard:true, TerminalPublicId: <su TerminalPublicId>.
        1. Si como respuesta aparece el campo IsCardAllowed:true, la tarjeta es apropiada para el pago a plazos.
        2. Si en la respuesta aparece el campo IsCardAllowed:false, la tarjeta no es apropiada para el pago a plazos. El cliente debe indicar los datos de una tarjeta diferente. El pago a plazos con una tarjeta de este tipo será rechazado indiándose un error.
4. Para realizar una solicitud de pago a plazos, es necesario llamar al método POST: /payments/cards/charge, en cuyo cuerpo se deben transmitir los datos del pago a plazos en el campo InstallmentData. Consulte la descripción del campo por separado, en la descripción del método /payments/cards/charge. En la respuesta, habrá recibido los datos para pasar la verificación 3DS.
5. Realice la verificación 3DS para el pago a plazos con tarjeta. El proceso de verificación 3DS no difiere de la verificación 3DS que se realiza para pagar con tarjeta sin cuotas. Si desea una descripción de la verificación 3DS, consulte la sección correspondiente.
6. Después de pasar la verificación 3DS recibirá el resultado del pago a plazos con tarjeta. La descripción de los campos con el resultado del pago podrá consultarla en la descripción de los campos de respuesta al método /payments/cards/charge

Escenarios de integración

El sistema ofrece varias opciones de integración, desde muy básicas hasta infinitamente funcionales, dependiendo de los requerimientos.

Formulario de pago

Si no necesitas chequear los pagos antes del pago y registrarlos después del pago:

• Añade el script de widget a tu sitio web;
• Indica un correo electrónico para las notificaciones de pago en el Panel de control.

Registro de pagos

Si necesitas registrar los pagos en tu sistema sin chequeo previo, haz lo siguiente:

• Añade el script a tu sitio web;

• Haz el registro de pagos:

  • Crea un controlador para las notificaciónes de Pago, por ejemplo https://site.com/webhooks/tiptoppay/pay;
  • Determina la lógica de registro de pagos en el controlador y de respuesta en formato JSON;
  • Activa la función de notificaciones de Pago en el Panel de control.

Chequeo y registro de pagos

Si necesitas chequear y registrar los pagos en tu sistema, haz lo siguiente:

• Añade el script de widget a tu sitio web;

• Haz el chequeo de pagos:

  • Crea un controlador para las Check notification, por ejemplo, https://site.com/webhooks/tiptoppay/check;
  • Determina la lógica de registro de pagos en el controlador y de respuesta en formato JSON;

• Haz el registro de pagos:

  • Crea un controlador para las notificaciónes de Pago, por ejemplo https://site.com/webhooks/tiptoppay/pay;
  • Determina la lógica de registro de pagos en el controlador y de respuesta en formato JSON;

• • Activa las notificaciones de Chequeo y de Pago en el Panel de control.

Pruebas

Cuando obtengas el acceso al Panel de control, estará en el modo de prueba, eso significa que los pagos y las demás operaciones se realizarán en el modo de emulación.

Para realizar las pruebas, puedes utilizar los siguientes datos de la tarjeta:

Referencia

Códigos de error

Abajo encontrarás los códigos de error que explican el motivo de rechazo de pago.

El widget de pago muestra un mensaje de error automáticamente.

Lista de las respuestas del procesador de las notificaciones de chequeo

A continuación verás los códigos de registro de tus respuestas.

Tipos de operaciones

La siguiente tabla contiene los códigos de los tipos de operaciones que aparecen en las notificaciones.

Estados de transacciones

La siguiente tabla contiene los estados de las transacciones, las condiciones de uso y las acciones posibles.

Lista de monedas

Nuestros socios aceptan los pagos en MX.

La siguiente tabla contiene los nombres de las monedas y sus códigos que pueden ser asignados al parámetro currency de Widget.

Si la moneda que necesitas no está en la lista, escríbenos al correo electrónico [email protected] y la incluiremos en la lista.

Tipos de notificaciones

La tabla de abajo contiene los tipos de notificaciones.