[![zip badge](]( [![codecov](](

Downloads in past


2.1.12 months ago3 years agoMinified + gzip package size for checkout-sdk-node in KB


zip badge codecov CI Tests Language grade: JavaScript

npm start

:rocket: Install
npm install checkout-sdk-node
:computer: Import
// ES6:
import { Checkout } from 'checkout-sdk-node';
// Common JS:
const { Checkout } = require('checkout-sdk-node');

If you don't have your API keys, you can sign up for a test account here.
:clapper: Initialize SDK

With api keys or access credentials

Based on how your account was set up, you will either have a pair or API key or a set of access credentials. Here is how you can use the SDK in both scenarios:
// API Keys
const cko = new Checkout('sk_XXXXXXXXX', {
    pk: 'pk_XXXXXXX'

// Access credentials
const cko = new Checkout('your api secret here', {
    client: 'ack_XXXXXXXX',
    scope: ['gateway'], // or whatever scope required
    environment: 'sandbox', // or 'production'

With environment variables

If your account uses API Keys (pkXXX + skXXX), you can set the following environment variables, and the SK will pick them up:
  • CKOSECRETKEY (with a value like skXXX)
  • CKOPUBLICKEY (with a value like pkXXX)

If you use access credentials (ackXXXX), you can set the following environment variables, and the SK will pick them up:
CKOCLIENT (with a value like ackXXXX)
  • CKOSCOPE (with a value of the scope or semicolon separated scopes in case you use multiple)
  • CKOENVIRONMENT (with a value like sandbox or production)

    Set custom config

    Basides the authentication, you also have the option to configure some extra elements about the SDK
    const cko = new Checkout('...', {
        ..., //other authentication config
        host: "", // in case you need to use a custom host for tests
        timeout: 60000,   // HTTP request timout in ms
        agent: new http.Agent({ keepAlive: true }) // custom HTTP agent
    :wrench: SDK Environment (Sandbox/Production)
    When using API Keys (pkXXX + skXXX) the SDK will automatically figure out what environment you are using however, if you use access credentials (ackXXXX), make sure you set the "environment" in the config, as shown above in the initialization.
    :interrobang: Error handling
    The SDK is using promises, and you can handle errors similar to any other HTTP call.
    try {
        // some async request made with the SDK
        const action = await cko.payments.request({...});
    } catch (error) {
        console.log(, error.http_code, error.body)
        switch ( {
    Here you have all the possible SDK specific errors:
    | | error.httpcode | error.body | | -------------------- | --------------- | ----------------------- | | AuthenticationError | 401 | undefined | | ActionNotAllowed | 403 | undefined | | UrlAlreadyRegistered | 409 | undefined | | NotFoundError | 404 | undefined | | BadGateway | 502 | undefined | | ValidationError | 422 | object | | TooManyRequestsError | 429 | object/undefined | | ValueError | 429 | string describing error |
    :book: Examples of usage
    You can see examples of how to use the SDK for every endpoint documented in our API Reference
    . All you have to do is to navigate to the endpoint you want to use, and select "Node" for the example on the right side.
    NOTE: If you use access credentials (ackXXXX) the link to the API reference relevant to you will be shared by your Solutions Engineers.
    :eyeglasses: Try it on RunKit
    You can try the SDK here.