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 Direct
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
Database Consistency
Eventual Consistency in the Multi-Cloud and New Single-Cloud Stacks
Strong Consistency in the Legacy Single-Cloud Stack
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
Tasks
Outbound Payments
Create Payment
Submit Payment
Create and Submit Payment in One Call
Forwarding Payments
Receive Submission Notifications
Receive Task Notifications
Update a Payment Submission Task
Fetch a Payment Submission Task
Fetch Payment Submission
Fetch Payment
Inbound Payments
Receive Admission Notifications
Receive Task Notifications
Update a Payment Admission Task
Fetch a Payment Admission Task
Fetch Payment Admission
Fetch Payment
List all Payments
Payment Returns
Overview
API Resource Types and Endpoints
Payment Returns
Payment Return Submissions
Payment Return Admissions
Tasks
Outbound Returns
Create Return
Submit Return
Receive Submission Notifications
Receive Task Notifications
Update a Payment Return Submission Task
Fetch a Payment Return Submission Task
Fetch Return Submission
Fetch Return
Inbound Returns
Receive Notifications
Fetch Return Admission
Fetch Return
Payment Return Reversals
Overview
API Resource Types and Endpoints
Payment Return Reversals
Payment Return Reversal Admissions
Inbound Return Reversals
Receive Notifications
Fetch Return Reversal Admission
Fetch Return Reversal
Payment Reversals
Overview
API Resource Types and Endpoints
Payment Reversals
Payment Reversal Admissions
Tasks
Inbound Reversals
Receive Admission Notifications
Receive Task Notifications
Update a Reversal Admission Task
Fetch Reversal Admission Task
Fetch Reversal Admission
Fetch Reversal
Bank Accounts
Overview
API Resource Types and Endpoints
Accounts
Account Identifications
Branches
Branch Identifications
Accounts
Create an Account
Fetch an Account
Update an Account
List all Accounts
Delete an Account
Event Notification
Account Number Generation
Account Identifications
Create an Account Identification
Fetch an Account Identification
Update an Account Identification
List all Account Identifications
Delete an Account Identification
Branches
Create a Branch
Fetch a Branch
Update a Branch
List all Branches
Delete a Branch
Branch Identifications
Create a Branch Identification
Fetch a Branch Identification
Update a Branch Identification
List all Branch Identifications
Delete a Branch Identification
Confirmation of Payee
Overview
API Resource Types and Endpoints
Name Verifications
Name Verification Submissions
Name Verification Admissions
Outbound Name Verification Requests
Create and Submit Name Verification Request
Fetch Name Verification
Inbound Name Verification Requests
Receive Notifications
Fetch Name Verification Admission
Fetch Name Verification
List all Name Verifications
reports
Overview
FPS Reports
MIDEP Reports
Confirmation of Payee Reports
API Resource Types and Endpoints
Reports
Report Admissions
Inbound Reports
Receive Notifications
Fetch a Report Admission
Fetch a Report
Download a Report
List all Reports
Scheme Messages
Overview
API Resource Types and Endpoints
Scheme Messages
Scheme Message Admissions
List all Scheme Messages
Inbound Scheme Messages
Receive Notifications
Fetch a Scheme Message
Fetch a Scheme Message Admission
Net Sender Cap Position
List the Current NSC Position
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
Payment Return Reversals
Payment Reversals
Bank Accounts
Confirmation of Payee
reports
Scheme Messages
Net Sender Cap Position
validations
organisation
security
audits
metrics