POST/categories/rules

Criar Regra de Categoria

Criar uma regra de categoria única

Criar Regras de Categoria requer apenas o envio do categoryId que você pode recuperar da lista de Categorias.

Exemplo de criação de uma regra:

{
    "description": "Mc Donalds",
    "categoryId": "11010000"
}

Request Body

required

object

Create client category rule

descriptionrequiredstring

Descrição da regra de transação.

categoryIdrequiredstring

Identificador da categoria

transactionTypestring

Tipo de transação (DÉBITO/CREDITO)

accountTypestring

Tipo de conta (CHECKING_ACCOUNT/CREDIT_CARD)

matchTypestring

Tipo de correspondência usada para identificar a regra (exato/contém/começaCom/terminaCom), se não fornecido, o padrão é 'exato'

Example

json

{
  "description": "uber payment",
  "categoryId": "05000000",
  "transactionType": "DEBIT",
  "accountType": "CHECKING_ACCOUNT"
}

Responses

200Cria uma Regra de Categoria e recupera o resultado

object

Category rule by client id

descriptionrequiredstring

Descrição da regra de transação.

categoryIdstring

Identificador da categoria

categoryrequiredstring

Descrição da categoria

clientIdstring

Identificador do cliente

transactionTypestring

Tipo de transação (DÉBITO/CREDITO)

accountTypestring

Tipo de conta (CHECKING_ACCOUNT/CREDIT_CARD)

Example response

json

{
  "description": "uber payment",
  "category": "Salary/pro-labore",
  "categoryId": "05000000",
  "clientId": "03cc0eff-4ec5-495c-adb3-1ef9611624fc",
  "transactionType": "DEBIT",
  "accountType": "CHECKING_ACCOUNT"
}

curl -X POST \
  'https://api.pluggy.ai/categories/rules' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY' \
  -d '{}'

Resposta de exemplo

{
  "description": "uber payment",
  "category": "Salary/pro-labore",
  "categoryId": "05000000",
  "clientId": "03cc0eff-4ec5-495c-adb3-1ef9611624fc",
  "transactionType": "DEBIT",
  "accountType": "CHECKING_ACCOUNT"
}