Node.js library for SecurionPay API

For detailed description of parameters for available methods please visit https://securionpay.com/docs/api

Installation

TODO: library still needs to be published into NPM

npm install securionpay

Quick start

var api = require('securionpay')('pk_test_myprivatekey')

api.customers.create({
    email: 'user@example.com',
    description: 'User description'
}).then(function(customer) {
    return api.cards.create(customer.id, {
        number: '4242424242424242',
        expMonth: '12',
        expYear: '2020',
        cvc: '123',
        cardholderName: 'John Smith'
    });
}).then(function(card) {
    console.log('ID of created card object: ', card.id);
}).catch(function(e) {
    // handle errors here
})

Bluebird is used as Promise library ( http://bluebirdjs.com/ ).

Preferring callbacks? All methods accept callback as their last argument. Promise is not returned when passing callback.

api.customers.create({
    email: 'user@example.com',
    description: 'User description'
}, function(err, customer) {
    if(err) {
        // handle error
    } else {
        // handle response
    }
});

API reference

When params is one of method arguments please refer to detailed API docs (linked) for all available fields

• charges
  • create(params)
  • get(chargeId)
  • update(chargeId, params)
  • capture(chargeId)
  • refund(chargeId, [params])
  • list([params])
• customers
  • create(params)
  • get(customerId)
  • update(customerId, params)
  • delete(customerId)
  • list([params])
• cards
  • create(customerId, params)
  • get(customerId, cardId)
  • update(customerId, cardId, params)
  • delete(customerId, cardId)
  • list(customerId, [params])
• subscriptions
  • create(customerId, params)
  • get(customerId, subscriptionId)
  • update(customerId, subscriptionId, params)
  • cancel(customerId, subscriptionId, [params])
  • list(customerId, [params])
• plans
  • create(params)
  • get(planId)
  • update(planId, params)
  • delete(planId)
  • list([params])
• events
  • get(eventId)
  • list([params])
• tokens
  • create(params)
  • get(tokenId)
• blacklist
  • create(params)
  • get(blacklistRuleId)
  • delete(blacklistRuleId)
  • list([params])
• checkoutRequest
  • sign(checkoutRequestObjectOrJson)
• crossSaleOffers
  • create(params)
  • get(crossSaleOfferId)
  • update(crossSaleOfferId, params)
  • delete(crossSaleOfferId)
  • list([params])
• customerRecords
  • buy(params)
  • refresh(customerRecordId, [params])
  • get(customerRecordId)
  • list([params])
  • getFee(customerRecordId, customerRecordFeeId)
  • listFees(customerRecordId, [params])
  • getProfit(customerRecordId, customerRecordProfitId)
  • listProfits(customerRecordId, [params])

Developing

To connect to different backend:

var api = require('securionpay')('pk_test_myprivatekey', {
    url: 'http://mysecurionenv.com' // without trailing slash
});

To run unit tests and check test coverage:

npm test
npm run check-coverage

To run integration tests:

PRIVATE_KEY=pk_test_myprivatekey npm run integration-test

To run integration tests against environment other than default:

PRIVATE_KEY=pk_test_myprivatekey URL=http://mysecurionenv.com npm run integration-test