API Documentation v2 (Beta)

Try it now: API Docs v2

We’re excited to launch API Docs v2 in beta, a refreshed version of our documentation designed to make it easier to understand and use our APIs.

Key improvements include:

• New structure by task and topic – The documentation has been reorganized so you can easily find relevant information at the right level of detail. Main sections include:

  • Solutions overview – High-level explanation of our Payments, Accounts, and other offerings
  • Core concepts – How our system works, including Payment lifecycle, Authentication and authorization, and Routing logic
  • How-to guides – Step-by-step instructions for common tasks, like Authenticating and retrieving accounts Initiating your first payment, and Creating your first Direct Debit Collection
  • Reference data – Lists of field values, codes, and identifiers
  • API Reference – Detailed request/response information for each endpoint

• Clearer, more detailed content – We've added new articles and updated many existing ones with improved structure and richer content, including the Sandbox section, Routing logic, Incoming payments, Reporting and reconciliation, and much more.

We recommend exploring v2 now to benefit from richer content and a more structured layout. The current documentation remains available, so you can reference the familiar version while getting acquainted with the new content.

During the beta phase, new features will be documented in both the existing version and v2. After the beta, the current version will be deprecated.