Enriquecimento de Transações

A Enrichment API é um serviço separado que, utilizando a mesma autenticação que os principais serviços da Pluggy, permite que clientes que já coletaram dados de Open Finance ou possuem dados existentes de sua base de clientes enriqueçam os dados transacionais fornecendo categorização e informações sobre comerciantes.

Recurso premium

Para habilitar a Enrichment API, você deve solicitar isso à equipe de vendas para habilitá-la para sua equipe.

Como usar #

Obtenha uma chave de API do nosso endpoint Auth.
Use o fluxo de categorização descrito em Transaction Categorization com a chave de API obtida e envie as transações para categorizar:

Exemplo de conta corrente:

{
  "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",
  "isBusiness": false
}

Conta corrente com dados de pagamento:

{
  "transactions": [
    {
      "id": "76a87d4d-89f2-4544-a431-b5d8a45146c7",
      "amount": -100,
      "date": "2024-09-06T00:00:00-03:00",
      "description": "MC DONALDS",
      "paymentData": {
        "payer": {
          "name": "John Doe",
          "documentNumber": { "value": "123.456.789-00", "type": "CPF" }
        },
        "receiver": {
          "name": "MC DONALDS",
          "documentNumber": { "value": "42.591.651/0001-43", "type": "CNPJ" }
        }
      }
    }
  ],
  "clientUserId": "06199323-763c-4b15-9f65-3871d8b4d430",
  "accountType": "CHECKING",
  "isBusiness": false
}

Exemplo de cartão de crédito:

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

O campo creditCardMetadata é opcional e melhora significativamente a precisão da categorização.

Você pode enviar até 5000 transações por solicitação.

O campo accountType é opcional e aceita CHECKING ou CREDIT_CARD. O campo isBusiness também é opcional e indica se esta é uma conta PJ ou PF.

A resposta será algo como isto:

{
  "results": [
    {
      "id": "76a87d4d-89f2-4544-a431-b5d8a45146c7",
      "amount": -100,
      "date": "2024-09-06T00:00:00-03:00",
      "description": "MC DONALDS",
      "type": "DEBIT",
      "merchant": {
        "name": "mc donalds",
        "businessName": "ARCOS DOURADOS COMERCIO DE ALIMENTOS LTDA",
        "cnpj": "42.591.651/0001-43"
      },
      "category": "Eating out"
    }
  ]
}

O campo merchant pode ser null se o comerciante for desconhecido. Veja os possíveis valores de categoria em nossa página de Transaction Categorization.

Como usar#

Como usar #