Klaas API
Transactions Categorization

2min
This API is used to identify and categorize transactions.
POST
Request
Header Parameters
Content-Type
String
required
Must be 'application/json'
partner_code
String
required
Partner code
partner_token
String
required
Partner token
Body Parameters
uuid
String
required
UUID,unique identifier of partner user (for future billing purposes)
institutionCode
String
required
Institution Code, it should be the code in central bank
transactionSource
String
required
Transaction source,enum values: checking/creditcard. In case a user has transactions in both checking account and creditcard account, please POST Klavi API twice with different "transactionSource"
transactionDetails
Object
required
Transaction detail object
Curl
curl -X POST https://api-testing.klavi.ai/klaas/transaction/v2/category \
-H 'Content-Type: application/json' \
-H 'partner_code: 123xxx' \
-H 'partner_token: 2fd6cbcddeafd5ToRxbv8Q9UtfDMO' \
-d '{
    "uuid":"124eed4",
    "institutionCode":"208",
    "transactionSource":"checking",
    "transactionDetails":[
        {
            "transactionId":"0013a943abb6b72e6c6e45b8af063aa8e538b1d786fb",
            "transactionDate":"2022-02-09",
            "transactionName":"Creditamos o empréstimo pessoal do Mercado Crédito",
            "amount":500,
            "creditDebitType":"CREDITO",
            "transactionType":"OUTROS"
        },
        {
            "transactionId":"0013a943abb6b72e6c6e45b8af063aa8e538b1d786fc",
            "transactionDate":"2022-02-10",
            "transactionName":"ALIANCASUPERMERCADO",
            "amount":500,
            "creditDebitType":"CREDITO",
            "transactionType":"PAGAMENTO"
        }
    ]
}'
curl -X POST https://api-testing.klavi.ai/klaas/transaction/v2/category \
-H 'Content-Type: application/json' \
-H 'partner_code: 123xxx' \
-H 'partner_token: 2fd6cbcddeafd5ToRxbv8Q9UtfDMO' \
-d '{
    "uuid":"124eed4",
    "institutionCode":"208",
    "transactionSource":"checking",
    "transactionDetails":[
        {
            "transactionId":"0013a943abb6b72e6c6e45b8af063aa8e538b1d786fb",
            "transactionDate":"2022-02-09",
            "transactionName":"Creditamos o empréstimo pessoal do Mercado Crédito",
            "amount":500,
            "creditDebitType":"CREDITO",
            "transactionType":"OUTROS"
        },
        {
            "transactionId":"0013a943abb6b72e6c6e45b8af063aa8e538b1d786fc",
            "transactionDate":"2022-02-10",
            "transactionName":"ALIANCASUPERMERCADO",
            "amount":500,
            "creditDebitType":"CREDITO",
            "transactionType":"PAGAMENTO"
        }
    ]
}'
Responses
200
404
{
    "uuid":"124eed4",
    "institutionCode":"208",
    "transactionSource":"checking",
    "categoryDetails":[
        {
            "transactionId":"0013a943abb6b72e6c6e45b8af063aa8e538b1d786fb",
            "transactionDate":"2022-02-09",
            "transactionName":"Creditamos o empréstimo pessoal do Mercado Crédito",
            "amount":500,
            "creditDebitType":"CREDITO",
            "transactionType":"OUTROS",
            "category":"Prioridade financeira",
            "subcategory":"Empréstimo",
            "thirdCategory":"Empréstimo"
        },
        {
            "transactionId":"0013a943abb6b72e6c6e45b8af063aa8e538b1d786fc",
            "transactionDate":"2022-02-10",
            "transactionName":"ALIANCASUPERMERCADO",
            "amount":500,
            "creditDebitType":"CREDITO",
            "transactionType":"PAGAMENTO",
            "category":"Renda",
            "subcategory":"Outras transação de crédito",
            "thirdCategory":"Outras transação de crédito"
        }
    ]
}
{
    "uuid":"124eed4",
    "institutionCode":"208",
    "transactionSource":"checking",
    "categoryDetails":[
        {
            "transactionId":"0013a943abb6b72e6c6e45b8af063aa8e538b1d786fb",
            "transactionDate":"2022-02-09",
            "transactionName":"Creditamos o empréstimo pessoal do Mercado Crédito",
            "amount":500,
            "creditDebitType":"CREDITO",
            "transactionType":"OUTROS",
            "category":"Prioridade financeira",
            "subcategory":"Empréstimo",
            "thirdCategory":"Empréstimo"
        },
        {
            "transactionId":"0013a943abb6b72e6c6e45b8af063aa8e538b1d786fc",
            "transactionDate":"2022-02-10",
            "transactionName":"ALIANCASUPERMERCADO",
            "amount":500,
            "creditDebitType":"CREDITO",
            "transactionType":"PAGAMENTO",
            "category":"Renda",
            "subcategory":"Outras transação de crédito",
            "thirdCategory":"Outras transação de crédito"
        }
    ]
}
﻿
Response
You can see that this API only adds the following three fields to the categoryDetail object  in the request body.
Name
Type
Description
category
String
Transaction 1 level category
subcategory
String
Transaction 2 level category
thirdCategory
String
Transaction 3 level category
﻿
Name	Type	Description
category	String	Transaction 1 level category
subcategory	String	Transaction 2 level category
thirdCategory	String	Transaction 3 level category
Result and Code
Open Finance Analytics