redsys-pos
v1.0.2
Published
Node JS library to ease the communication with RedSys point of sales
Downloads
1,674
Maintainers
Readme
RedSys POS
NodeJS library to ease the communication with RedSys point of sales
Installation
Install the NPM package:
npm install redsys-pos
Usage
Generating a request
Generate the parameters to create a transaction:
const RedSys = require('redsys-pos');
const { CURRENCIES, TRANSACTION_TYPES } = RedSys;
const MERCHANT_KEY = "sq7HjrUOBfKmC576ILgskD5srU870gJ7"; // TESTING KEY
const redsys = new RedSys(MERCHANT_KEY);
var obj = {
amount: '100', // cents (in euro)
orderReference: '1508428360',
merchantName: "INTEGRATION TEST SHOP",
merchantCode: '327234688',
currency: CURRENCIES.EUR,
transactionType: TRANSACTION_TYPES.AUTHORIZATION, // '0'
terminal: '1',
merchantURL: 'http://www.my-shop.com/',
successURL: 'http://localhost:8080/success',
errorURL: 'http://localhost:8080/error'
}
const result = redsys.makePaymentParameters(obj);
console.log(result);
The above code will print:
{
Ds_SignatureVersion: 'HMAC_SHA256_V1',
Ds_MerchantParameters: 'eyJEU19NRVJDSEFOVF9BTU9VTlQiOiIxMDAiLCJEU19NRVJDSEFOVF9PUkRFUiI6IjE1MDg0MjgzNjAiLCJEU19NRVJDSEFOVF9NRVJDSEFOVE5BTUUiOiJUZXN0aW5nIFNob3AiLCJEU19NRVJDSEFOVF9NRVJDSEFOVENPREUiOiIzMjcyMzQ2ODgiLCJEU19NRVJDSEFOVF9DVVJSRU5DWSI6Ijk3OCIsIkRTX01FUkNIQU5UX1RSQU5TQUNUSU9OVFlQRSI6IjAiLCJEU19NRVJDSEFOVF9URVJNSU5BTCI6IjEiLCJEU19NRVJDSEFOVF9NRVJDSEFOVFVSTCI6IiIsIkRTX01FUkNIQU5UX1VSTE9LIjoiaHR0cDovL2xvY2FsaG9zdDo4MDgwL3N1Y2Nlc3MiLCJEU19NRVJDSEFOVF9VUkxLTyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA4MC9lcnJvciJ9',
Ds_Signature: 'FebYtynNmPyRnHiUfVqCmahQjVO7DntVz8Si6e7jgig='
}
Send the above JSON to the browser, and submit a form like below:
const DEBUG = ...;
var result = { ... }; // The response above from the server
var form = document.createElement("form");
if(DEBUG) {
form.setAttribute("action", "https://sis-t.redsys.es:25443/sis/realizarPago")
} else {
form.setAttribute("action", "https://sis.redsys.es/sis/realizarPago")
}
form.setAttribute("method", "POST");
form.setAttribute("style", "display: none");
// Parameters
for(k in result) {
var field = document.createElement("input");
field.setAttribute("type", "hidden");
field.setAttribute("name", k);
field.setAttribute("value", result[k]);
form.appendChild(field);
}
document.body.appendChild(form);
form.submit();
For a detailed example, check out example/frontend.html
;
The official recommended mechanism is a plain old HTML form as below, which is an equivalent of the JS code above:
<form name="from" action="https://sis-t.redsys.es:25443/sis/realizarPago" method="POST">
<input type="hidden" name="Ds_SignatureVersion" value="HMAC_SHA256_V1" />
<input type="hidden" name="Ds_MerchantParameters" value="eyJEU19NRVJDSEFOVF9BTU9VTlQiOiIxMDAiLCJEU19NRVJDSEFOVF9PUkRFUiI6IjE1MDg0MjgzNjAiLCJEU19NRVJDSEFOVF9NRVJDSEFOVE5BTUUiOiJUZXN0aW5nIFNob3AiLCJEU19NRVJDSEFOVF9NRVJDSEFOVENPREUiOiIzMjcyMzQ2ODgiLCJEU19NRVJDSEFOVF9DVVJSRU5DWSI6Ijk3OCIsIkRTX01FUkNIQU5UX1RSQU5TQUNUSU9OVFlQRSI6IjAiLCJEU19NRVJDSEFOVF9URVJNSU5BTCI6IjEiLCJEU19NRVJDSEFOVF9NRVJDSEFOVFVSTCI6IiIsIkRTX01FUkNIQU5UX1VSTE9LIjoiaHR0cDovL2xvY2FsaG9zdDo4MDgwL3N1Y2Nlc3MiLCJEU19NRVJDSEFOVF9VUkxLTyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA4MC9lcnJvciJ9" />
<input type="hidden" name="Ds_Signature" value="qkMJMWR6Dq32xwbQuguTv39OvXv4KdD1Xg7pZ8phGZI=" />
</form>
Checking a response
// Previously initialized
// const RedSys = require('redsys-pos');
// const MERCHANT_KEY = "sq7HjrUOBfKmC576ILgskD5srU870gJ7";
// const redsys = new RedSys(MERCHANT_KEY);
// Check the response
const merchantParams = "eyJEc19EYXRlIjoiMjAlMkYxMCUyRjIwMTciLCJEc19Ib3VyIjoiMTclM0EyMyIsIkRzX1NlY3VyZVBheW1lbnQiOiIwIiwiRHNfQW1vdW50IjoiMTAwIiwiRHNfQ3VycmVuY3kiOiI5NzgiLCJEc19PcmRlciI6IjAwMDA5NjU1RDg0IiwiRHNfTWVyY2hhbnRDb2RlIjoiMzI3MjM0Njg4IiwiRHNfVGVybWluYWwiOiIwMDEiLCJEc19SZXNwb25zZSI6Ijk5MTUiLCJEc19UcmFuc2FjdGlvblR5cGUiOiIwIiwiRHNfTWVyY2hhbnREYXRhIjoiIiwiRHNfQXV0aG9yaXNhdGlvbkNvZGUiOiIrKysrKysiLCJEc19Db25zdW1lckxhbmd1YWdlIjoiMSJ9";
const signature = "vrUsaNbxfonyn4ONUos6oosUaTBY0_SGoKDel6qsHqk";
const result = redsys.checkResponseParameters(merchantParams, signature);
console.log(result);
If successful, this will print:
{
Ds_Date: '20/10/2017',
Ds_Hour: '17:23',
Ds_SecurePayment: '0',
Ds_Amount: '100',
Ds_Currency: '978',
Ds_Order: '00009655D84',
Ds_MerchantCode: '327234688',
Ds_Terminal: '001',
Ds_Response: '9915',
Ds_TransactionType: '0',
Ds_MerchantData: '',
Ds_AuthorisationCode: '++++++',
Ds_ConsumerLanguage: '1'
}
Very important Make sure that you handle properly the trailing "=" symbols of the Base64 payload. More on the FAQ.
Checking an invalid response/signature
If an invalid response or signature is provided:
// Check the response
const merchantParams = "eyJEc19EYXRlIjoiMjAlMkYxMCUyRjIwMTciLCJEc19Ib3VyIjoiMTclM0EyMyIsIkRzX1NlY3VyZVBheW1lbnQiOiIwIiwiRHNfQW1vdW50IjoiMTAwIiwiRHNfQ3VycmVuY3kiOiI5NzgiLCJEc19PcmRlciI6IjAwMDA5NjU1RDg0IiwiRHNfTWVyY2hhbnRDb2RlIjoiMzI3MjM0Njg4IiwiRHNfVGVybWluYWwiOiIwMDEiLCJEc19SZXNwb25zZSI6Ijk5MTUiLCJEc19UcmFuc2FjdGlvblR5cGUiOiIwIiwiRHNfTWVyY2hhbnREYXRhIjoiIiwiRHNfQXV0aG9yaXNhdGlvbkNvZGUiOiIrKysrKysiLCJEc19Db25zdW1lckxhbmd1YWdlIjoiMSJ9";
const invalidSignature = "invalid-signature";
result = redsys.checkResponseParameters(merchantParams, invalidSignature);
console.log(result);
This will print:
null
Checking a response code
const { getResponseCodeMessage } = require("redsys-pos");
var str = getResponseCodeMessage("0180");
console.log(str);
This will print:
Operación no permitida para ese tipo de tarjeta.
Checking an invalid response code
const { getResponseCodeMessage } = require("redsys-pos");
var str = getResponseCodeMessage("xyz");
console.log(str);
This will print:
null
FAQ
Sometimes, random requests may fail, even if parameters are just what comes from RedSys
- If you are getting the
Ds_MerchantParameters
andDs_Signature
from a URL, you may have trouble parsing the data properly. RedSys appends the Base64 payload without escaping the "=" symbols, and query string parsers may treat them as if they were a parameter assignment like?id=123&test=456
. - You are responsible of parsing and handling the entire payload, or otherwise the deciding will not match.
Testing
To test the component, run npm test
.
End to end tests are performed with the help of Puppeteer. Unit tests are provided as well. At the time, Puppeteer only runs as expected with { headless: false }
.
Note that in order to prevent bloatware from reaching the development node_modules
folder, a separate package.json
file is used on the spec
folder.
About
The present library is a work of Jordi Moraleda and Joel Moreno