Skip to content

Integration Guide

Main Navigation

Document Repository

Open Finance Standards

Integration Guide

Release Notes & Erratas

Sidebar Navigation

Getting Started

LFI Integration Journey

Recommended Bank Rollout Plan

Trust Framework

Overview & Organisations

Onboarding

Overview

Organisation Admins

Adding Users

User/Admin Sign Up

Roles

Servers

Overview

Creating a Server

API Resources

Overview

Creating an API resource

Meta Data

Applications

Overview

Creating C3-hh-cm-client

Keys & Certificates

Overview

Client Transport

Client Signing

Certificates with a SAN

Contacts

Trust Framework APIs

Overview

API Guide

API Reference

POST /token

GET /organisations

GET .../{OrganisationId}/softwarestatements

GET .../{OrganisationId}/authorisationservers

GET .../{AuthorisationServerId}/apiresources

GET /references/apifamilies

API Hub

Overview

Connectivity & Certificates

Onboarding

Overview

Prerequisites Questionnaire

Application Layer Authentication

Environment Specific

Overview

Certificate Walkthroughs

Ozone Connect Base URL

Authorization Endpoint

Configuring Authentication

mTLS — Server-side

mTLS — Client-side

JWT — Server-side

JWT — Client-side

Admin Portal

Overview

TPP Management & Activation

Logs

Reports

Headless Heimdall Auth Server

Overview

API Reference

Health Check

GET /hello-mtls

Authorization

GET /auth

POST /auth/{interactionId}/doConfirm

POST /auth/{interactionId}/doFail

Consent Manager

Overview

API Reference

Health Check

GET /hello-mtls

Consents

GET /consents

GET /consents/{consentId}

PATCH /consents/{consentId}

GET /consents/{consentId}/audit

GET /consent-groups/{consentGroupId}/consents

GET /psu/{userId}/consents

GET /accounts/{accountId}/consents

POST /consent-groups/{consentGroupId}/consents/action/revoke

POST /consents/{consentId}/action/revoke

Payment Log

GET /payment-log

PATCH /payment-log/{id}

Ozone Connect | Health Check

Overview

API Reference

GET /hello

GET /hello-mtls

GET /echo-cert

Ozone Connect | Consent Events

Overview

API Guide

API Reference

POST /consent/action/validate

POST /consent/event/{operation}

Ozone Connect | Banking

Overview

Data Sharing

Overview

Requirements

User Experience

API Guide

Overview

Pagination

Encrypted FinanceRates

API Reference

GET /accounts

GET /accounts/{AccountId}

GET /accounts/{AccountId}/balances

GET /accounts/{AccountId}/beneficiaries

GET /customer

GET /accounts/{AccountId}/customer

GET /accounts/{AccountId}/direct-debits

GET /accounts/{AccountId}/products

GET /accounts/{AccountId}/scheduled-payments

GET /accounts/{AccountId}/standing-orders

GET /accounts/{AccountId}/statements

GET /accounts/{AccountId}/transactions

Payments (Service Initiation)

Overview

Domestic Payments

Overview

Payment Rails and Status

Single Instant Payment

Requirements

User Experience

API Guide

Multi Payments

Variable On Demand

Requirements

User Experience

API Guide

Fixed On Demand

Requirements

User Experience

API Guide

Variable Periodic Schedule

Requirements

User Experience

API Guide

Fixed Periodic Schedule

Requirements

User Experience

API Guide

Variable Defined Schedule

Requirements

User Experience

API Guide

Fixed Defined Schedule

Requirements

User Experience

API Guide

Delegated SCA

Requirements

User Experience

API Guide

Personal Identifiable Information

Overview

Debtor Account

Creditor

API Guide

How to Decrypt PII

Verify TPP Signature (Optional)

API Schemas

PII (Consent - Consent Manager)

PII (Payments - Ozone Connect)

Multi Authorization

Refunds

Requirements

API Guide

API Reference

POST /payments

GET /payments/{PaymentId}

GET /payment-consents/{ConsentId}/refund

Confirmation of Payee

Overview

Requirements

User Experience

API Guide

API Reference

POST /customers/action/cop-query

Products & Leads

Overview

Requirements

API Guide

API Reference

GET /products

POST /leads

ATMs

Overview

Requirements

API Guide

API Reference

GET /atm

Consent Journey

Authentication

Overview

Requirements

Strong Customer Authentication

Implementation Guide

Authorization

Overview

Requirements

API Guide

Consent Management Interface

Overview

Requirements

User Experience

API Guide

Testing & Certification

Required Certifications

Overview

Functional Evidence

Bank Data Sharing

User Experience Evidence

Performance Testing

Security Validation

Production Live Proving

Attestation & Self Testing

TPP Buddying

Hello v2.1

Download .yaml Download .xlsx