Realex JS Library

You can sign up for a Realex account at https://developer.realexpayments.com

Hosted Payment Page (HPP) JS Library

Usage

The Javascript required to initialise the library is below. This code must only be executed when the DOM is fully loaded. (default method: lightbox)

RealexHpp.init(payButtonId, merchantUrl, jsonFromServerSdk[, options]);

• payButtonId - The ID of the button used to launch the lightbox. Set to "autoload" if you want to load without having to press a button
• merchantUrl - could be one of 2 types:
  • string - The URL to which the JSON response from Realex will be posted.
  • function - the callback function
• jsonFromServerSdk - The JSON output from the Realex HPP Server SDK.
• options/events
  • onResize (iframe embed) Send resize iframe events so the parent frame can be adjusted

Enable the logger

The following code enables a logger that will emit an event on each step performed by the library. Should be used for debugging only.

RealexHpp.setConfigItem('enableLogging', true);
window.addEventListener(RealexHpp.constants.logEventName, function(e) {
    console.log(e.detail);
});

Consuming the resulting POST

Once the payment has completed the Realex JSON response will be posted within to the supplied merchantUrl. The name of the field containing the JSON response is hppResponse.

If you prefer to handle response manually, provide your own callback function in "merchantUrl". The answer will be pre-parsed to an object ready to be used.

Examples

• embedded iFrame
• embedded iFrame autoload
• embedded iFrame autoload, callback
• lightbox/modal

Remote JS Library

Validation functions

• validateCardNumber - validates card number format and performs a Luhn check
• validateCardHolderName - validates card holder name is made up from ISO/IEC 8859-1:1998 characters
• validateCvn - validates non-Amex CVN
• validateAmexCvn - validates Amex CVN
• validateExpiryDateFormat - validates expiry date format
• validateExpiryDateNotInPast - validates expiry date is not in past

Usage

RealexRemote.validateCardNumber(cardNumber);
RealexRemote.validateCardHolderName(cardHolderName);
RealexRemote.validateCvn(cvn);
RealexRemote.validateAmexCvn(amexCvn);
RealexRemote.validateExpiryDateFormat(expiryDate);
RealexRemote.validateExpiryDateNotInPast(expiryDate);

License

See the LICENSE file.