Brite Instant Payments

Merchant authorisation

You need to authorise your access to Brite's APIs. For that follow the steps outlined in Merchant Authorisation. As a result, you have an access_token which you add to your requests to the Brite APIs.

Authorization: Bearer <access_token>

The request includes several data points, not all of which are required. However, we highly recommend adding them as outlined in the sample request here. Providing the data can improve the overall UX for the customer and also your own as it allows you to identify and relate payments better with orders in your system.

POST /api/session.create_deposit HTTP/1.1
Host: sandbox.britepaymentgroup.com
Content-Type: application/json
Authorization: Bearer <access_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",
  "customer_id": "ag1hYm9uZWEtMjQ5MDE0cg4LEghDdXN0b11lchgBDA",
  "customer_firstname": "John",
  "customer_lastname": "Doe",
  "customer_dob": "1980-01-01",
  "customer_email": "john.doe@example.com",
  "customer_address": {
    "city": "Stockholm",
    "street": "Main St 123",
    "postal_code": "12345",
    "country_id": "se"
  },
  "callbacks": [
    {
      "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": 4 // STATE_COMPLETED to confirm order.
    },
    {
      "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
    }
  ],
  "closed_loop": {
    "nin": "9108289910" // Only in SE and DK, otherwise remove
  }
}

Here we highlight some parameters. For a full list of all parameters check out the API reference.

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 not character limitation, Brite will show 31 characters in the smallest version of the client.

deeplink_redirect - only for embedded integrations

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