monzo-api v1.0.9

monzo-api

Node Monzo API easy integration

Instalation

npm i monzo-api -S

Usage

import MonzoApi from 'monzo-api';

const clientId = 'your-app-client-id';
const clientSecret = 'your-app-client-secret';
const verificationCode = 'code-that-server-gets-after-the-redirection';
const verificationStateToken = 'state-token-received-in-query-string-after-redirection';
const monzoApi = new MonzoApi(clientId, clientSecret);

monzoApi.redirectUrl = 'http://127.0.0.1/monzo-validation';

console.log('Redirect the user to', monzoApi.authorizationUrl);

monzoApi.authenticate(code, 'exampleStateToken')
        .then((res) => {
            console.log("Congrats, you're logged in", res);
        })
        .catch((err) => {
            console.error('Uh Oh! Something wrong happened. :(');
            console.error(err);
        });

Documentation

• MonzoApi
  • new MonzoApi(clientId, clientSecret)
  • .clientId
  • .clientId ⇒ string
  • .clientSecret
  • .clientSecret ⇒ string
  • .redirectUrl
  • .redirectUrl ⇒ string
  • .refreshToken
  • .refreshToken ⇒ string
  • .accessToken
  • .accessToken ⇒ string
  • .code ⇒ string
  • .stateToken ⇒ string
  • .stateToken ⇒ string
  • .authorizationUrl ⇒ string
  • .generateStateToken() ⇒ String
  • .authenticate(code, stateToken, [verifyStateToken]) ⇒ Promise.<object, Error>
  • .refreshAccess([refreshToken]) ⇒ Promise.<object, Error>
  • .ping([acessToken]) ⇒ Promise.<object, Error>
  • .accounts([acessToken]) ⇒ Promise.<object, Error>
  • .balance(accountId, [acessToken]) ⇒ Promise.<object, Error>
  • .transaction(transactionId, [expanded], [acessToken]) ⇒ Promise.<object, Error>
  • .transactions(accountId, [expanded], [query], [acessToken]) ⇒ Promise.<object, Error>
  • .annotate(transactionId, metadata, [acessToken]) ⇒ Promise.<object, Error>
  • .feedItem(accountId, [url], [type], [params], [acessToken]) ⇒ Promise.<object, Error>
  • .registerWebhook(accountId, url, [acessToken]) ⇒ Promise.<object, Error>
  • .webhooks(accountId, [acessToken]) ⇒ Promise.<object, Error>
  • .deleteWebhook(webhookId, [acessToken]) ⇒ Promise.<object, Error>
  • .uploadImage(file, fileName, fileType) ⇒ Promise.<object, Error>
  • .registerAttachment(externalId, fileUrl, fileType, [acessToken]) ⇒ Promise.<object, Error>
  • .deregisterAttachment(attachmentId, [acessToken]) ⇒ Promise.<object, Error>
  • .makeRequest(requestType, requestEndpoint, requestData, [useBearer]) ⇒ Promise.<object, Error>

new MonzoApi(clientId, clientSecret)

Create a monzo api instance.

monzoApi.clientId

Set the clientId value.

Kind: instance property of MonzoApi

monzoApi.clientId ⇒ string

Get the clientId value.

Kind: instance property of MonzoApi Returns: string - The clientId value.

monzoApi.clientSecret

Set the clientSecret value.

Kind: instance property of MonzoApi

monzoApi.clientSecret ⇒ string

Get the clientSecret value.

Kind: instance property of MonzoApi Returns: string - The clientSecret value.

monzoApi.redirectUrl

Set the redirectUrl value.

Kind: instance property of MonzoApi

monzoApi.redirectUrl ⇒ string

Get the redirectUrl value.

Kind: instance property of MonzoApi Returns: string - The redirectUrl value.

monzoApi.refreshToken

Set the refreshToken value.

Kind: instance property of MonzoApi

monzoApi.refreshToken ⇒ string

Get the refreshToken value.

Kind: instance property of MonzoApi Returns: string - The refreshToken value.

monzoApi.accessToken

Set the accessToken value.

Kind: instance property of MonzoApi

monzoApi.accessToken ⇒ string

Get the accessToken value.

Kind: instance property of MonzoApi Returns: string - The accessToken value.

monzoApi.code ⇒ string

Get the code value. It will be set when authenticate method gets called

Kind: instance property of MonzoApi Returns: string - The code value.

monzoApi.stateToken ⇒ string

Get the stateToken value. Value that will be matched against the one provided when a user authenticates. The values must match otherwise the authentication won't proceed

Kind: instance property of MonzoApi Returns: string - The stateToken value.

monzoApi.stateToken ⇒ string

Set the stateToken

Kind: instance property of MonzoApi Returns: string - The stateToken value.

monzoApi.authorizationUrl ⇒ string

Get the authorizationUrl value. The user needs to be redirected to this url in order to authenticate

Kind: instance property of MonzoApi Returns: string - The authorizationUrl value.

monzoApi.generateStateToken() ⇒ String

Create a state token that gets send on the authorizationUrl

Kind: instance method of MonzoApi Returns: String - The token value that was stored and needs to be compared on authorization

monzoApi.authenticate(code, stateToken, verifyStateToken) ⇒ Promise.<object, Error>

Authenticate the user given the code and the stateToken found in the query string of the redirectUrl

Kind: instance method of MonzoApi Returns: Promise.<object, Error> - A promise that returns an object if resolved, or an Error if rejected.

monzoApi.refreshAccess(refreshToken) ⇒ Promise.<object, Error>

Refreshes the user access token using the refresh one

Kind: instance method of MonzoApi Returns: Promise.<object, Error> - A promise that returns an object if resolved, or an Error if rejected.

monzoApi.ping(acessToken) ⇒ Promise.<object, Error>

Pings the API to check whether everything is correct

Kind: instance method of MonzoApi Returns: Promise.<object, Error> - A promise that returns an object if resolved, or an Error if rejected.

monzoApi.accounts(acessToken) ⇒ Promise.<object, Error>

Returns the accounts for the authenticated user

Kind: instance method of MonzoApi Returns: Promise.<object, Error> - A promise that returns an object if resolved, or an Error if rejected.

monzoApi.balance(accountId, acessToken) ⇒ Promise.<object, Error>

Reads the balance

Kind: instance method of MonzoApi Returns: Promise.<object, Error> - A promise that returns an object if resolved, or an Error if rejected.

monzoApi.transaction(transactionId, expanded, acessToken) ⇒ Promise.<object, Error>

Returns an individual transaction, fetched by its id.

Kind: instance method of MonzoApi Returns: Promise.<object, Error> - A promise that returns an object if resolved, or an Error if rejected.

monzoApi.transactions(accountId, expanded, query, acessToken) ⇒ Promise.<object, Error>

List transactions

Kind: instance method of MonzoApi Returns: Promise.<object, Error> - A promise that returns an object if resolved, or an Error if rejected.

monzoApi.annotate(transactionId, metadata, acessToken) ⇒ Promise.<object, Error>

Annotate transaction. You may store your own key-value annotations against a transaction in its metadata.

Kind: instance method of MonzoApi Returns: Promise.<object, Error> - A promise that returns an object if resolved, or an Error if rejected.

monzoApi.feedItem(accountId, url, type, params, acessToken) ⇒ Promise.<object, Error>

Creates a new feed item on the user’s feed. Check https://monzo.com/docs/#feed-items for the params details

Kind: instance method of MonzoApi Returns: Promise.<object, Error> - A promise that returns an object if resolved, or an Error if rejected.

monzoApi.registerWebhook(accountId, url, acessToken) ⇒ Promise.<object, Error>

Webhooks allow your application to receive real-time, push notification of events in an account. Each time a matching event occurs, monzo will make a POST call to the URL you provide. If the call fails, monzo will retry up to a maximum of 5 attempts, with exponential backoff.

Kind: instance method of MonzoApi Returns: Promise.<object, Error> - A promise that returns an object if resolved, or an Error if rejected.

monzoApi.webhooks(accountId, acessToken) ⇒ Promise.<object, Error>

List the webhooks your application has registered on an account.

Kind: instance method of MonzoApi Returns: Promise.<object, Error> - A promise that returns an object if resolved, or an Error if rejected.

monzoApi.deleteWebhook(webhookId, acessToken) ⇒ Promise.<object, Error>

Delete a webhook

Kind: instance method of MonzoApi Returns: Promise.<object, Error> - A promise that returns an object if resolved, or an Error if rejected.

monzoApi.uploadImage(file, fileName, fileType) ⇒ Promise.<object, Error>

Hosts an image in Monzo S3 Bucket. Will try to gzip the contents before uploading it

Kind: instance method of MonzoApi Returns: Promise.<object, Error> - A promise that returns an object if resolved, or an Error if rejected.

monzoApi.registerAttachment(externalId, fileUrl, fileType, acessToken) ⇒ Promise.<object, Error>

Register attachment

Kind: instance method of MonzoApi Returns: Promise.<object, Error> - A promise that returns an object if resolved, or an Error if rejected.

monzoApi.deregisterAttachment(attachmentId, acessToken) ⇒ Promise.<object, Error>

Deregister attachment

Kind: instance method of MonzoApi Returns: Promise.<object, Error> - A promise that returns an object if resolved, or an Error if rejected.

monzoApi.makeRequest(requestType, requestEndpoint, requestData, useBearer) ⇒ Promise.<object, Error>

Makes any request to the Monzo API

Kind: instance method of MonzoApi Returns: Promise.<object, Error> - A promise that returns an object if resolved, or an Error if rejected.