PATCH/transactions/{id}

Atualizar

Atualize a categoria da transação pelo seu id

Este endpoint permite que os clientes atualizem a categoria de uma transação, forçando-a a retornar sempre a mesma categoria e ignorando a categorização fornecida pelo Pluggy.

A coisa mais importante é que isso fornece feedback ao Pluggy sobre uma transação que pode estar mal categorizada, e será validada por humanos para fornecer feedback ao modelo do Pluggy como uma nova anotação. Isso pode ser aceito ou não, uma vez que o modelo do Pluggy é utilizado por todos os clientes.

Para recuperar o categoryId, visite os endpoints Categories para listar todas as categorias disponíveis.

Parameters

Path Parameters

Name	Type	Description
`id`required	string (uuid)	identificador primário da transação

Request Body

required

Novo identificador de categoria

object

Update transaction category request body

categoryIdrequiredstring

Identificador da categoria

Example

json

{
  "categoryId": "07010000"
}

Responses

200Recupere uma transação atualizada.

object

Transaction product

idrequiredstring

Identificador principal da transação

descriptionrequiredstring

Descrição clara da transação

descriptionRawstring | null

Descrição da transação original conforme retornada pela instituição, antes de qualquer limpeza ou normalização. Pode ser nula quando não fornecida pela instituição.

currencyCoderequiredstring

Código ISO da moeda

amountrequirednumber (double)

Valor da transação

amountInAccountCurrencynumber (double)

Valor da transação na moeda da conta. Presente apenas se a transação estiver em uma moeda diferente da moeda da conta.

daterequiredstring (date-time)

Data em que a transação foi realizada

typestring

Direção do movimento do ponto de vista do titular da conta. - `CREDIT`: dinheiro entrou na conta (depósitos, transferências recebidas, reembolsos). - `DEBIT`: dinheiro saiu da conta (pagamentos, saques, transferências enviadas, compras com cartão de crédito). Nota: para contas de cartão de crédito, a convenção é invertida na instituição, mas o Pluggy normaliza o valor, de modo que as compras sejam sempre `DEBIT` e os pagamentos na fatura do cartão sejam `CREDIT`.

DEBITCREDIT

balancenumber (double)

Saldo da conta imediatamente após a transação ser registrada. Pode ser nulo quando a instituição não retorna um saldo em andamento.

providerCodestring | null

Identificador ou código fornecido pela instituição para a transação (por exemplo, NSU, número da transação no extrato bancário). O formato varia conforme a instituição.

statusstring

Status de liquidação do movimento. - `POSTADO`: a transação está confirmada/liquidada na instituição. - `PENDENTE`: a transação está autorizada, mas ainda não liquidada (típico para compras com cartão de crédito que ainda não foram incluídas em uma fatura fechada).

POSTEDPENDING

categorystring

Categoria da transação (por exemplo, Restaurantes, Educação). Consulte a seção de Classificação de Transações em nossos guias.

categoryIdstring

Id da categoria da transação. Pode ser usado para identificar a categoria no endpoint Categories.

paymentDataobject | null

Any of:

option 1object

Payment or Transfer participant's data

option 2null | null

creditCardMetadataobject

Data of a transaction specific to credit card transactions

installmentNumbernumber

Número da parcela atual da compra

totalInstallmentsnumber

Total de parcelas da compra

totalAmountnumber

Valor total da compra

feeTypestring

Tipo de taxa cobrada. Presente quando a operação é uma taxa (TARIFA)

ANNUAL_FEEATM_WITHDRAWAL_DOMESTICATM_WITHDRAWAL_INTERNATIONALEMERGENCY_CREDIT_EVALUATIONCARD_REISSUEBILL_PAYMENT_FEESMSOTHER

feeTypeAdditionalInfostring

Texto livre descrevendo o tipo de taxa quando feeType é 'OUTRO'

otherCreditsTypestring

Outro tipo de crédito contratado no cartão. Presente quando a operação é uma operação de crédito contratada.

REVOLVING_CREDITBILL_INSTALLMENTLOANOTHER

otherCreditsAdditionalInfostring

Texto livre descrevendo o outro tipo de crédito quando otherCreditsType é 'OTHER'

purchaseDatestring (date-time)

Data original da compra

payeeMCCinteger

Código de Categoria do Comerciante

cardNumberstring

Número do cartão de crédito associado à transação, pode ser diferente da conta se for feito por um cartão adicional ou virtual.

billIdstring

Id da conta associada a esta transação

billForecastDatestring

Período de fatura previsto (formatado como AAAA-MM) em que esta transação deve ser cobrada. Ao contrário do billId, ele é fornecido para transações pendentes e futuras também. Retornado apenas para conectores de Open Finance.

merchantobject

Merchant extracted from the transaction data

namestring

Nome dos comerciantes

businessNamestring

Nome legal da empresa do comerciante

cnpjstring

Número do documento relacionado ao comerciante

cnaestring

Número de classificação da atividade econômica relacionado ao comerciante

categorystring

Categoria derivada do CNAE do comerciante, quando uma pode ser resolvida

operationTypestring | null

Tipo de operação classificada pela instituição. Para transações de conta bancária, possui valores como 'PIX' ou 'TED'; para transações de cartão de crédito, carrega o tipo de transação do Open Finance ('PAGAMENTO', 'PAGAMENTO_FATURA' para pagamento parcial ou total de fatura, 'TARIFA', 'OPERACOES_CREDITO_CONTRATADAS_CARTAO', 'ESTORNO', 'CASHBACK', 'OUTROS'). Retornado apenas para conectores do Open Finance.

operationTypeAdditionalInfostring | null

Informações complementares e em formato livre sobre o tipo de operação, conforme fornecido pela instituição. Varia de acordo com a instituição (um código de sub-tipo ou uma descrição). Retornado apenas para conectores de Open Finance.

providerIdstring | null

Identificador do provedor para a transação. Retornado apenas para conectores de Open Finance.

accountIdrequiredstring (uuid)

Identificador da conta à qual esta transação pertence.

ordernumber (integer)

Posição sequencial da transação dentro do mesmo dia, usada para preservar a ordem quando múltiplas transações compartilham a mesma data.

createdAtrequiredstring (date-time)

Data em que a transação foi inicialmente recebida pelo Pluggy.

updatedAtrequiredstring (date-time)

Data da última atualização dos dados da transação.

Example response

json

{
  "id": "6ec156fe-e8ac-4d9a-a4b3-7770529ab01c",
  "description": "TED Example",
  "descriptionRaw": null,
  "currencyCode": "BRL",
  "amount": 1500,
  "date": "2020-10-14T00:00:00.000Z",
  "balance": 3500,
  "category": "Transfers",
  "categoryId": "05000000",
  "accountId": "03cc0eff-4ec5-495c-adb3-1ef9611624fc",
  "providerCode": "123456",
  "type": "CREDIT",
  "status": "POSTED",
  "paymentData": {
    "payer": {
      "name": "Tiago Rodrigues Santos",
      "branchNumber": "090",
      "accountNumber": "1234-5",
      "routingNumber": "001",
      "documentNumber": {
        "type": "CPF",
        "value": "882.937.076-23"
      }
    },
    "reason": "Taxa de serviço",
    "receiver": {
      "name": "Pluggy",
      "branchNumber": "999",
      "accountNumber": "9876-1",
      "routingNumber": "002",
      "documentNumber": {
        "type": "CNPJ",
        "value": "08.050.608/0001-32"
      }
    },
    "paymentMethod": "TED",
    "referenceNumber": "123456789"
  },
  "merchant": null,
  "providerId": null
}

curl -X PATCH \
  'https://api.pluggy.ai/transactions/{id}' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY' \
  -d '{}'

Resposta de exemplo

{
  "id": "6ec156fe-e8ac-4d9a-a4b3-7770529ab01c",
  "description": "TED Example",
  "descriptionRaw": null,
  "currencyCode": "BRL",
  "amount": 1500,
  "date": "2020-10-14T00:00:00.000Z",
  "balance": 3500,
  "category": "Transfers",
  "categoryId": "05000000",
  "accountId": "03cc0eff-4ec5-495c-adb3-1ef9611624fc",
  "providerCode": "123456",
  "type": "CREDIT",
  "status": "POSTED",
  "paymentData": {
    "payer": {
      "name": "Tiago Rodrigues Santos",
      "branchNumber": "090",
      "accountNumber": "1234-5",
      "routingNumber": "001",
      "documentNumber": {
        "type": "CPF",
        "value": "882.937.076-23"
      }
    },
    "reason": "Taxa de serviço",
    "receiver": {
      "name": "Pluggy",
      "branchNumber": "999",
      "accountNumber": "9876-1",
      "routingNumber": "002",
      "documentNumber": {
        "type": "CNPJ",
        "value": "08.050.608/0001-32"
      }
    },
    "paymentMethod": "TED",
    "referenceNumber": "123456789"
  },
  "merchant": null,
  "providerId": null
}