/transactions/{id}Recuperar
Recupera o recurso de transação pelo seu id
Parameters
Path Parameters
| Name | Type |
|---|---|
idrequired | string (uuid) |
Responses
Produto de transação
Identificador principal da transação
Descrição clara da transação
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.
Código ISO da moeda
Valor da transação
Valor da transação na moeda da conta. Presente apenas se a transação estiver em uma moeda diferente da moeda da conta.
Data em que a transação foi realizada
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`.
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.
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.
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).
Categoria da transação (por exemplo, Restaurantes, Educação). Consulte a seção de Classificação de Transações em nossos guias.
Id da categoria da transação. Pode ser usado para identificar a categoria no endpoint Categories.
Dados do participante de Pagamento ou Transferência
Dados de uma transação específica para transações com cartão de crédito
Número da parcela atual da compra
Total de parcelas da compra
Valor total da compra. Disponível apenas em direct connectors; conectores de Open Finance não retornam este campo.
Tipo de taxa cobrada. Presente quando a operação é uma taxa (TARIFA)
Texto livre descrevendo o tipo de taxa quando feeType é 'OUTRO'
Outro tipo de crédito contratado no cartão. Presente quando a operação é uma operação de crédito contratada.
Texto livre descrevendo o outro tipo de crédito quando otherCreditsType é 'OTHER'
Data original da compra
Código de Categoria do Comerciante
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.
Id da conta associada a esta transação
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.
Como a compra é cobrada: 'SINGLE' quando é cobrada integralmente em uma fatura, 'INSTALLMENT' quando é dividida em parcelas. Retornado apenas para conectores de Open Finance. Preenchido a partir da liberação deste campo em diante, não retroativamente: transações sincronizadas antes disso não carregam a chave até serem sincronizadas novamente.
Data (AAAA-MM-DD) em que a instituição registrou a transação em uma fatura, exatamente como a instituição a reporta. Ao contrário do campo 'date' da transação, nunca é ajustada pela Pluggy. null quando a transação ainda não foi registrada em uma fatura ou a instituição não a reporta. Uma chave ausente significa o mesmo que null: o campo é preenchido a partir de seu lançamento, não retroativamente. Retornado apenas para conectores de Open Finance.
Data e hora da transação conforme relatado pela instituição. Normalizado para uma string ISO-8601 válida: algumas instituições adicionam um sufixo de id de zona (por exemplo, '2026-04-09T16:43:35.203Z[GMT]'), que o Pluggy remove. Ausente quando a instituição envia um espaço reservado. Retornado apenas para conectores de Open Finance. Preenchido a partir da liberação deste campo em diante, não retroativamente.
Merchant extraído dos dados da transação
Nome dos comerciantes
Nome legal da empresa do comerciante
Número do documento relacionado ao comerciante
Número de classificação da atividade econômica relacionado ao comerciante
Categoria derivada do CNAE do comerciante, quando uma pode ser resolvida
Tipo de operação classificada pela instituição. Para transações de conta bancária, carrega 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 um pagamento parcial ou total da fatura, 'TARIFA', 'OPERACOES_CREDITO_CONTRATADAS_CARTAO', 'ESTORNO', 'CASHBACK', 'OUTROS'). A única exceção é o pagamento da fatura do cartão de crédito que o Pluggy constrói a partir dos dados da fatura quando a instituição não reporta o pagamento como uma transação (descrito como 'Pagamento recebido'): carrega 'PAGAMENTO_FATURA', definido pelo Pluggy em vez da instituição. Retornado apenas para conectores do Open Finance.
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). Para transações com cartão de crédito, contém o 'transactionalAdditionalInfo' do Open Finance. O Open Finance exige isso quando o operationType é 'OUTROS', mas nem toda instituição preenche. Retornado apenas para conectores do Open Finance.
Identificador do provedor para a transação. Retornado apenas para conectores de Open Finance.
Identificador da conta à qual esta transação pertence.
Posição sequencial da transação dentro do mesmo dia, usada para preservar a ordem quando múltiplas transações compartilham a mesma data.
Data em que a transação foi inicialmente recebida pelo Pluggy.
Data da última atualização dos dados da transação.
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
}