Welcome to

Brite Documentation

Welcome to the Brite implementation guide. Here, you will find detailed product information that outlines the features and capabilities of our API, ensuring you have a clear picture of its potential.

For a seamless setup process, follow our integration articles, which provide step-by-step instructions and best practices. Read our in-depth knowledge articles to gain a deeper understanding of the API’s technical intricacies.

Plus, we offer testing information to help you validate the implementation, ensuring reliability and performance in your payment solutions. Use this guide and its resources as your roadmap for successfully integrating and leveraging our API to its full potential.

The documentation is divided into the following parts:

01.

Get started

Here you will find all information you need to get started.

02.

Products

Information about the products we offer and applicable use cases.

03.

Integration

How to integrate our products.

04.

In-depth knowledge

Deep dive into the solutions and functionality.

05.

Testing and Go-live

Testing use cases and go-live checklist.

Architecture

Rest API

Our REST API solution is designed to enhance system integration and real-time data interaction through the use of webhooks. The REST API facilitates seamless communication between your applications and our services, enabling you to request and retrieve data as needed. Webhooks are employed to provide real-time notifications to your application whenever specific events occur, eliminating the need for frequent polling and ensuring immediate data updates.

Brite Client

Brite Client incorporates a JavaScript SDK to seamlessly integrate Brite Client functionality into customer interfaces using an iframe. This setup enables the embedding of our application directly within customer websites, providing a streamlined and cohesive user experience. The Brite Client facilitates secure interactions and data exchanges within the iframe, ensuring that the integration is both efficient and secure, adhering to modern web standards.

Authentication

Our system utilises OAuth 2.0, primarily a delegation protocol, to manage authentication. It allows applications to securely obtain tokens that enable them to act on behalf of users, ensuring secure access without directly handling user identities. This implementation aligns with industry standards for secure and efficient user authentication.

API endpoints

Production Endpoint: Used for real-world traffic and actual usage.  https://production.britepaymentgroup.com
Sandbox Endpoint: Used for testing, development, and experimentation. https://sandbox.britepaymentgroup.com

Next up: Integrate a product

On this page