@buckaroo/buckaroo_sdk

Node SDK

---

Index

• About
• Requirements
• Installation
• Example
• Contribute
• Versioning
• Additional information

---

About

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.

Requirements

To use the Buckaroo API client, the following things are required:

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

Installation

npm install @buckaroo/buckaroo_sdk

Example

Initiate the buckaroo client with your website key and secret key. The keys can be retrieved from your Buckaroo account.

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

Find our full documentation online on docs.buckaroo.io.

Need more examples?

More examples can be found in the examples folder

Contribute

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.

Versioning

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

Additional information

• Support: https://support.buckaroo.eu/contact
• Contact: [e-mail] or [phone]

License

Buckaroo Node.js SDK is open-sourced software licensed under the MIT license.

Changelog

[0.9.0]

• Beta release.