v1

latestOpenAPI 3.1.0MIT2026-07-2484155300.5 KB

Transaction

Update

Update the transaction's category by it's id

patch/transactions/{id}

Path parameters

idstring uuid required

transaction primary identifier

Request body

categoryIdstring required

Identifier of the category

Example request

{
  "categoryId": "07010000"
}

Response

Retrieve an updated transaction.

idstring required

Primary identifier of the transaction

descriptionstring required

Clean description of the transaction

descriptionRawstring nullable

Original transaction description as returned by the institution, before any cleanup or normalization. May be null when not provided by the institution.

currencyCodestring required

Currency ISO code

amountnumber double required

Transaction amount

amountInAccountCurrencynumber double

Transaction amount in Account's Currency. Only present if the transaction is in a different currency than the account's currency

datestring date-time required

Date when the transaction was made

type'DEBIT' | 'CREDIT'

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.

balancenumber double

Account balance immediately after the transaction was posted. May be null when the institution does not return a running balance.

providerCodestring

Institution-provided identifier or code for the transaction (e.g. NSU, transaction number on the bank statement). Format varies per institution.

status'POSTED' | 'PENDING'

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).

categorystring

Category of the transaction (e.g. Restaurants, Education). See the Transaction Categorization section in our guides.

categoryIdstring

Id of the transaction category. Can be used to identify the category in the Categories endpoint

operationTypestring nullable

Type of operation classified by the institution. Only returned for Open Finance connectors.

operationTypeAdditionalInfostring nullable

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.

providerIdstring

Provider's identifier for the transaction. Only returned for Open Finance connectors.

accountIdstring uuid required

Identifier of the account this transaction belongs to.

ordernumber

Sequential position of the transaction within the same day, used to preserve ordering when multiple transactions share the same date.

createdAtstring date-time required

Date when the transaction was first ingested by Pluggy.

updatedAtstring date-time required

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
}