/transactions/{id}Update
Update the transaction's category by it's id
Parameters
Path Parameters
| Name | Type |
|---|---|
idrequired | string (uuid) |
Request Body
requiredNew category identifier
Update transaction category request body
Identifier of the category
Example
{
"categoryId": "07010000"
}Responses
Transaction product
Primary identifier of the transaction
Clean description of the transaction
Original transaction description as returned by the institution, before any cleanup or normalization. May be null when not provided by the institution.
Currency ISO code
Transaction amount
Transaction amount in Account's Currency. Only present if the transaction is in a different currency than the account's currency
Date when the transaction was made
Direction of the movement from the account holder's perspective. - `CREDIT`: money entered the account (deposits, incoming transfers, refunds). - `DEBIT`: money left the account (payments, withdrawals, outgoing transfers, credit-card purchases). Note: for credit-card accounts the convention is inverted at the institution but Pluggy normalizes the value so purchases are always `DEBIT` and payments to the card statement are `CREDIT`.
Account balance immediately after the transaction was posted. May be null when the institution does not return a running balance.
Institution-provided identifier or code for the transaction (e.g. NSU, transaction number on the bank statement). Format varies per institution.
Settlement status of the movement. - `POSTED`: the transaction is confirmed/settled at the institution. - `PENDING`: the transaction is authorized but not yet settled (typical for credit-card purchases not yet included in a closed bill).
Category of the transaction (e.g. Restaurants, Education). See the Transaction Categorization section in our guides.
Id of the transaction category. Can be used to identify the category in the Categories endpoint
Payment or Transfer participant's data
Participant of the payment data
Participant of the payment data
User's motive submitted while making the transfer
Reference number for the transfer/payment
String submitted by the receiver associated with the payment when generating the payment request.
Authentication code of the payment receipt, as printed by the institution on the proof of payment. It identifies the operation itself rather than the payment instrument, so it can be present for any payment method (PIX, TED, DOC, BOLETO).
Payment rail used for the transaction. - `PIX`: instant transfer over the Brazilian Pix system. - `TED`: Transferência Eletrônica Disponível (same-day inter-bank transfer). - `DOC`: Documento de Ordem de Crédito (D+1 inter-bank transfer, deprecated by the Central Bank). - `TEV`: Transferência Eletrônica de Valores (intra-bank transfer between accounts of the same institution). - `BOLETO`: Brazilian bank slip payment.
Information of the boleto associated with the payment
Data of a transaction specific to credit card transactions
Number of the current installment of the purchase
Total number of installments of the purchase
Total amount of the purchase
Type of fee charged. Present when the operation is a fee (TARIFA)
Free text describing the fee type when feeType is 'OTHER'
Other type of credit contracted on the card. Present when the operation is a contracted credit operation
Free text describing the other credit type when otherCreditsType is 'OTHER'
Original Date of the purchase
Merchant Category Code of the merchant
Credit Card Number associated with transaction, can be different from the account if its done by an additional or virtual card.
Id of the bill associated to this transaction
Forecasted bill period (formatted as YYYY-MM) in which this transaction is expected to be charged. Unlike billId, it is provided for pending and future transactions too. Only returned for Open Finance connectors
Merchant extracted from the transaction data
Merchants name
Merchant legal business name
Document number related to the merchant
Economic activity classification number related to the merchant
Type of operation classified by the institution. Only returned for Open Finance connectors.
Complementary, free-form information about the operation type, as provided by the institution. Varies by institution (a sub-type code or a description). Only returned for Open Finance connectors.
Provider's identifier for the transaction. Only returned for Open Finance connectors.
Identifier of the account this transaction belongs to.
Sequential position of the transaction within the same day, used to preserve ordering when multiple transactions share the same date.
Date when the transaction was first ingested by Pluggy.
Date of the last update of the transaction data.
Example response
{
"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
}Code Examples
curl -X PATCH 'https://api.pluggy.ai/transactions/{id}' \
-H 'Content-Type: application/json' \
-H 'X-API-KEY: YOUR_API_KEY' \
-d '{}'