Skip to content
brite docs
  • Technical Documentation
    Implementation Guidelines
    Implementation Guidelines

    Detailed guidelines on how to do a technical integration with Brite

    Read more

    Developer API image
    Developer API

    Technical documentation needed for offering the Britest payment solutions

    Read more

  • Checkout Guidelines
  • Marketing Guide
  • Implementation Guidelines
  • Developer API
  • Checkout Guidelines
  • Marketing Guide
  • FAQS
FAQS
Implementation Guidelines
  • Implementation Guidelines
Products
  • Brite Play
  • Brite Instant Payins
  • Brite Instant Payouts
  • Brite Data Solutions
Authorize as a merchant
  • Generate Token
  • Renew token
Brite Play
  • Brite Play
Brite Instant Payins
  • Brite Instant Payins
  • Recurring Deposits
  • Approve/Reject Deposit After Merchant Internal Check
Brite Instant Payouts
  • Brite Instant Payouts
  • Withdrawals using the Brite Client
  • Withdrawals using API-only
  • Create Reference Withdrawal
  • Time 2 Money (Withdrawal ETA)
  • Approve/Reject Withdrawal After Merchant Internal Check
KYC
  • KYC
Brite Blended
  • Brite Blended
Bank Account Selection
  • Create Bank Account Selection Session
Client Authentication
  • Create Authentication Session
Rendering the client
  • Rendering the client
Session handling
  • Session handling
Transaction handling
  • Transaction Handling
Check balance by API
  • Check balance by API
Http callbacks
  • Http Callbacks
Customer management
  • Customer management
Bank account management
  • Bank account management
Export functionality
  • Export to CSV
Error simulation in Sandbox
  • Erros Simulation in Sandbox
Error Codes
  • Aborted state errors
Brite in different Countries
  • Brite in different Countries
Brite on Native App or Mobile
  • Brite on Native App or Mobile
Brite integration test and verification
  • Brite integration test and verification
  • Home
  • Implementation Guideline
  • Transaction handling
  • Transaction Handling

Transaction Handling

Table of Contents
  • Transaction States
  • Get Transaction Details

The transaction handling API is used to get information on a specific ongoing or completed transaction. This API is also used to create withdrawals.

!Note. The system is NOT idepotent, hence calling the Brite API will always create a new transaction in the system.

The Brite API has a time-out of 60 seconds, hence anyone that implements the Brite API shall make sure to have a longer time out value, for example 65 seconds.

To add extra security, before re-triggering a transaction make sure to do a search for the merchant reference in the Brite system. If it does not exists it’s safe to create a new one.

Transaction States #

The get transaction state API call is used to get the current state of an ongoing transaction. Once the transaction state reaches settled, merchants can with certainty assume that the funds will be transferred.

API Reference: /api/transaction.state

The following states are possible to receive from the Get transaction state API:

NameIdDepositsWithdrawals
STATE_CREATED0The first state of a deposit transaction. Transaction is created after the user has completed the KYC and selected the account to be debited.The first state a withdrawal gets aftercreate_withdrawal is called.
STATE_PENDING1Occurs after merchant approval (ifapproval_required is set) and Brite risk engine (customer age, merchant blocklist, Brite blacklist) has been passed.Automatically after the transaction has been created or after merchant approval (if approval_required is set) or depending on the withdrawal rules set in Backoffice.
STATE_ABORTED2The deposit has been aborted for a known reason, e.g. the customer entered the payment flow but later decided to cancel, or because of a misconfiguration in the customer bank. Please note: The transaction can still be settled at a later stage, so callbacks should still be listened to.The withdrawal has been aborted for a known reason, e.g. the recipient account is invalid.
STATE_FAILED3The deposit failed for an unknown reason (or was manually failed by Brite). Please note: The transaction can still be settled at a later stage, so callbacks should still be listened to.The withdrawal failed for an unknown reason (or was manually failed by Brite).
STATE_COMPLETED4The deposit flow has finished without errors in the customer bank.The withdrawal flow has finished without errors in Brite’s bank.
STATE_CREDIT5Funds have not yet been settled, but the transaction was successful and a credit callback is sent from Brite. When the credit callback is received, the end user should be credited by the merchant. The transaction receives the state credit immediately after the state completed, unless the transaction amount exceeds the exposure limit (set in the Brite Backoffice, see Backoffice Guide) – then the credit callback will be sent just before the state Settled.The customer should be credited for the transaction. Occurs just before settlement.
STATE_SETTLED6Deposit funds have arrived in the Brite bank account. The final state for a deposit.Withdrawal funds have left the Brite bank account. The final state for a withdrawal.
STATE_DEBIT7When a deposit has been stuck in STATE_CREDIT for more than 15 days,the state will change to STATE_DEBIT and a deposit callback will be sent.Not applicable for Withdrawals.

Get Transaction Details #

The get transaction by id API call allows merchants to get detailed information on an ongoing or completed transaction. The response will include all relevant information for merchants to handle the transaction.

API Reference: 

/api/transaction.get

/api/transaction.get_by_merchant_reference

What are your Feelings
Still stuck? How can we help?

How can we help?

Updated on October 31, 2022
Table of Contents
  • Transaction States
  • Get Transaction Details

Brite
Linnégatan 5
114 47, Stockholm
Sweden

Phone: +46101888777

Brite

  • About Us
  • Careers
  • Cookies

Technical Documentation

  • Developer API
  • Implementation Guidelines

Marketing Guide

  • Assets
  • User Information

Checkout Guidelines

  • Checkout Guidelines

Contact

  • Merchant Support
  • Customer support
brite logomark gray
  • Privacy Policy
  • Terms & Conditions

Brite AB (corporate identity number: 559116-1632) is a licensed Payment Institution under the supervision of the Swedish Financial Supervisory Authority (Finansinspektionen). Brite AB provides payment services under the Swedish Payment Services Act (2010:751) as well as the EU Directive 2015/2366 about payment services in the internal market (PSD2) and has, upon notification, the authority to provide

YOUR COOKIE SETTINGS

We use cookies to provide the best experience.

 

You can find out more about which cookies we use, or switch them off by clicking `customise´. Here, you'll also find links to our Privacy Notice and Cookie Notice, which explain how we work with cookies and process your personal data.

 

Do you accept all cookies?

Privacy Overview

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.

Strictly Necessary Cookies

Strictly Necessary Cookie should be enabled at all times so that we can save your preferences for cookie settings.

3rd Party Cookies

This website uses Google Analytics, Leadfeeder, Hotjar, LinkedIn and Meta pixels to collect anonymous information such as the number of visitors to the site, and the most popular pages.

Keeping this cookie enabled helps us to improve our website.

Please enable Strictly Necessary Cookies first so that we can save your preferences!

Cookie Policy

Download our Cookie Notice.