Tarabut Portal

Get Data via Direct Input

Suggest Edits

Tarabut Developer Portal

Direct Input API: Manual User Creation & Transaction Ingestion

Overview:
The Tarabut platform provides two methods for transaction aggregation: through the Connect feature and via our Direct Input API. For partners who already possess their end-users' transactional data, the Direct Input API is the preferred method.

Before diving into the manual process, it's recommended to familiarize yourself with the intricate technical details associated with direct ingestion, available in our API reference.

Table of Contents

1. Create a Client Access Token

Instructions Here you would provide detailed steps on how to create a client access token. This can include code snippets, required parameters, headers, and any related information.

2. Create a User

Instructions Detailed steps on how to create a user. Ensure you cover the necessary endpoints, required data, and any other relevant information.

3. Ingest Transactions

Instructions Guide developers through the process of ingesting transactions for the created user. Provide any code examples, recommended practices, and pertinent details.

Additional Resources

  • API Reference - Dive deep into the technical details required for direct ingestion.

POST Categorisation

🚧

Pre- requisite

Generate a token using the Generate Access Token endpoint.

Link your first account using Link your first account endpoint

When you generate an access token, you need to define a customerUserId that is linked with the end-user.

📘

Note: Transaction history length

By default Tarabut will fetch 1 year's worth of transaction from the linked account. However it's worth noting, the history length we can fetch may depend on a bank by bank basis.

curl --location --request POST 'https://api.sandbox.tarabutgateway.io/ingest/v1/enrich' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {valid-tg-token}' \
--data-raw '{
  {
  "transactions": [
    {
      "transactionId": "1",
      "transactionDescription": "PURCHASE         SHIEN JEDDAH SA",
      "amount": {
        "value": 140.90,
        "currency": "SAR"
      },
      "creditDebitIndicator": "Debit",
      "transactionDateTime": "2021-12-22T01:59:30.208+00:00"
    },{
      "transactionId": "2",
      "transactionDescription": "ECOMM NETFLIX.COM",
      "amount": {
        "value": 400.00,
        "currency": "SAR"
      },
      "creditDebitIndicator": "Debit",
      "transactionDateTime": "2021-12-22T01:59:30.208+00:00"
    }
  ],
  "accountId": "BH62KHCB00200000008526",
  "accountProductType": "account",
  "providerId": "BLUE"
}
  ],
  "accountId": "BH62BLUE00200000008527",
  "accountProductType": "account",
  "providerId": "KHCB"

A successful GET transaction request returns with the first page of the categorised transaction history from the selected account.

[
    {
        "merchant": {
            "name": "SHEIN",
            "logo": "https://tg-merchants-prod.s3.me-south-1.amazonaws.com/merchant/24b89d52ea2c7160527c21d994932404.svg"
        },
        "transactionId": "3696a98f-3eaf-35d4-a64c-064691e80c09",
        "category": {
            "group": "Expense",
            "name": "Shopping",
            "icon": "https://tg-merchants-prod.s3.me-south-1.amazonaws.com/category/EXPENSE_SHOPPING.svg"
        },
          {
        "merchant": {
            "name": "NETFLIX",
            "logo": "https://tg-merchants-prod.s3.me-south-1.amazonaws.com/merchant/24b89d52ea2c7160527c21d994932567.svg"
        },
        "transactionId": "3696a98f-3eaf-35d4-a64c-064691e80c09",
        "category": {
            "group": "Expense",
            "name": "Shopping",
            "icon": "https://tg-merchants-prod.s3.me-south-1.amazonaws.com/category/EXPENSE_SHOPPING.svg"
        },
]

Updated 5 months ago