/transactions/{id}Retrieve
Recovers the transaction resource by it's id
Parameters
Path Parameters
| Name | Type |
|---|---|
idrequired | string (uuid) |
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
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. Only available on direct connectors; Open Finance connectors do not return this field
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
How the purchase is charged: 'SINGLE' when it is charged in full on one bill, 'INSTALLMENT' when it is split into installments. Only returned for Open Finance connectors. Populated from the release of this field onwards, not retroactively: transactions synced before it do not carry the key until they are synced again
Date (YYYY-MM-DD) the institution posted the transaction to a bill, exactly as the institution reports it. Unlike the transaction 'date', it is never adjusted by Pluggy. null when the transaction is not posted to a bill yet or the institution does not report it. A missing key means the same as null: the field is populated from its release onwards, not retroactively. Only returned for Open Finance connectors
Date and time of the transaction as reported by the institution. Normalized to a valid ISO-8601 string: some institutions append a zone id suffix (e.g. '2026-04-09T16:43:35.203Z[GMT]'), which Pluggy removes. Absent when the institution sends a placeholder. Only returned for Open Finance connectors. Populated from the release of this field onwards, not retroactively
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
Category derived from the merchant's CNAE, when one can be resolved
Type of operation classified by the institution. For bank account transactions it carries values such as 'PIX' or 'TED'; for credit card transactions it carries the Open Finance transaction type ('PAGAMENTO', 'PAGAMENTO_FATURA' for a partial or full bill payment, 'TARIFA', 'OPERACOES_CREDITO_CONTRATADAS_CARTAO', 'ESTORNO', 'CASHBACK', 'OUTROS'). The one exception is the credit card bill payment Pluggy builds from the bill data when the institution does not report the payment as a transaction (described as 'Pagamento recebido'): it carries 'PAGAMENTO_FATURA', set by Pluggy rather than 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). For credit card transactions it carries the Open Finance 'transactionalAdditionalInfo'. Open Finance requires it when operationType is 'OUTROS', but not every institution fills it. 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": "666.666.666-66"
}
},
"reason": "Taxa de serviço",
"receiver": {
"name": "Pluggy",
"branchNumber": "999",
"accountNumber": "9876-1",
"routingNumber": "002",
"documentNumber": {
"type": "CNPJ",
"value": "22.222.222/0001-22"
}
},
"paymentMethod": "TED",
"referenceNumber": "123456789"
},
"merchant": null,
"providerId": null
}curl -X GET \
'https://api.pluggy.ai/transactions/{id}' \
-H 'Content-Type: application/json' \
-H 'X-API-KEY: YOUR_API_KEY'{
"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": "666.666.666-66"
}
},
"reason": "Taxa de serviço",
"receiver": {
"name": "Pluggy",
"branchNumber": "999",
"accountNumber": "9876-1",
"routingNumber": "002",
"documentNumber": {
"type": "CNPJ",
"value": "22.222.222/0001-22"
}
},
"paymentMethod": "TED",
"referenceNumber": "123456789"
},
"merchant": null,
"providerId": null
}