Tarabut handles the complexities involved with connecting with banks across the MENA region, including all connections and authentication methods that risk being updated at any notice.

When an end user has consented to share their financial data and authenticated via their selected bank, a JSON response is made available to you in minutes.

🚧

Pre- requisite

Generate a token using the Generate Access Token endpoint.

Link your first account using Link your first account endpoint

Get your Salary Report

Use the Link your first accountto allow your customers to initiate the account linking process.

The request will query salary transactions from all linked accounts from the user.

📘

Note: Account types that work with Salary API

Our model will only work with current and savings account. Any credit card account will be automatically excluded from identification process.

📘

Note: You can define the history length of salary lookup

By sending the months option <?months=3>, you can defined the length of the transaction history where we are looking for salary transactions.

We are defining each month as a completed month, e.g. today's date is 19 Apr (which means April is not a completed month). As a result the Salary API with the defaulted configuration of 3 months, will search for salaried transactions from the 1st Jan - 19th Apr.

curl --location --request GET 'https://api.sandbox.tarabutgateway.io/insights/v1/salary?months=3' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <your-access-token>' 

A successful GET Salary request returns a list of incoming transactions from all the linked accounts of the user.

{
  "salaries" : [
    {
    "salaryAmount": {
        "value": "4000.0",
        "currency":"SAR"
      },
      "bookingDateTime": "2023-10-01T00:00:00.000Z",
      "monthIndicator": 10
    },
    {
    "salaryAmount": {
        "value": "4005.0",
        "currency":"SAR"
      },
      "bookingDateTime": "2023-09-01T00:00:00.000Z",
      "monthIndicator": 9
    },
    {
    "salaryAmount": {
        "value": "4100.0",
        "currency":"SAR"
      }, 
     "bookingDateTime": "2023-08-01T00:00:00.000Z",
      "monthIndicator": 8
    }
  ]
}