https://github.com/gocardless/gocardless-nodejs
GoCardless Node.js client
https://github.com/gocardless/gocardless-nodejs
created-using-appetiser
Last synced: 2 months ago
JSON representation
GoCardless Node.js client
- Host: GitHub
- URL: https://github.com/gocardless/gocardless-nodejs
- Owner: gocardless
- License: mit
- Created: 2020-02-03T14:00:07.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-04-04T13:56:18.000Z (2 months ago)
- Last Synced: 2025-04-04T14:34:49.494Z (2 months ago)
- Topics: created-using-appetiser
- Language: TypeScript
- Size: 1.31 MB
- Stars: 29
- Watchers: 53
- Forks: 20
- Open Issues: 31
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Node.js client for the GoCardless API
[](https://github.com/gocardless/gocardless-nodejs/commits/master) [](https://badge.fury.io/js/gocardless-nodejs)
A Node.js client for the GoCardless API. For full details of the GoCardless API, see the [API docs](https://developer.gocardless.com/).
## Installation
```bash
$ npm i gocardless-nodejs
```
## Usage
### Initialising the client
To initialise the client, you must provide:
- An [access token](https://developer.gocardless.com/getting-started/api/making-your-first-request/#creating-an-access-token).
- The environment that this token is for (see [here](https://github.com/gocardless/gocardless-nodejs/blob/master/src/constants.ts) for a list of available environments).
- Any additional options (see [here](#available-client-options) for a list of supported options).
```js
const gocardless = require('gocardless-nodejs');
const constants = require('gocardless-nodejs/constants');
// Initialise the client.
const client = gocardless(
process.env.GC_ACCESS_TOKEN,
constants.Environments.Sandbox,
{ raiseOnIdempotencyConflict: true },
);
```
### The Basics
We'll illustrate the basic library usage by demonstrating on the [payment resource](https://developer.gocardless.com/api-reference/#core-endpoints-payments).
For a full list of available resources, visit the [GoCardless API reference](https://developer.gocardless.com/api-reference/#core-endpoints).
```js
const uuidv4 = require('uuid/v4');
// Create a new payment.
const payment = await client.payments.create(
{
amount: 100,
currency: "GBP",
links: { mandate: "MD123" },
},
{ uuidv4() },
);
// List the first three payments past a certain date.
const payments = await client.payments.list({
limit: 3,
created_at: {
gt: '2020-01-01T17:01:06.000Z',
},
});
// Get a payment.
const payment = await client.payments.find('PM123');
// Update a payment.
await client.payments.update('PM123', { amount: '22' });
// Cancel a payment.
await client.payments.cancel('PM123');
```
### The `all` method
All resources with a `list` method will also have an additional `*all` method. This method acts like the regular `list` method and accepts the same parameters, but instead returns an async generator.
```js
for await (const payment of client.payments.all()) {
console.log(payment.id);
}
```
### Available client options
- `raiseOnIdempotencyConflict`: set to `true` to raise exceptions on [idempotency](https://developer.gocardless.com/api-reference/#making-requests-idempotency-keys) conflicts. Defaults to `false`.