# node-gocardless-billin

> NodeJS SDK for gocardless.com API

Latest version **1.2.1** (published 2019-01-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install node-gocardless-billin
pnpm add node-gocardless-billin
yarn add node-gocardless-billin
bun add node-gocardless-billin
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.1 |
| Published | 2019-01-02 |
| First published | 2018-12-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=4 |
| Dependencies | 3 |
| Unpacked size | 120.9 KB |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| Author | Manuel Sirvent |
| Maintainers | msirvent |

## Links

- npm: https://www.npmjs.com/package/node-gocardless-billin
- npm.io page: https://npm.io/package/node-gocardless-billin

## Dependencies (3)

- [request](https://npm.io/package/request.md) 2.65.0
- [bluebird](https://npm.io/package/bluebird.md) 2.10.2
- [babel-preset-stage-3](https://npm.io/package/babel-preset-stage-3.md) ^6.24.1

## Recent versions

- 1.2.1 (latest) — 2019-01-02
- 1.2.0 — 2018-12-28

## README

# GoCardless Node.js Library

Supports the redirection flow API at the time of writing.

## Simple steps

1. Instantiate GoCardless with your access_token.
2. Create a redirection flow
3. User fills in information on GoCardless
4. User is redirected to your success_url
5. Complete redirection flow

### 1. Instantiate GoCardless

```javascript
var GoCardless = require('GoCardless');

var config = {
	sandbox: true, //optional
	token: 'YOUR_SECRET_ACCESS_TOKEN'
};

var goCardless = new GoCardless(config);

```

### 2. Create a redirection flow

```javascript
var description = 'optional description';
var sessionToken = 'userSessionToken';
var successUrl = 'http://example.com/gocardless/success';

goCardless.startRedirectFlow(description, sessionToken, successUrl)
	.then(function (response){
		console.log(response);
	});
```

this logs : 
```
{ redirect_flows: 
   { id: 'RE00001VVBSW46DZSK57ZKK7V654C6T3',
     description: 'optional description', // can be null
     session_token: 'userSessionToken',
     scheme: null,
     success_redirect_url: 'http://example.com/gocardless/success',
     created_at: '2015-10-23T13:52:42.921Z',
     links: { creditor: 'CR00003Q16V7D3' },
     redirect_url: 'https://pay-sandbox.gocardless.com/flow/RE00001VVBSW46DZSK57ZKK7V754C6T3' } }

```

### 5. Complete redirection flow

Once the user has finished entering his information on the GoCardless website, he will be redirected to the `success_redirect_url` with the `redirect_flow_id` as a query parameter.

At this point, you must complete the mandate creation process by calling `completeRedirectionFlow`.

```javascript
goCardless.completeRedirectFlow(req.query.redirect_flow_id, sessionId)
		.then(function (response){
			console.log(response);
		});
```

this will log : 

```javascript
{
    "redirect_flows": {
        "id": "RE00001VVBSW46DZSK57ZKK7V564C6T3",
        "description": "optional description",
        "session_token": "userSessionToken",
        "scheme": null,
        "success_redirect_url": "http://example.com/gocardless/success",
        "created_at": "2015-10-23T13:52:42.921Z",
        "links": {
            "creditor": "CR00002Q17V7D5",
            "mandate": "MD0000AW8TF1K9",
            "customer": "CU0000CSEVM5FQ",
            "customer_bank_account": "BA0000AMYWF8MK"
        }
    }
}
```

---
_Source: https://npm.io/package/node-gocardless-billin · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._