Node SDK

      Node SDK

        Article Summary


        Buckaroo is the the Payment Service Provider for all your online payments with more than 15,000 companies relying on Buckaroo's platform to securely process their payments, subscriptions and unpaid invoices. Buckaroo developed their own Node SDK. The SDK is a modern, open-source Node.js library that makes it easy to integrate your Javascript application with Buckaroo's services.
        Start accepting payments today with Buckaroo.

        NODE SDK


        • A Buckaroo account (Dutch or English)
        • Node.js 6.14.× or higher

        GitHub repository

        Click here to view the Node SDK on the Buckaroo Github repository.


        npm install @buckaroo/buckaroo_sdk


        Initiate the buckaroo client with your website key and secret key.

        import { initializeBuckarooClient } from './BuckarooClient'
        initializeBuckarooClient({ websiteKey: 'KEY', secretKey: 'SECRET' })

        Create a payment with all the available payment methods. In this example, we show how to create a credit card payment. Each payment has a slightly different payload.

        import creditCard from './PaymentMethods/CreditCard'
        const payment = await creditCard().pay({
            amountDebit: 10,
            name: 'Mastercard',
            invoice: 'UNIQUE-INVOICE-NO'

        After you create a transaction, you can retrieve several transaction information on demand.

        const transactionKey = payment.Key
        import { buckarooClient } from './BuckarooClient'
        buckarooClient().status(transactionKey) // Retrieve transaction status
        buckarooClient().refundInfo(transactionKey) // Retrieve refund info
        buckarooClient().cancelInfo(transactionKey) // Retrieve cancellation info


        We really appreciate it when developers contribute to improve the Buckaroo plugins.
        If you want to contribute as well, then please follow our Contribution Guidelines.


        • MAJOR: Breaking changes that require additional testing/caution
        • MINOR: Changes that should not have a big impact
        • PATCHES: Bug and hotfixes only

        Please contact Buckaroo support if you have any technical questions.  

        Our telephone number and contact details of other departments can be found in the Buckaroo Payment Plaza under "Contact details" at the bottom left of the screen.

        Was this article helpful?

        What's Next