Moneyhub API Client

Introduction

This is an Node.JS client for the Moneyhub API. It currently supports the following features:

Getting the list of supported banks
Registering users
Deleting users
Generating authorisation urls for new and existing users
Getting access tokens and refresh tokens from an authorisation code
Refreshing access tokens
Deleting user connections
Getting access tokens with client credentials
CRUD actions for accounts
CRUD actions for transactions
Generate authorisation url for payments
Add Payees
Get Payees and payments
Get categories
CRUD actions on projects
CRUD actions on transaction attachments
CRUD actions on transaction splits
Get a tax return for a subset of transactions
Get the regular transactions on an account
Get beneficiaries

Currently this library supports client_secret_basic, client_secret_jwt and private_key_jwt authentication.

Upgrading from 3.x

The breaking changes when upgrading are outlined below:

Normalisation of all methods to use object destructuring to pass parameters. Please refer to the docs of each method when migrating to this version
Delete methods only return the status code when succesful
All methods to retrieve data return the body response as json, on previous versions some methods were returning the full response from the got library.
When our API response code is not 2xx an HTTP error is thrown. Includes a response property with more information.
Removal of all the methods with the suffix WithToken. To migrate to this version you can use the method with the same name but without the suffix. e.g getUserConnectionsWithToken() => getUserConnections()

For the full list of changes please refer to the changelog

Changelog

Learn about the latest improvements and breaking changes.

Prerequisites

To use this API client you will need:

A client_id, client_secret and redirect_uri of a registered API client
The url of the Moneyhub identity service for the environment you are connecting to (https://identity.moneyhub.co.uk)
The url for the API gateway for the environment that you are connecting to (https://api.moneyhub.co.uk/v2.0)

To install

npm install @mft/moneyhub-api-client

Usage

This module exposes a single factory function that accepts the following configuration:

const Moneyhub = require("@mft/moneyhub-api-client")
const moneyhub = await Moneyhub({
  resourceServerUrl: "https://api.moneyhub.co.uk/v2.0",
  identityServiceUrl: "https://identity.moneyhub.co.uk",
  options: { // optional
    timeout: 60000
  }
  client: {
    client_id: "your client id",
    client_secret: "your client secret",
    token_endpoint_auth_method: "client_secret_basic",
    id_token_signed_response_alg: "RS256",
    request_object_signing_alg: "none",
    redirect_uri: "https://your-redirect-uri",
    response_type: "code",
    keys: [
      /* your jwks */
    ],
  },
})

Once the api client has been initialised it provides a simple promise based interface with the following methods:

Auth API

`getAuthorizeUrl`

This method returns an authorize url for your API client. You can redirect a user to this url, after which they will be redirected back to your redirect_uri.

Financial institutions

Scopes

Claims

const url = await moneyhub.getAuthorizeUrl({
  scope: "openid bank-id-scope other-data-scopes",
  state: " your state value", // optional
  nonce: "your nonce value", //optional
  claims: claimsObject, // optional
  permissions: ["ReadBeneficiariesDetail"] // optional - set of extra permissions to set for auth URL
})

// Default claims if none are provided
const defaultClaims = {
  id_token: {
    sub: {
      essential: true,
    },
    "mh:con_id": {
      essential: true,
    },
  },
}

`getAuthorizeUrlForCreatedUser`

This is a helper function that returns an authorize url for a specific user to connect to a specific bank. This function uses the following scope with the value of the bankId provided id:${bankId} openid.

Financial institutions

Scopes

Claims

const url = await moneyhub.getAuthorizeUrlForCreatedUser({
  bankId: "bank id to connect to",
  userId: "user id returned from the registerUser call",
  state: "your state value", // optional
  nonce: "your nonce value", // optional
  claims: claimsObject, // optional
  permissions: ["ReadBeneficiariesDetail"] // optional - set of extra permissions to set for auth URL
})

// Scope used with the bankId provided
const scope = `id:${bankId} openid`

// Default claims if none are provided
const defaultClaims = {
  id_token: {
    sub: {
      essential: true,
      value: userId, // userId provided
    },
    "mh:con_id": {
      essential: true,
    },
  },
}

`getReauthAuthorizeUrlForCreatedUser`

This is a helper function that returns an authorize url for a specific user to re authorize and existing connection. This function uses the scope openid reauth.

const url = await moneyhub.getReauthAuthorizeUrlForCreatedUser({
  userId: "the user id",
  connectionId: "connection Id to re authorize",
  state: "your state value", // optional
  nonce: "your nonce value", // optional
  claims: claimsObject, // optional
})

// Default claims if none are provided
const defaultClaims = {
  id_token: {
    sub: {
      essential: true,
      value: userId, // userId provided
    },
    "mh:con_id": {
      essential: true,
      value: connectionId, // connectionId provided
    },
  },
}

`getRefreshAuthorizeUrlForCreatedUser`

This is a helper function that returns an authorize url for a specific user to refresh and existing connection. This function uses the scope openid refresh. (Only relevant for legacy connections)

const url = await moneyhub.getRefreshAuthorizeUrlForCreatedUser({
  userId: "the user id",
  connectionId: "connection Id to re refresh",
  state: "your state value", // optional
  nonce: "your nonce value", // optional
  claims: claimsObject, // optional
})

// Default claims if none are provided
const defaultClaims = {
  id_token: {
    sub: {
      essential: true,
      value: userId, // userId provided
    },
    "mh:con_id": {
      essential: true,
      value: connectionId, // connectionId provided
    },
  },
}

`exchangeCodeForTokensLegacy`

This is a legacy method to get tokens for a user. After a user has succesfully authorised they will be redirected to your redirect_uri with an authorization code. You can use this to retrieve access, refresh and id tokens for the user.

const tokens = await moneyhub.exchangeCodeForTokens({
  code: "the authorization code",
  nonce: "your nonce value", // optional
  state: "your state value", // optional
  id_token: "your id token", // optional
})

`exchangeCodeForTokens`

After a user has succesfully authorised they will be redirected to your redirect_uri with an authorization code. You can use this method to retrieve access, refresh and id tokens for the user.

The signature for this method changed in v3. The previous function is available at 'exchangeCodeForTokensLegacy'

This method requires an object with two properties:

paramsFromCallback : an object with all the params received at your redirect uri
localParams : an object with params that you have in the local session for the user.

const tokens = await moneyhub.exchangeCodeForTokens({
  paramsFromCallback: {
    "code": "the auth code",
    "id_token": "the id_token", // when code id_token response type is used
    "state": "state",
  },
  localParams: {
    "state": "state", // this must be from the local session not the redirect uri
    "nonce": "nonce", // this must be from the local session
    "sub": "the user id", // optional, but without this param, requests where there are missing cookies will fail
    "max_age", // optional, not normally required
    "response_type" // recommended to enhance securirty
    "code_verifier" // required if PKCE is used
  }
})

`getClientCredentialTokens`

Use this to get a client credentials access token.

const tokens = await moneyhub.getClientCredentialTokens({
  scope: "the-required-scope",
  sub: "the user id", // optional
})

`refreshTokens`

Use this to get a new access token using a refresh token

const tokens = await moneyhub.refreshTokens({
  refreshToken: "refresh-token",
})

Auth Request URI

`requestObject`

Creates a request object

const tokens = await moneyhub.requestObject({
  scope: "the-required-scope",
  state: "state",
  nonce: "nonce,
  claims: claimsObject,
})

`getRequestUri`

Use this to create a request uri from a request object

const tokens = await moneyhub.getRequestUri(
  requestObject
)

`getAuthorizeUrlFromRequestUri`

Use this to retrieve an authorization url from a request uri

const tokens = await moneyhub.getAuthorizeUrlFromRequestUri({
  requestUri: "request-uri"
})

Auth Requests

`createAuthRequest`

Creates a connection auth request

const tokens = await moneyhub.createAuthRequest({
  redirectUri: "redirect-uri,
  userId: "user-id",
  scope:"openid 1ffe704d39629a929c8e293880fb449a", // replace bank id with the bank you want to connect to
  categorisationType: "personal", // optional - defaults to personal
  permissions: ["ReadBeneficiariesDetail"] // optional - set of extra permissions to set for auth request
})

Creates a reauth auth request

const tokens = await moneyhub.createAuthRequest({
  redirectUri: "redirect-uri,
  userId: "user-id",
  connectionId: "connection-id",
  scope:"openid reauth",
})

Creates a refresh auth request

const tokens = await moneyhub.createAuthRequest({
  redirectUri: "redirect-uri,
  userId: "user-id",
  connectionId: "connection-id",
  scope:"openid refresh",
})

Creates a payment auth request

const tokens = await moneyhub.createAuthRequest({
  redirectUri: "redirect-uri,
  userId: "user-id",
  connectionId: "connection-id",
  scope:"openid payment",
  payment: {
    payeeId: "payee-id",
    amount: 200,
    payeeRef: "Payee ref,
    payerRef: "Payer ref"
  },
})

Creates a reverse payment auth request

const tokens = await moneyhub.createAuthRequest({
  redirectUri: "redirect-uri,
  userId: "user-id",
  connectionId: "connection-id",
  scope:"openid reverse_payment",
  reversePayment: {
    paymentId: "payment-id"
  },
})

`completeAuthRequest`

Completes an auth request succesfully

const tokens = await moneyhub.completeAuthRequest({
  id: "auth-request-id",
  authParams: {
    code: "code"
    state: "state",
    "id_token": "idToken",
  }
})

Completes an auth request with an error

const tokens = await moneyhub.completeAuthRequest({
  id: "auth-request-id",
  authParams: {
    error: "error-code",
    "error_description": "error description"
  }
})

`getAllAuthRequests`

Retrieves auth requests

const tokens = await moneyhub.getAllAuthRequests({
  limit: 10, // optional
  offset: 0 // optional
})

`getAuthRequest`

Retrieve a single auth request

const tokens = await moneyhub.getAuthRequest({
  id: "auth-request-id"
})

User Management

`registerUser`

Helper method that gets the correct client credentials access token and then registers a user.

const user = await moneyhub.registerUser({
  clientUserId: "your user id" /* optional */
})

`getUsers`

Returns all the users registered for your api-client

const users = await moneyhub.getUsers({
  limit,
  offset,
  isDemo
  })

`getUser`

Get a single user by their id

const user = await moneyhub.getUser({
  userId: "user-id"
  })

`deleteUser`

Helper method that gets the correct client credentials access token and then deletes a user.

const user = await moneyhub.deleteUser({
  userId: "user-id"}
  )

User Connections

`getUserConnections`

Helper method that gets the correct client credentials access token and then gets all user connections.

const user = await moneyhub.getUserConnections({
  userId: "user-id"
  })

`syncUserConnection`

Sync an existing user connection. This process will fetch the latest balances and transactions of the accounts attached to the connection. This method only returns the status of the syncing.

const tokens = await moneyhub.syncUserConnection({
  userId,
  connectionId,
  customerIpAddress, // optional
  customerLastLoggedTime, // optional
})

`deleteUserConnection`

Helper method that gets the correct client credentials access token and then deletes a user connection.

const user = await moneyhub.deleteUserConnection({
  userId: "user-id",
  connectionId: "connection-id"
  })

Data API

`getAccounts`

Get all accounts for a user. This function uses the scope accounts:read.

const queryParams = {limit: 10, offset: 5}
const accounts = await moneyhub.getAccounts({
  userId: "userId",
  params: queryParams,
  })

`getAccountsWithDetails`

Get all accounts for a user including extra details (sort code, account number, account holder name). This function uses the scopes accounts:read accounts_details:read.

const queryParams = {limit: 10, offset: 5}
const accounts = await moneyhub.getAccountsWithDetails({
  userId: "userId",
  params: queryParams
  })

`getAccount`

Get a single account for a user by the accountId. This function uses the scope accounts:read.

const account = await moneyhub.getAccount({
  userId: "userId",
  accountId: "accountId"
  })

`getAccountWithDetails`

Get a single account for a user by the accountId including extra details (sort code, account number, account holder name). This function uses the scope accounts:read accounts_details:read.

const account = await moneyhub.getAccountWithDetails({
  userId: "userId",
  accountId: "accountId"
  })

`getAccountBalances`

Get account balances for a user. This function uses the scope accounts:read.

const account = await moneyhub.getAccountBalances({
  userId: "userId",
  accountId: "accountId"
  })

`getAccountHoldings`

Get account holdings for a user. This function uses the scope accounts:read.

const account = await moneyhub.getAccountHoldings({
  userId: "userId",
  accountId: "accountId"
  })

`getAccountHoldingsWithMatches`

Get account holdings with ISIN codes matchers for a user. This function uses the scope accounts:read.

const account = await moneyhub.getAccountHoldingsWithMatches({
  userId: "userId",
  accountId: "accountId"
  })

`getAccountHolding`

Get a single holding from a user's account. This function uses the scope accounts:read.

const account = await moneyhub.getAccountHolding({
  userId: "userId",
  accountId: "accountId",
  holdingId: "holdingId"
  })

`getAccountCounterparties`

Get account counterparties for a user. This function uses the scope accounts:read transactions:read.

const account = await moneyhub.getAccountCounterparties({
  userId: "userId",
  accountId: "accountId"
  })

`getAccountRecurringTransactions`

Get account recurring transactions for a user. This function uses the scope accounts:read transactions:read.

const account = await moneyhub.getAccountRecurringTransactions({
  userId: "userId",
  accountId: "accountId"
  })

`getAccountStandingOrders`

Get the standing orders for an account. This function uses the scope standing_orders:read and a connection with ReadStandingOrdersBasic permission.

const standingOrders = await moneyhub.getAccountStandingOrders({
  userId: "userId",
  accountId: "accountId"
  })

`getAccountStandingOrdersWithDetail`

Get the standing orders with detail (payee information) for an account. This function uses the scope standing_orders_detail:read and a connection with ReadStandingOrdersDetail permission.

const standingOrders = await moneyhub.getAccountStandingOrdersWithDetail({
  userId: "userId",
  accountId: "accountId"
  })

`createAccount`

Create a manual account for a user. This function uses the scopes accounts:read accounts:write:all

const account = await moneyhub.createAccount({
  userId: "userId",
  account: {
    accountName: "Account name",
    providerName: "Provider name",
    type: "cash:current",
    accountType: "personal",
    balance: {
      date: "2018-08-12",
      amount: {
        value: 300023
      }
    }
  }
})

`deleteAccount`

Delete a manual account for a user. This function uses the scope accounts:write:all

const result = await moneyhub.deleteAccount({
  userId: "userId",
  accountId: "accountId"
})

`getTransactions`

Get all transactions for a user. This function uses the scope transactions:read:all..

const queryParams = {limit: 10, offset: 5}
const transactions = await moneyhub.getTransactions({
  userId: "userId",
  params: queryParams
  })

`getTransaction`

Get a transaction by ID for a user. This function uses the scope transactions:read:all..

const transactions = await moneyhub.getTransaction({
  userId: "userId",
  transactionId: "transactionId"
})

`updateTransaction`

Update a transaction by ID for a user. This function uses the scopes transactions:read:all transactions:write:all..

const transactions = await moneyhub.updateTransaction({
  userId: "userId",
  transactionId: "transactionId",
  transaction: {
    amount: {
      value: 10
    }
  }
})

`addTransaction`

Add a transaction for a user. Please note, transaction must belong to an account that is transaction-able. This function uses the scopes transactions:read:all transactions:write:all..

const transactions = await moneyhub.addTransaction({
  userId: "userId",
  transaction: {
    amount: {
      value: 10
    }
  }
})

`addTransactions`

Add up to 50 transactions for a user. Please note, transaction must belong to an account that is transaction-able. This function uses the scopes transactions:read:all transactions:write:all.

const transactions = await moneyhub.addTransactions({
  userId: "userId",
  transactions: [
    {
      amount: {
        value: 10
      }
    },
    {
      amount: {
        value: 25
      }
    }
  ],
  params: {
    categorise: true // optional - enable categorisatio for transactions
  }
})

`deleteTransaction`

Delete a transaction for a user. This function uses the scopes transactions:write:all..

const result = await moneyhub.deleteTransaction({
  userId: "userId",
  id: "transactionId"
})

`getBeneficiaries`

Get all beneficiaries for a user. This function uses the scope beneficiaries:read

const queryParams = {limit: 10, offset: 5}
const beneficiaries = await moneyhub.getBeneficiaries({
  userId: "userId",
  params: queryParams
})

`getBeneficiariesWithDetail`

Get all beneficiaries for a user, including beneficiary detail. This function uses the scope beneficiaries_detail:read

const queryParams = {limit: 10, offset: 5}
const beneficiaries = await moneyhub.getBeneficiariesWithDetail({
  userId: "userId",
  params: queryParams
})

`getBeneficiary`

Get a beneficiary for a user. This function uses the scope beneficiaries:read

const beneficiary = await moneyhub.getBeneficiary({
  userId: "userId",
  id: "beneficiaryId"
})

`getBeneficiaryWithDetail`

Get a beneficiary for a user, including beneficiary detail. This function uses the scope beneficiaries_detail:read

const beneficiary = await moneyhub.getBeneficiaryWithDetail({
  userId: "userId",
  id: "beneficiaryId"
})

`addFileToTransaction`

Add an attachment to a transaction. This call requires an access token with a scope that allows it to read and write transactions. The third parameter must be a stream, and the size of the file being uploaded can be of max size 10MB.

const file = await money.addFileToTransaction({
  userId: "userId" ,
  transactionId: "transactionId",
  fileName: "file-name",
  fileData: fs.createReadStream("path/to/file.png"),
  })

`getTransactionFiles`

Get all attachments associated with a transaction. This call requires an access token with a scope that allows it to read transactions.

const files = await money.getTransactionFiles({
  userId: "userId" ,
  transactionId: "transactionId",
  })

`getTransactionFile`

Get an attachment associated with a transaction. This call requires an access token with a scope that allows it to read transactions.

const files = await money.getTransactionFile({
  userId: "userId" ,
  transactionId: "transactionId",
  fileId: "fileId",
  })

`deleteTransactionFile`

Delete an attachment associated with a transaction. This call requires an access token with a scope that allows it to read and write transactions.

await money.deleteTransactionFile({
  userId: "userId" ,
  transactionId: "transactionId",
  fileId: "fileId",
  })

`splitTransaction`

Split up a transaction into different categories and/or projects.

const splits = await moneyhub.splitTransaction({
    userId: "userId",
    transactionId: "transactionId",
    splits: [
      {
        "categoryId": "std:5a7ff1f3-cd2c-4676-a368-caf09f2ca35a",
        "description": "Split 1",
        "amount": -6000
      },
      {
        "categoryId": "std:eac238ec-3899-49ff-8cce-e3b9f4b1aede",
        "description": "Split 2",
        "amount": -4000
      }
    ]
})

`getTransactionSplits`

Get a transactions splits.

const splits = await moneyhub.getTransactionSplits({
    userId: "userId",
    transactionId: "transactionId"
})

`patchTransactionSplit`

Update a transaction's split's description, categoryId or projectId.

const splits = await moneyhub.patchTransactionSplit({
    userId: "userId",
    transactionId: "transactionId",
    split: {
      description: "New description"
    }
})

`deleteTransactionSplits`

Delete a transaction's splits and merge them back together.

const splits = await moneyhub.deleteTransactionSplits({
    userId: "userId",
    transactionId: "transactionId"
})

`getGlobalCounterparties`

Get global counterparties.

const accounts = await moneyhub.getGlobalCounterparties()

`getCategories`

Get all categories for a user. This function uses the scope categories:read.

const categories = await moneyhub.getCategories({
  userId: "userId",
  params: {
    type: "personal" // optional personal|business
    },
  })

`getCategory`

Get a single category for a user. This function uses the scope categories:read.

const category = await moneyhub.getCategory({
  userId: "userId",
  categoryId: "categoryId"
  })

`getCategoryGroups`

Get all category groups for a user. This function uses the scope categories:read.

const categoryGroups = await moneyhub.getCategoryGroups({
  userId: "userId",
  params: {
    type: "personal" // optional personal|business
    },
  })

`getStandardCategories`

Get standard categories.

const categories = await moneyhub.getStandardCategories({
  params: {
    type: "personal" // optional personal|business|all
    },
  })

`getStandardCategoryGroups`

Get standard categories.

const categoryGroups = await moneyhub.getStandardCategoryGroups({
  params: {
    type: "personal" // optional personal|business|all
    },
  })

`createCustomCategory`

Create a custom category. This function uses the scopes categories:read categories:write.

const category = await moneyhub.createCustomCategory({
  userId: "userId",
  category: {
    group: "group:1"
    name: "custom-category",
    },
  })

Projects

`getProjects`

This method returns a list of projects. This function uses the scope projects:read

const projects = await moneyhub.getProjects({x
  userId: "userId",
  params: {
    limit: "limit", // optional
    offset: "offset", // optional
  } // optional
})

`getProject`

Get a single project for a user by the projectId. This function uses the scope projects:read.

const project = await moneyhub.getProject({
  userId: "userId",
  projectId: "projectId"
  })

`addProject`

Create a new project for a user. This function uses the scope projects.write. This will return the new project.

const project = await moneyhub.addProject({
  userId: "userId",
  project: {
    name: "Project Name",
    accountIds: "id1,id2", // comma-separated list of account IDs
    type: "PropertyProject",
  }
})

`updateProject`

Update a project for a user. This function uses the scope projects.write. This will return the newly updated project.

const project = await moneyhub.updateProject({
  userId: "userId",
  projectId: "projectId",
  project: {
    name: "Updated Project Name",
    accountIds: "id1,id2", // comma-separated list of account IDs
    type: "PropertyProject",
    archived: false,
  }
})

`deleteProject`

Delete a project for a user given a project ID. This function uses the scope projects.delete.

const result = await moneyhub.deleteProject({
  userId: "userId",
  projectId: "projectId"
  })

Tax Return

`getTaxReturn`

Get a tax return object for a subset of transactions. This makes use of the enhancedCategories on transactions. This functions uses the scope tax:read

const result = await moneyhub.getTaxReturn({
  userId: "userId",
  params: {
    startDate: "2020-01-01",
    endDate: "2020-02-01",
    accountId: "accountId",
    projectId: "projectId",
  }
})

Payments

`getPaymentAuthorizeUrl`

This is a helper function that returns an authorize url to authorize a payment to the payee with the bank selected. This function uses the following scope with the value of the bankId provided payment openid id:${bankId}. It also requires the authentication to be client_secret_jwt or private_key_jwt.

const url = await moneyhub.getPaymentAuthorizeUrl({
  bankId: "Bank id to authorise payment from", // required
  payeeId: "Id of payee", // required
  payeeType: "Payee type [api-payee|mh-user-account]", // optional - defaults to api-payee
  payerId: "Id of payer", // required only if payerType is defined
  payerType: "Payer type [mh-user-account]", // required only if payerId is used
  amount: "Amount in pence to authorize payment",
  payeeRef: "Payee reference",
  payerRef: "Payer reference",
  payerName: "Payer Name", // optional
  payerEmail: "Payer Email", // optional
  state: "your state value",
  nonce: "your nonce value", // optional
  context: "Payment context [Other,BillPayment,PartyToParty]", // optional - defaults to PartyToParty
  userId: "Moneyhub API User ID you wish to attach to the payment" // optional
  claims: claimsObject, // optional
})

// Scope used with the bankId provided
const scope = `payment openid id:${bankId}`

// Default claims if none are provided
const defaultClaims = {
  id_token: {
    "mh:con_id": {
      essential: true,
    },
    "mh:payment": {
      essential: true,
      value: {
        amount,
        payeeRef,
        payerRef,
        payeeId,
        payeeType,
        payerId,
        payerType,
        payerName,
        payerEmail,
      },
    },
  },
}

`getReversePaymentAuthorizeUrl`

This is a helper function that returns an authorize url to authorize a reverse payment for a payment that is reversible. This function uses the following scope with the value of the bankId provided reverse_payment openid id:${bankId}. It also requires the authentication to be client_secret_jwt or private_key_jwt.

const url = await moneyhub.getReversePaymentAuthorizeUrl({
  bankId: "Bank id to authorise payment from",
  paymentId: "Id of payment to reverse",
  state: "your state value",
  nonce: "your nonce value", // optional
  claims: claimsObject, // optional
})

// Scope used with the bankId provided
const scope = `reverse_payment openid id:${bankId}`

// Default claims if none are provided
const defaultClaims = {
  id_token: {
    "mh:con_id": {
      essential: true,
    },
    "mh:payment": {
      essential: true,
    },
    "mh:reversePayment": {
      essential: true,
      value: {
        paymentId
      },
    },
  },
}

`addPayee`

This method will add a Payee. This will return an id that it is required to be used as payeeId when initiating a payment. This function uses the scope payee:create

const payee = await moneyhub.addPayee({
  accountNumber: "your account number",
  sortCode: "your sort code",
  name: "name of Payee",
  externalId: "your external id",
})

`getPayees`

This method returns a list of registered payees. This function uses the scope payee:read

const payees = await moneyhub.getPayees({
  limit: "limit", // optional
  offset: "offset", // optional
})

`getPayments`

This method returns a list of initiated payments. This function uses the scope payment:read

const payments = await moneyhub.getPayments({
  limit: "limit", // optional
  offset: "offset", // optional
  userId: "user-id", // optional
  payeeId: "payee-id", // optional
  startDate: "2020-01-01", // optional
  endDate: "2020-12-31", // optional
})

`getPayment`

Get a single payment by its id . This function uses the scope payment:read

const paymentData = await moneyhub.getPayment({
  id: "payment-id",
})

`getPaymentFromIDToken`

When a payment flow is completed and you call exchangeCodeForTokens you will receive back an ID Token that contains the payment id. This is a utility function to get the payment data using the id in the ID Token.

const paymentData = await moneyhub.getPaymentFromIDToken({
  idToken: "eyJhbGciOiJSUz..."
  })

Standing Orders

`getStandingOrderAuthorizeUrl`

This is a helper function that returns an authorize url to authorize a standng order to the payee with the bank selected. This function uses the following scope with the value of the bankId provided standing_orders:create openid id:${bankId}. It also requires the authentication to be client_secret_jwt or private_key_jwt.

const url = await moneyhub.getStandingOrderAuthorizeUrl({
  bankId: "Bank id to authorise payment from", // required
  payeeId: "Id of payee", // required
  payeeType: "Payee type [api-payee|mh-user-account]", // optional - defaults to api-payee
  payerId: "Id of payer", // required only if payerType is defined
  payerType: "Payer type [mh-user-account]", // required only if payerId is used
  reference: "The reference for standing order",
  frequency: {
    repeat: "The frequency to repeat the standing order [Daily,Weekly,Monthly]",
    day: "The number of the day on which to repeat the payment", // required if repeat is Weekly or Monthly
    week: "The number of the week on which to repeat the payment",
    onlyWorkDays: "Specifies whether the payment should only be made on working days",
  }
  numberOfPayments: "The number of payments to complete the standing order", // required if finalPaymentDate is not specified
  firstPaymentAmount: "Amount in pence for the first payment",
  recurringPaymentAmount: "Amount in pence for all repeating payments", // optional when it is the same as the first amount
  finalPaymentAmount: "Amount in pence for the final payment", // optional when it is the same as the first amount
  currency: "The currency code for the standing order amount [GBP]",
  firstPaymentDate: "The date to make the first payment", // should be in an international format, e.g. 15-MAR-2021 or ISO date
  recurringPaymentDate: "The date to make the first repeating payment",
  finalPaymentDate: "The date to make the final payment", // required if numberOfPayments is not specified
  state: "your state value",
  nonce: "your nonce value", // optional
  context: "Payment context [Other,BillPayment,PartyToParty]", // optional - defaults to PartyToParty
  claims: claimsObject, // optional
})

// Scope used with the bankId provided
const scope = `standing_orders:create openid id:${bankId}`

// Default claims if none are provided
const defaultClaims = {
  id_token: {
    "mh:con_id": {
      essential: true,
    },
    "mh:standing_order": {
      essential: true,
      value: {
        payeeId,
        payeeType,
        payerId,
        payerType,
        reference,
        frequency,
        numberOfPayments,
        firstPaymentAmount,
        recurringPaymentAmount,
        finalPaymentAmount,
        currency,
        firstPaymentDate,
        recurringPaymentDate,
        finalPaymentDate,
        context,
      },
    },
  },
}

`getStandingOrders`

This method returns a list of initiated standing orders. This function uses the scope payment:read

const standingOrders = await moneyhub.getStandingOrders({
  limit: "limit", // optional
  offset: "offset", // optional
  userId: "user-id", // optional
  payeeId: "payee-id", // optional
  startDate: "2020-01-01", // optional
  endDate: "2020-12-31", // optional
})

`getStandingOrder`

Get a single standing order request by its id. This function uses the scope payment:read

const standingOrder = await moneyhub.getStandingOrder({
  id: "standing-order-id",
})

`getRegularTransactions`

Get all the regular transactions for a user, there is an option to pass an account ID as a parameter as a filter. This function uses the scope accounts:read, transactions:read:all and regular_transactions:read

const queryParams = {accountID}
const regulartransactions = await moneyhub.getRegularTransactions({
  userId: "userId",
  params: queryParams,
})

Financial Connections

`listConnections`

This method will resolve with a list of all the available connections (banks, etc.) that a user can connect to.

const availableConnections = await moneyhub.listConnections()

`listAPIConnections`

This method will resolve with a list of all the API connections that a user can connect to.

const availableConnections = await moneyhub.listAPIConnections()

`listTestConnections`

This method will resolve with a list of all the Test connections that a user can connect to.

const availableConnections = await moneyhub.listTestConnections()

OpenID Config

`getOpenIdConfig`

This method will resolve with our open id configuration.

const availableConnections = await moneyhub.getOpenIdConfig()

Examples

We have a couple of examples under the /examples folder that can be helpful to start using our client.

Running Tests

Instructions on how to run the integration tests for the API client can be found here