Getting Started

The Node.JS SDK makes it easy to interact with the Unified Payments API. You can easily accept payments from cards, digital wallets and the most popular alternative payment methods, as well as pay out to a variety of destinations, all using the same integration.

codecov Build Status codebeat badge Try it on RunKit

Get a test account

If you are starting the integration process, and you want to start interacting with's API, you will need a test account, so you can get your API keys.


When you sign up for an account, you are given a secret and public API key pair. They will be used to initialise the SDK so you can interact with the various endpoints. You can find the keys by navigating to the's Hub Settings > Channels > API keys Section.

Unless required, most of the endpoints covered by the SDK only need the secret key, without the public key. If you do not use one of those endpoints that require the public key, you do not have to specify it when initializing the SDK.


Never share your secret keys. Keep them guarded and secure.

Payload and Responses

The SDK makes use of dynamic payloads both for the requests and for the API responses. If you want to see all the parameters that you can provide, as well as examples of possible responses, please follow the API Reference.