Integration
In-depth knowledge
Testing and Go-live
Integrate
Brite Play
In this guide we explain everything you need for your customers to sign-up and pay using Brite Play.
Authorization: Bearer <access_token>
POST /api/session.create_deposit HTTP/1.1
Host: sandbox.britepaymentgroup.com
Content-Type: application/json
Authorization: Bearer <YOUR_TOKEN>
{
"amount": 34.56,
"country_id": "se",
"brand_name": "My example brand",
"merchant_reference": "ORD-12345-ABC", // Your order id
"locale": "sv",
"deeplink_redirect": "myapp://open?screen=checkout&order_id=ORD-12345-ABC",
"redirect_uri": "https://merchant.com/payment?order_id=ORD-12345-ABC",
"callbacks": [
{
"url": "https://merchant.com/callback?kyc=true&order_id=ORD-12345-ABC",
"session_state": 2 // STATE_AUTHENTICATION_COMPLETED to start the approval or rejection
},
{
"url": "https://merchant.com/callback?kyc=true&order_id=ORD-12345-ABC",
"session_state": 10 // STATE_ABORTED to go back to authentication selection
},
{
"url": "https://merchant.com/callback?kyc=true&order_id=ORD-12345-ABC",
"session_state": 11 // STATE_FAILED to go back to authentication selection
},
{
"url": "https://merchant.com/callback?kyc=true&order_id=ORD-12345-ABC",
"session_state": 12 // STATE_COMPLETED to complete the session
},
{
"url": "https://merchant.com/callback/?order_id=ORD-12345-ABC",
"transaction_state": 2 // STATE_ABORTED to go back to payment selection
},
{
"url": "https://merchant.com/callback/?order_id=ORD-12345-ABC",
"transaction_state": 3 // STATE_FAILED to go back to payment selection
},
{
"url": "https://merchant.com/callback/?order_id=ORD-12345-ABC",
"transaction_state": 5 // STATE_CREDIT to credit the customer OR ship goods
},
{
"url": "https://merchant.com/callback/?order_id=ORD-12345-ABC",
"transaction_state": 7 // STATE_DEBIT to request new payment from customer
}
],
"approval_required": true
}
Here we highlight some parameters. For a full list of all parameters check out the API reference.
approval_required: true
This flag allows you to approve and reject an going session. This means that you essentially have control over which customer can complete a payment and which not.
true, Brite accepts a /session.approve or a session.reject request with the corresponding session_id. The request has to be sent in between the session states 2 and 5.
brand_name
The brand name is visible to the customer when using Brite Payments. You should choose a recognisable and relatable brand name here for a better experience. Note that even though there is no character limitation, Brite will show 31 characters in the smallest version of the client.
deeplink_redirect - recommended for mobile apps
When the customer returns from their mobile banking app or online banking, a Brite web application is opened to handle the returning customer. Note that this is particularly the case on mobile devices. Immediately after that Brite opens the link provided in deeplink_redirect. This way, the customer is basically redirected from their bank to the deeplink_redirect. The link should point to the view in your mobile app or web page on which the customer can continue the payment process using Brite.
You should add any relevant ids to the URL so that you can identify the respective purchase/order in your system.
Example for mobile apps: myapp://open?screen=checkout&order_id=ORD-12345-AB
Example for web pages: https://merchant.com/checkout?order_id=ORD-12345-AB
If you don't provide a deeplink_redirect the Brite web application closes itself without any further redirection. This will likely open the most recent tab or browser of the customer instead of opening the merchant app and feels to the customer as if they get “stuck”. From here, they have to manually retrieve the merchant app from the apps in the background.
{
"url": "https://sandbox.britepaymentgroup.com/eyJo[...]JhZTAwZDUwZiJ9",
"token": "eyJob3N0IjogImh0dHBzOi8vc2FuZGJveC5icml0ZXBheW1lbnRncZt[...]wZiJ9",
"id": "ag9ofmFib25lYS0xNzYyMTNyEQsSA1Nlc3Npb24Y0p6R0AEM"
}
DO NOT render this url inside an iframe. It is meant to be opened in a new window/tab. If you want to display Brite inside an iframe use the token in combination with the Brite Client javascript.
token with your front-end
The token is meant to be shared with your client (front-end). There you should use the client.js and create a new instance of new Brite('eyJ...').
More: https://docs.britepayments.com/technical-documentation/rendering-the-brite-client/
Example of a STATE_AUTHENTICATION_COMPLETED notification
POST /callback?kyc=true&order_id=ORD-12345-ABC
{
"merchant_id": "ag9ofmFib25lYS0xNzYyMTNyFQsSCE1lcmNoYW50GICAgID4woQKDA",
"session_id": "ag9ofmFib25lYS0xNzYyMTNyFAsSB1Nlc3Npb24YgICAjeqInQgM",
"session_state": 2 // STATE_AUTHENTICATION_COMPLETED
}
Request to get the session by session_id
POST /api/session.get
{
"id": "ag9ofmFib25lYS0xNzYyMTNyFAsSB1Nlc3Npb24YgICAjeqInQgM" // session_id
}
Response with the session details
{
...
// customer_id is available in the response once Brite identifies the customer
"customer_id": "ag9ofmFib25lYS0xNzYyMTNyFQsSCE1lcmNoYW50GICAgID4woQKDA"
...
}
Request to create the KYC based on the customer_id
POST /api/kyc.create HTTP/1.1
Host: sandbox.britepaymentgroup.com
Content-Type: application/json
Authorization: Bearer <YOUR_TOKEN>
{
// customer_id from the session.get response
"customer_id": "ag9ofmFib25lYS0xNzYyMTNyFQsSCE1lcmNoYW50GICAgID4woQKDA"
}
Response to the KYC request
{
"id": "ag9ofmFib25lYS0xNzYyMTNyEAsSA0tZQxiAgIDtjbL4CQw"
}
Request to fetch the KYC data based on the kyc_id
POST /api/kyc.get HTTP/1.1
Host: sandbox.britepaymentgroup.com
Content-Type: application/json
Authorization: Bearer <YOUR_TOKEN>
{
"id": "ag9ofmFib25lYS0xNzYyMTNyEAsSA0tZQxiAgIDtjbL4CQw" // id from the KYC request
}
Response with the KYC data
{
"firstname": "Maria",
"created": 1744706536.0,
"dob": "1986-03-07",
"lastname": "Gustafsson",
"completed": 1744706536.0,
"country_id": "se",
"state": 3,
"ssn": "198603076110",
"address": {
"city": "Borlänge",
"postal_code": "89640",
"street_address": "Parkvägen 38",
"country": "Sweden"
},
"customer_id": "ag9ofmFib25lYS0xNzYyMTNyFQsSCEN1c3RvbWVyGICAgM3erbwKDA",
"id": "ag9ofmFib25lYS0xNzYyMTNyEAsSA0tZQxiAgIDt0o_zCQw"
}
Example of a session.reject request
POST /api/session.reject HTTP/1.1
Host: sandbox.britepaymentgroup.com
Content-Type: application/json
Authorization: Bearer <YOUR_TOKEN>
{
"id": "ag9ofmFib25lYS0xNzYyMTNyFAsSB1Nlc3Npb24YgICAjeqInQgM" // session_id
"reason": "Duplicated account" // reason is only available for session.reject
}
