Transaction Enrichment

The Enrichment API is a separate service that, using the same authentication as main Pluggy services, enables customers that have already collected Open Finance data or have existing data from their customer base to enrich the transactional data by providing categorization and merchant information.

📘

Premium feature

To enable enrichment api, you must request this to the sales team to enable it for your team.

How to use

1. Obtain an API key from our Auth endpoint.
2. Use the categorization endpoint with the obtained API key, and send the transactions to categorize:
   Checking account exampleChecking account with payment dataCredit card example

   {
     "transactions": [
       {
         "id": "76a87d4d-89f2-4544-a431-b5d8a45146c7",
         "amount": -100, 
         "date": "2024-09-06T00:00:00-03:00",
         "description": "MC DONALDS"
       }
     ],
     "clientUserId": "06199323-763c-4b15-9f65-3871d8b4d430",
     "accountType": "CHECKING", // Optional: CHECKING or CREDIT_CARD
     "isBusiness": false // Optional: whether this is a PJ or PF account
   }
   

   {
     "transactions": [
       {
         "amount": -100,
         "date": "2024-09-06T00:00:00-03:00",
         "description": "MC DONALDS",
         "id": "76a87d4d-89f2-4544-a431-b5d8a45146c7",
         "paymentData": { // Optional. Allows us to cross with our companies & people data sources
           "payer": {
             "documentNumber": {
               "type": "CPF",
               "value": "203.381.531-52" // Can be formatted or just numbers
             }
           },
           "receiver": {
             "documentNumber": {
               "type": "CNPJ",
               "value": "42.591.651/0001-43" // Can be formatted or just numbers
             }
           }
         }
       }
     ],
     "clientUserId": "06199323-763c-4b15-9f65-3871d8b4d430",
     "accountType": "CHECKING", // Optional
     "isBusiness": false // Optional
   }
   

   {
     "transactions": [
       {
         "id": "76a87d4d-89f2-4544-a431-b5d8a45146c7",
         "amount": -100,
         "date": "2024-09-06T00:00:00-03:00",
         "description": "MC DONALDS",
         "creditCardMetadata": { // Optional: greatly improves categorization accurracy
           "payeeMCC": 1234
         }
       }
     ],
     "clientUserId": "06199323-763c-4b15-9f65-3871d8b4d430",
     "accountType": "CREDIT_CARD", // Optional
     "isBusiness": false, // Optional
   }
   

   You can send up to 5000 transactions per request.
3. The response will look something like this:
   Response

   {
       "results": [
           {
               "id": "76a87d4d-89f2-4544-a431-b5d8a45146c7", // Same ID as in request
               "amount": -100,
               "date": "2024-09-06T00:00:00-03:00",
               "description": "MC DONALDS",
               "type": "DEBIT",
               "merchant": { // This field can be null if unknown
                   "name": "mc donalds",
                   "businessName": "ARCOS DOURADOS COMERCIO DE ALIMENTOS LTDA",
                   "cnpj": "42.591.651/0001-43"
               },
               "category": "Eating out" // See possible values on our Transaction Categorization page
           }
       ]
   }