Overview

Welcome to 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. Integration articles provide step-by-step instructions and best practices for a seamless setup process. For those seeking a deeper understanding, our in-depth knowledge articles delve into the technical intricacies of the API’s operations. Lastly, we offer testing information to help you validate the implementation, ensuring reliability and performance in your payment solutions. This guide serves as your roadmap to a successful integration, providing all the necessary resources to leverage our API’s full potential.

The docs

The documentation is divided into the following parts:

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

Products – Information about the products we offer and applicable use cases.

Integrate – How to integrate our products.

In-depth knowledge – Deep dive into the solutions and functionality.

Testing and Go-live –  Testing use cases and go-live checklist. 

API Reference – Explore our API reference.

Architecture

Our REST API solution is designed to enhance system integration and real-time data interaction through the use of webhooks and a JavaScript SDK. 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

Our solution 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 utilizes 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