Skip to main content
API Reference
SEPA Instant & Credit Transfer
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
Tutorials
Getting Started
Worldwide Payment Access via the Form3 API
Form3 API
Specifications
Getting Started with the API
Send a Payment
Introduction
Prerequisites
Create the Payment
Submit the Payment
Track the Payment
Further reading
Create an Account
Bank Accounts at Form3
Step by step guide
Further Reading
Receive a Payment
Introduction
Prerequisites
Trigger an Inbound Payment
Receive the Inbound Payment
Further Reading
Payment Exception Handling
Payment Exception Handling
Receive Reports
Overview
Reports in the Form3 API
Step by Step Guide
Further Reading
platform
Send a Signed Request
Request Signing Process
Signed HTTP Request Format
Step by Step Guide
Troubleshooting
Subscriptions for Event Notifications
Overview
In the Form3 API
Recommended Use Cases
Test New or Updated Subscription Setups
Step by Step Guide
Further Reading
Verify Event Notifications
Overview
Retrieving and Storing Public Keys
What to Do When Encountering an Invalid Notification
Step by Step Guide
Code Examples
Further Reading
Create a Read-Only User
User permission management in Form3
Step-by-step guide
Authenticate with the Form3 API
Retrieve permissions from the sysadmin user
Create a new user
Create a new role with read-only permissions
Assign the role to the new user
Check the new user
Code example
Integrating with Form3 Metrics
Creating a User for Metrics API Access
Integration
Further Reading
Debug Request Signing
Overview
How to Use the Debug Endpoint
Python Example
FPS Direct
Receive Unsolicited Messages
USM Basics
Step by Step Guide
USMs from the Gateway
Examples of Common USMs
bacs
Receive a Direct Debit
Bacs Direct Debit basics
Direct Debits in the Form3 API
Step by step guide
Further Reading
Send Transactions in a File
Introduction
Prerequisites
Create a File
Send a File
Track the File
Further Reading
Return a Direct Debit with ARUDD
Returning Inbound Bacs Direct Debits (ARUDD)
Step by Step Guide
Further Reading
Return a Payment with ARUCS
About ARUCS and Returning Bacs Direct Credits
Step by Step Guide
Further Reading
Direct Debit Instructions for Paying Banks
Terminology
Direct Debit Instructions in Bacs
Direct Debit Instructions in the Form3 API
Step by step guide
Further Reading
Direct Debit Instructions for Originators
Terminology
Direct Debit Instructions in Bacs
Step by step guide
Further Reading
Direct Debit Indemnity Claims for Paying Banks
Bacs Direct Debit Indemnity Claims for Paying Banks
Step by step guide
Further Reading
SEPA Instant & CT
Payment Admission Tasks
Payment Admission Tasks Overview
Customer-Check Task
Step by Step Guide
Migrating from Non-Task to Tasks
Further Reading
Receive a Recall
Receive a Payment Recall
Step by step guide
Further Reading
Confirmation of Payee
Name Verification
Confirmation of Payee Overview
Further Reading
MI Reports
MI Report Basics
Report Column Overview
Cross Currency
Using the Cross Currency Service
Overview
Step by Step Guide
API Docs index
Getting Started
platform
FPS Direct
bacs
SEPA Instant & CT
Confirmation of Payee
Cross Currency