[DEPRECATED]
Trolley JavaScript SDK (Previously Payment Rails1)
Trolley's now DEPRECATED JavaScript SDK. New package: trolleyhq
Update notification and details: https://trolley.com/updates/eol-paymentrails-sdks/
For more information about the API as well as NodeJS code samples check out the full API documentation
Installation
npm install --save paymentrails
Getting Started
The Trolley API is built using promises and all methods except
connect will return a promise. The connect call allows you to setup
your API Key and Secret with a client that can be used for subsequent
calls.
const trolley = require('paymentrails');
const client = trolley.connect({
key: "YOUR-API-KEY",
secret: "YOUR-API-SECRET",
environment: "production",
});
async function main() {
const recipient = await client.recipient.find("R-G7SXXpm6cs4aTUd9YhmgWC");
console.log(recipient.id);
}
main();
client.recipient.find("R-G7SXXpm6cs4aTUd9YhmgWC").then(recipient => {
console.log(recipient.id);
}).catch(err => {
console.log("ERROR", err);
});
Usage
Methods should all have JSDoc comments to help you understand their usage. As mentioned the full API documentation
is the best source of information about the API.
For more information please read the JavaScript API docs is available. The best starting point is:
Running Integration / Unit tests
If you're working on the library itself, here's easy way to run the tests.
// if not already, copy the example env file to create an env file
$ cp .env.test .env
// Set access key and secret in the env file
TROLLEY_ENVIRONMENT="production"
TROLLEY_ACCESS_KEY="ACCESS_KEY"
TROLLEY_SECRET_KEY="SECRET_KEY"
//Run the fixture based tests
$ npm test