Skip to main content
API Reference
SEPA Credit Transfer
SEPA Instant
SEPA Direct Debit
FPS Direct
Bacs Paying Bank & Origination
FPS and SEPA Indirect via LHV
Cross Currency
SWIFT
US Instant
Tutorials
Staging Environment
Resources
Swagger File
Postman Collection
Release Log
API Status
Search
/
API Reference
Tutorials
Staging Environment
Resources
FPS and SEPA Indirect via LHV
introduction
Overview
Endpoint Connection
Actions and HTTP Methods
Overview
Separation of Transaction and Flow Data
Headers
URL Parameters
Message Body Structure
Data Section
Links Section
Errors and Status Codes
Timeouts, Rate Limiting and Retry Strategy
Rate Limiting
Retry Strategy
Receiving Notifications
Change Policy
authentication
Overview
Message Signature
Deprecated: OAuth-based Authentication
Creating an Access Token
Using an Access Token
Event Notifications
Overview
Setup
Domain Whitelisting
Webhooks
SQS
SQS with Server Side Encryption
Create a Subscription
Subscription Filters
Nested arrays
Operators
Common Use Cases
Fetch a Subscription
Update a Subscription
List all Subscriptions
Delete a Subscription
Common Event Subscriptions
Notification Messages
Handling Delivery Errors
Connection Timeout
Exponential Backoff
List all Subscription Delivery Errors
Reactivate Subscriptions
Signature Verification
Receive Notifications
Fetch a Signing Key
List all Signing Keys
payments
Overview
API Resource Types and Endpoints
Payments
Payment Submissions
Payment Admissions
Outbound Payments
Create FPS Payment
Create SEPA Payment
Submit Payment
Receive Notifications
Inbound Payments
Receive Admission Notifications
Fetch a Payment Admission
Fetch a Payment
List all Payments
Payment Returns
Overview
API Resource Types and Endpoints
Payment Returns
Payment Return Submissions
Payment Return Admissions
Outbound Returns
Create Return
Submit Return
Receive Notifications
Inbound Returns
Receive Notifications
Fetch Return Admission
Fetch Return
balances
Overview
List Balances
Bank Accounts
Overview
API Resource Types and Endpoints
Account Requests
Account Request Submissions
Account Amendments
Account Amendment Submissions
Account Events
Accounts
Fetch an Account
List all Accounts
Event Notification
Account Requests
Create a Virtual Account Request
Create an Agency Account Request
Submit an Account Request
Receive Notifications
List all Account Requests
Account Amendments
Create an Account Amendment
Submit an Account Amendment
Receive Notifications
List all Account Amendments
Account Events
List all Account Events
Account Data Requirements
reports
Overview
Inbound Reports
Receive Notifications
Download a Report
Fetch a Report Admission
Fetch a Report
List all Reports
validations
Overview
Account Number Validation
Sort Code Validation
organisation
Overview
API Resource Types and Endpoints
Organisations
Create an Organisation
Fetch an Organisation
Update an Organisation
List all Organisations
security
Overview
Security Considerations
Users
Create a User
Fetch a User
Update a User
Delete a User
Add a Role to a User
Remove a Role from a User
Generate new Credentials for a User
Fetch User Credentials
Remove User Credentials
List all Users
List all Roles of a User
List all Access Control Entries of a User
Roles
Create a Role
Fetch a Role
Delete a Role
List all Roles
Access Control Entries
Actions
Record Types
Create an Access Control Entry
Fetch an Access Control Entry
Delete an Access Control Entry
List all Access Control Entries
audits
Overview
Fetch an Audit Entry
List Multiple Audit Entries
Pagination
metrics
Overview
Headers
Query
Query using GET
Query using POST
Federate
Query Range
Query Range using GET
Query Range using POST
API Docs index
introduction
authentication
Event Notifications
payments
Payment Returns
balances
Bank Accounts
reports
validations
organisation
security
audits
metrics