Openpay.js

Notes: Although the response functions are optional, we recommend that they be implemented so that the result of the transaction can be monitored on the web page.

In case of success: SuccessCallback

This function is called when the operation was successful from start to finish. It receives a single parameter which is a Javascript object with the token data.

Complete example of implementing a SuccessCallback function:

function SuccessCallback(response) {
    alert('Operación exitosa');
    var content = '', results = document.getElementById('resultDetail');
    content .= 'Id tarjeta: ' + response.data.id+ '
';
    content .= 'A nombre de: ' + response.data.holder_name + '
';
    content .= 'Marca de tarjeta usada: ' + response.data.brand + '
';
    results.innerHTML = content;
}

In case of error: ErrorCallback

This function will be executed every time an operation has failed (for any reason, before or after sending the request). Like the SuccessCallback (), it receives a single parameter which is a Javascript object with the detail of the failure.

Complete example of implementation of an ErrorCallback function:

function ErrorCallback(response) {
    alert('Fallo en la transacción');
    var content = '', results = document.getElementById('resultDetail');
    content .= 'Estatus del error: ' + response.data.status + '
';
    content .= 'Error: ' + response.message + '
';
    content .= 'Descripción: ' + response.data.description + '
';
    content .= 'ID de la petición: ' + response.data.request_id + '
';
    results.innerHTML = content;
}

​ Types of error

In addition to the status field that saves the status of the transaction, it is possible to determine the error that has occurred through the message field. The message can be one of the following:

• Empty or invalid OpenPay ID: It happens when the user ID has not been set correctly with the OpenPay.setId () method
• Empty or invalid API Key: Like the above error, it happens when the API Key has not been set with the OpenPay.setApiKey () method
• Browser error: It is triggered when there is an error in the browser that prevents the request from being carried out correctly. It can be caused by features that are necessary to run certain code and are missing from the browser. For more information see the section "Compatibility and requirements".
• Request error: This error indicates that there was an error on the Openpay server. It may be due to missing parameters, formats, or some other problem that is preventing the transaction from successfully completing.
• Response error (Unknown final status): When this error is generated, it means that the transaction request was successfully sent to the Openpay server but no response was received. This may be due to a problem in Openpay. For more information contact OpenPay.
• Timeout after X milliseconds: It is launched when the request has taken a long time to execute and therefore the response time expires.
• Unknown error: It is generated when there is an unknown error that prevents the request from being made. It may be due to browser or connectivity problems.

Validation functions

Besides the functions to process card charges, Openpay.js also includes some functions to validate the main data needed to carry out the transaction, specially regarding card numbers.

The available methods are:

• OpenPay.card.validateCardNumber()
• OpenPay.card.validateCVC()
• OpenPay.card.validateExpiry()
• OpenPay.card.cardType()

Card number validation

To validate a card number you can use the OpenPay.card.validateCardNumber().

This method receives a String as a parameter with the card number which will be validated and will return true / false depending if the card it’s valid and is accepted by Openpay. Example

OpenPay.card.validateCardNumber('5555555555554444');

This method is very useful for determining whether a card number is valid and if it’s able to be used with Openpay, so we recommend that you use it routinely before attempting a card charge.

Examples:

OpenPay.card.validateCardNumber('5555555555554444');
// TRUE. Número de tarjeta válido y aceptado por OpenPay (MASTERCARD)
OpenPay.card.validateCardNumber('378282246310005');
// FALSE. Número de tarjeta válido pero no aceptado por OpenPay (AMEX) 

Security Code Validation

To validate the security code use the OpenPay.card.validateCVC().

This method receives a String as a parameter and returns true / false depending if the string is valid.

Examples:

OpenPay.card.validateCVC('123'); // válido
OpenPay.card.validateCVC('1234'); // válido
OpenPay.card.validateCVC('A23'); // inválido

Additionally, the security code can be validated by passing the card number as the second parameter, to determine if the code is valid for the type of card in question.

Examples:

OpenPay.card.validateCVC('123','5555555555554444');
// válido, tarjeta MASTERCARD y CVC de longitud 3
OpenPay.card.validateCVC('1234','5555555555554444');
// inválido, tarjeta MASTERCARD y CVC de longitud 4
OpenPay.card.validateCVC('123','378282246310005');
// inválido, tarjeta AMERICAN EXPRESS y CVC de longitud 3
OpenPay.card.validateCVC('1234','378282246310005');
// válido, tarjeta AMERICAN EXPRESS y CVC de longitud 4

Expiration date Validation

For this purpose use the OpenPay.card.validateExpiry().

This method receives two strings as parameters representing the expiration month and year of the card. It returns true / false depending if the combination of both data, month and year, are a valid expiration date. Example:

OpenPay.card.validateExpiry('01', '2013'); // inválido
OpenPay.card.validateExpiry('05', '2015'); // válido

Validation of the type of card

It can be determined (most of the time) the type of card that belongs to a card number. For this, use the OpenPay.card.cardType().

The method receives a card number as a parameter and returns a String with the name of the card type.

Examples:

OpenPay.card.cardType('5555555555554444'); // Mastercard
​OpenPay.card.cardType('4111111111111111'); //​ Visa
OpenPay.card.cardType('4917300800000000'); // Visa Electron
OpenPay.card.cardType('378282246310005'); // American Express
OpenPay.card.cardType('30569309025904'); // Diners Club Carte Blanche
OpenPay.card.cardType('6011111111111117'); // Discover
OpenPay.card.cardType('3530111333300000'); // JCB

Compatibility and Requirements

To use Openpay.js is necessary to have one of the following browsers:

• Chrome 29.0+
• Firefox 23.0+
• Safari 5.1+
• Opera 17.0+
• iOS Safari 4.0+
• Android Browser 2.1+
• Blackberry Browser 7.0+
• IE Mobile 10.0

It’s required that the browsers have support for the XMLHttpRequest and JSON Parser libraries.