BuckarooSDK_NodeJS
Repository containing the Node.js SDK by Buckaroo
Installation
npm install buckaroo-sdk-nodejs
About
Buckaroo is 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.
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 >= 10.0.0
- Your website key and secret key
Example
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)
buckarooClient().refundInfo(transactionKey)
buckarooClient().cancelInfo(transactionKey)
Find our full documentation online on dev.buckaroo.nl.
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
License
Buckaroo Node.js SDK is open-sourced software licensed under the MIT license.