npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

redsys-easy

v5.2.6

Published

Node JS interface for Redsys payment gateway

Downloads

2,411

Readme

Redsys Easy

Node JS client and utilities for implementing a redsys payment gateway

Install

npm install redsys-easy

API documentation

Checkout the api documentation to explore the utilities exported by this package.

Usage

These are the most important utilities that redsys-easy provides.

import {
  createRedsysAPI,
  SANDBOX_URLS,
  PRODUCTION_URLS,
  // Create a new orderId
  randomTransactionId,
  // Utilities for 3DS forms
  create3DSMethodForm,
  create3DSv1ChallengeForm,
  create3DSv2ChallengeForm,
  deserializeThreeDSMethodData,
  deserializeCres
} from 'redsys-easy';

const {
  // REST integration
  restIniciaPeticion,
  restTrataPeticion,
  // Redirect integration
  createRedirectForm,
  processRestNotification,
  processSoapNotification,
  createSoapNotificationAnswer
}= createRedsysAPI({
  secretKey: 'sq7HjrUOBfKmC576ILgskD5srU870gJ7',
  urls: SANDBOX_URLS
});

Examples

Despite the name, a redsys payment gateway with 3DS support is quite complex. Don't despair, these examples show how it can be implemented.

Redirection is much simpler but less customizable

Formatters

By default, the main functions exported by this package use the API specified by redsys. To smooth out the corners of this API, it's also possible to wrap them with custom formatters.

As an example, redsys-easy provides some basic typescript-ready formatters.

:warning: Format has changed: Previous versions of redsys-easy used a different format, particularly the amount field.

import {
  createRedsysAPI,
  SANDBOX_URLS,
  // Formatter utils
  useSingleInputFormatter,
  useOutputFormatter,
  usePromiseOutputFormatter,
  // Input formatters
  redirectInputFormatter,
  restIniciaPeticionInputFormatter,
  restTrataPeticionInputFormatter,
  // Output formatters
  restNotificationOutputFormatter,
  soapNotificationOutputFormatter,
  restIniciaPeticionOutputFormatter,
  restTrataPeticionOutputFormatter
} from 'redsys-easy';

const {
  restIniciaPeticion: baseRestIniciaPeticion,
  restTrataPeticion: baseRestTrataPeticion,
  createRedirectForm: baseCreateRedirectForm,
  processRestNotification: baseProcessRestNotification,
  processSoapNotification: baseProcessSoapNotification
} = createRedsysAPI({
  secretKey: 'sq7HjrUOBfKmC576ILgskD5srU870gJ7',
  urls: SANDBOX_URLS
});

/*
 *            External      Internal
 * amount      '33.5'  <->   '3350'
 * currency    'EUR'   <->   '978'
 *
 * expiryYear  '34'
 * expiryMonth '12'
 *                     <->   '3412'
 *
 * lang        'es'    <->   '1'
 * cardBrand   'VISA'  <-    '1'
 * cardCountry 'es'    <-    '724'
 */
export const createRedirectForm = useSingleInputFormatter(baseCreateRedirectForm, redirectInputFormatter);
export const restIniciaPeticion = useSingleInputFormatter(
  usePromiseOutputFormatter(baseRestIniciaPeticion, restIniciaPeticionOutputFormatter),
  restIniciaPeticionInputFormatter
)
export const restTrataPeticion = useSingleInputFormatter(
  usePromiseOutputFormatter(baseRestTrataPeticion, restTrataPeticionOutputFormatter),
  restTrataPeticionInputFormatter
)
export const processRestNotification = useOutputFormatter(baseProcessRestNotification, restNotificationOutputFormatter);
export const processSoapNotification = useOutputFormatter(baseProcessSoapNotification, soapNotificationOutputFormatter);

FAQ

How should I format the amount?

Redsys API uses expects amounts denominated in the smallest unit of a currency. The exported core functions of redsys-easy also follows this convention. The smallest unit of a currency is the smallest integer amount of said currency. For euros, it is cents. So 1.99 EUR would be 199 of the smallest unit.

However you are free to wrap these core functions with a custom formatter. Particularly, redsys-easy optional formatters expect the amount to be formatted as a decimal string currency unit. For euros, it would be '1.99'.

Acknowledgments

Based on previous work