Node.js module to retrieve transactions from an Edenred card.

NOTE: Only tested with the Portuguese version (https://www.myedenred.pt)

Installation

Install the package using npm:

npm install edenred-transactions

After installed, import it into your project:

import edenred from 'edenred-transactions';

Example

Saving transactions to a CSV file:

import edenred from 'edenred-transactions';
try {
    await edenred.login({
        email: '[email protected]',
        password: 'YourPassword123456'
    });
    const transactions = await edenred.getTransactions(); 
    edenred.saveTransactions(transactions);
} catch(err) {
    console.error(err);
}

Methods

login

Logs in with the provided credentials, which are passed by an object consisted of:

• Endpoint (optional; defaults to Portuguese endpoint)
• E-mail address
• Password

edenred.login({
    endpoint: 'https://www.myedenred.pt/edenred-customer/api',
    email: '[email protected]',
    password: 'YourPassword123456'
});

getTransactions

Retrieves transactions for a specific card. If no card identification is provided, it will attempt to retrieve one from the first card in user's account, by using the getCardId function.

edenred.getTransactions('123456');

saveTransactions

Saves the transactions to a file, either in CSV or JSON format.
Use the second parameter in boolean to indicate whether to save in CSV format, which defaults to true.
The third parameter indicates the folder where the file will be saved. Default is transactions.

edenred.saveTransactions(transactionsArray, false, 'some-folder');