This website uses cookies so that we can provide you with the best user experience possible. Cookie information is stored in your browser and performs functions such as recognising you when you return to our website and helping our team to understand which sections of the website you find most interesting and useful.
Service Presentation API
The Service Presentation API is designed to provide you with seamless access to customised image and text assets, ensuring a optimised checkout experience. Providing a great user experience is key to encouraging your customers to adopt Pay by Bank. When you make the checkout process simple and clear, more people are likely to use it and stick with it
Benefits
User Experience: Simplify the checkout process to minimise confusion and enhance overall user experience, leading to higher conversion rates.
Easy Integration: Effortlessly integrate with minimal setup, reducing manual efforts and allowing for automated updates.
Continuous Optimisation: Brite continuously learns and optimises the assets, refining the service presentation to boost adoption and conversion — no manual adjustments needed. One integration ensures you stay future-proofed, benefiting from Brite’s ongoing UX enhancements.
Query Parameters
| merchant_id (Required) | Vertical (Not required) | product_type (Required) | locale (Required) |
|---|---|---|---|
| Unique ID to identify your business. If you don’t know your merchant_id, contact the Merchant Solutions Team. | Your business type: ecommerce, gaming, marketplace, financialServices. | Type of product: payment, payout, ais, or play. | Language code(ISO 639-1) + country code(ISO 3166-1 alpha-2). Example: en_BE. |
API Request
Endpoint
GET /assets
Content-Type
application/json
// example request
https://presentation.britepayments.io/v1/assets/?merchant_id=ag9ofmFib25lYS0yNDkwMDlyFQsSCE1lcmNoYW50GICAgKTihcstESTt&vertical=ecommerce&product_type=payment&locale=en_BE
API Response
// example response
{
"badge": "string",
"title": "string",
"tagline": "string",
"extended_descriptor_text": ["string"],
"bank_logos": ["string"]
}
Response Fields
| badge | title | tagline | extended_descriptor_text | bank_logos |
|---|---|---|---|---|
| URL to SVG. Where possible, our badge should be displayed at no less than 24px in height to ensure sufficient legibility. | Title of the service. | Brief description of the service. | Language code(ISO 639-1) + country code(ISO 3166-1 alpha-2). Example: en_BE. | Array of URLs to SVG. |
Response Codes
| 200 OK | 400 Bad request |
|---|---|
| Successful request with the requested data. | Invalid request due to missing or incorrect query parameters. |
Usage Tips
Include all required parameters in your request.
– Use correct ISO codes for country and language fields.
– The vertical parameter is optional but helps tailor the response.
– We recommend triggering the Service Presentation API in real-time, specifically upon the pageload of your checkout. This approach guarantees that the latest assets are fetched and displayed to the user immediately as they reach the checkout. Implementing the API call at this point ensures that the assets are fully loaded and ready, providing a seamless and enhanced user experience without delays.
Error Handling
– For 400 errors, check for missing or incorrect fields.
– Contact the Merchant Solutions Team for any other issues.