Jump to Content

Home Documentation Recipes API Reference Changelog Discussions

Documentation

Home Documentation Recipes API Reference Changelog Discussions

Moneyhub Open Finance API

Moneyhub Open Finance API - Introduction

getting started

Getting Started
Admin Portal Sign Up
Create a Client
Ongoing Access
- User Management
- Authorisation
One Time Use
- Authorisation
Payments
- Authorisation
- Completing The Payment
Connect An Account
Querying Data

Overview

Admin Portal
- Admin Portal Access
- Admin Portal Users
API Clients
Illustrative Guides
Test our API
Troubleshooting
Available Bank Connections
Useful Links
Sample Code
Versioning
System Availability and Performance Metrics

Deep Dive

How to Use Pushed Authorisation Request (PAR) Endpoint
Creating an Authorisation URL
- Using Request Parameter
Scopes
Claims
Authentication
- Code examples
Mutual TLS Certificates
Completing a Connection
Client Credentials
API Businesses, Software & Certificates
IP Addresses of Moneyhub Services
Rate Limit
API Users
Auth Requests
Custom Consent Screens
POST /request (Request Object Endpoint)
Native and Mobile apps
Timeouts/Retries

Connections

Bank Connections
Accounts
Transactions
Statements
Beneficiaries
Standing Orders
Bank Chooser
Connection lifecycle
Connections Management
90 Day Reconsent
Connection Status
Zoopla
Autotrader
PayPal
Sensitive information

Payments

Account Verification
Single Immediate Payments
Recurring Payments (VRP)
Standing Orders
Payments Widgets

Data Categorisation & Enrichment

Categories and Category Groups
Categorising Transactions
- Categorisation as a Service
- Categorising Transactions for existing Users
Spending and Income Analysis
Spending and Income Goals
Counterparties (Merchants)
Tax Return
ISIN Code Matching
Transaction Splits via API
Historical balances
Regular Transaction Series
Rental Recognition
Financial Relationship Verification

PFM Widgets

PFM Widgets Overview
- PFM Widgets Architecture
Getting started with PFM Widgets
Our Widgets
- Accounts
- Connections

Webhooks

Webhooks Overview
- Webhook Format
New Transaction
Updated Transactions
Restored Transactions
Deleted Transactions
Deleted Account
Balance Threshold
Payment Pending
Payment Completed
Payment Error
Reauth Reminder
Refresh Reminder
Regular Transaction webhooks
Sync Complete
Post Connection Enrichment Complete
Affordability Report Success
Affordability Report Failure
Add first Connection

Coverage by Bank

Which banks return overdraft information?
Which banks and PSPs can I retrieve account holder name from?
Which banks support re-consent?

Widgets

Widgets Overview
Single Payment Widget
Pay Link Widget
- Create and Configure Pay Link Widget
- Create a Pay Link
Lending and Collections Widgets

Powered by

Test our API

We have a few ways to test our API. Please see the pages linked below in the what's next section.

Updated 11 months ago

What’s Next

Test Banks
Test API Users
Mock Bank Accounts
Adding a test user with sample data