GET/transactionsDeprecated

Listar por Página (obsoleto)

**Depreciado**: este endpoint está depreciado e estará disponível apenas até **2026-12-31**, após o qual será removido. Por favor, migre para `GET /v2/transactions`, que utiliza paginação baseada em cursor. Recupera todas as transações coletadas para a conta fornecida.

❗️

DESATIVAÇÃO

Em favor do /v2/transactions que pagina transações usando cursor, este endpoint foi estabelecido como descontinuado e deve começar a usar o novo o mais rápido possível.

As transações devem ser copiadas para seus sistemas. Este endpoint deve ser usado uma vez por sincronização e não conectado a nenhuma aplicação diretamente.

Como recomendações gerais, esperamos que você use este endpoint conectado a webhooks de criação, atualização e exclusão com filtros específicos que foram projetados para desempenho, e paginando a maior quantidade de registros por página (500), que é o padrão atual.

📘

Disponibilidade dos campos

O campo ProviderId é retornado apenas em conexões Regulado, consistente com o ID do banco. Seria o mesmo para a mesma conta conectada como itens diferentes.

O campo ProviderCode é retornado apenas em Regulado e certos conectores.

Parameters

Query Parameters

Name	Type	Description
`accountId`required	string (uuid)	Identificador primário da conta
`ids`	array	Array de identificadores de transação. Se definido, os parâmetros 'from' e 'to' serão descartados. Máximo de 500 ids por solicitação.
`from`	string (date-time)	Filtrar maior que a data. Formato (aaaa-mm-dd)
`to`	string (date-time)	Filtrar abaixo da data. Formato (aaaa-mm-dd)
`pageSize`	number (double)	Tamanho da página para a solicitação de paginação, padrão: 500
`page`	number (double)	Número da página para a solicitação de paginação, padrão: 1
`billId`	string (uuid)	Identificador principal da fatura do cartão de crédito, se a conta for um cartão de crédito.
`createdAtFrom`	string (date-time)	Filtrar maior que createdAt. Formato (aaaa-mm-ddThh:mm:ss.000Z)

Responses

200Recupere uma lista de todas as transações de uma conta

object

resultsrequiredobject[]

itemsobject

Produto de transação

pagerequirednumber (double)

totalrequirednumber (double)

totalPagesrequirednumber (double)

Example response

json

{
  "total": 8,
  "totalPages": 1,
  "page": 1,
  "results": [
    {
      "id": "a8534c85-53ce-4f21-94d7-50e9d2ee4957",
      "createdAt": "2020-06-24T21:29:40.300Z",
      "updatedAt": "2020-06-24T21:29:40.300Z",
      "description": "* PROV * COMPRA TESOURO DIRETO CLIENTES",
      "descriptionRaw": "* PROV * COMPRA TESOURO DIRETO CLIENTES",
      "currencyCode": "BRL",
      "amount": -212.45,
      "date": "2020-10-15T00:00:00.000Z",
      "balance": 4439.4,
      "category": "Fixed Income Investment",
      "accountId": "562b795d-1653-429f-be86-74ead9502813",
      "providerCode": null,
      "status": "POSTED",
      "paymentData": null,
      "type": "DEBIT",
      "providerId": null
    },
    {
      "id": "05c693bf-c196-47ea-a28c-8251d6bb8a06",
      "description": "PAGO NETFLIX SERV",
      "descriptionRaw": "PAGO NETFLIX SERV",
      "currencyCode": "USD",
      "amount": -58,
      "amountInAccountCurrency": -298.19,
      "date": "2020-10-15T00:00:00.000Z",
      "balance": 4651.85,
      "category": "Video streaming",
      "accountId": "562b795d-1653-429f-be86-74ead9502813",
      "providerCode": null,
      "status": "POSTED",
      "paymentData": null,
      "type": "DEBIT",
      "providerId": null,
      "merchant": {
        "name": "Netflix",
        "businessName": "NETFLIX ENTRETENIMENTO BRASIL LTDA.",
        "cnpj": "11111111000111",
        "category": "Video streaming",
        "cnae": "5911100"
      }
    },
    {
      "id": "97536285-cc22-4a5a-9d05-f5fe24410d0c",
      "description": "* PROV * DEVOLUÇÃO DE MARGEM",
      "descriptionRaw": "* PROV * DEVOLUÇÃO DE MARGEM",
      "currencyCode": "BRL",
      "amount": 2482.26,
      "date": "2020-10-15T00:00:00.000Z",
      "balance": 4950.04,
      "category": "Margin Withdrawn",
      "accountId": "562b795d-1653-429f-be86-74ead9502813",
      "providerCode": null,
      "status": "POSTED",
      "paymentData": null,
      "type": "CREDIT",
      "providerId": null
    },
    {
      "id": "8caf328b-4528-4de6-b931-10639d0084c5",
      "description": "LIQUIDO DAS OPERAÇÕES BMF PR. 14/10/2020 NC. 870947",
      "descriptionRaw": "LIQUIDO DAS OPERAÇÕES BMF PR. 14/10/2020 NC. 870947",
      "currencyCode": "BRL",
      "amount": -1.06,
      "date": "2020-10-14T00:00:00.000Z",
      "balance": 2467.78,
      "category": "Investment",
      "accountId": "562b795d-1653-429f-be86-74ead9502813",
      "providerCode": null,
      "status": "POSTED",
      "paymentData": null,
      "type": "DEBIT",
      "providerId": null
    },
    {
      "id": "ff9ed929-edc4-408c-a959-d51f79ab1814",
      "description": "MERCADOLIVRE*2PRODUTOS",
      "currencyCode": "BRL",
      "amount": 159.2,
      "date": "2020-10-14T00:00:00.000Z",
      "balance": 2468.84,
      "category": "Investment",
      "accountId": "562b795d-1653-429f-be86-74ead9502813",
      "providerCode": null,
      "status": "POSTED",
      "paymentData": null,
      "type": "CREDIT",
      "creditCardMetadata": {
        "totalAmount": 320,
        "totalInstallments": 2,
        "installmentNumber": 2,
        "purchaseDate": "2020-09-14T00:00:00.000Z",
        "payeeMCC": 1234,
        "cardNumber": "0597",
        "billId": "abced929-edc4-408c-a959-d51f79ab1123",
        "billForecastDate": "2020-10"
      },
      "providerId": null
    },
    {
      "id": "093fc873-442a-4bd8-9171-51f17892fb09",
      "description": "LIQUIDO DAS OPERAÇÕES BM&F PR. 14/10/2020 NC. 870947",
      "descriptionRaw": "LIQUIDO DAS OPERAÇÕES BM&F PR. 14/10/2020 NC. 870947",
      "currencyCode": "BRL",
      "amount": -10.3,
      "date": "2020-10-14T00:00:00.000Z",
      "balance": 2309.64,
      "category": "Investment",
      "accountId": "562b795d-1653-429f-be86-74ead9502813",
      "providerCode": null,
      "status": "POSTED",
      "paymentData": null,
      "type": "DEBIT",
      "providerId": null
    },
    {
      "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": "Transfer",
      "accountId": "03cc0eff-4ec5-495c-adb3-1ef9611624fc",
      "providerCode": "123456",
      "type": "CREDIT",
      "status": "POSTED",
      "operationType": "TED",
      "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"
      },
      "providerId": null
    }
  ]
}

curl -X GET \
  'https://api.pluggy.ai/transactions' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY'

Resposta de exemplo

{
  "total": 8,
  "totalPages": 1,
  "page": 1,
  "results": [
    {
      "id": "a8534c85-53ce-4f21-94d7-50e9d2ee4957",
      "createdAt": "2020-06-24T21:29:40.300Z",
      "updatedAt": "2020-06-24T21:29:40.300Z",
      "description": "* PROV * COMPRA TESOURO DIRETO CLIENTES",
      "descriptionRaw": "* PROV * COMPRA TESOURO DIRETO CLIENTES",
      "currencyCode": "BRL",
      "amount": -212.45,
      "date": "2020-10-15T00:00:00.000Z",
      "balance": 4439.4,
      "category": "Fixed Income Investment",
      "accountId": "562b795d-1653-429f-be86-74ead9502813",
      "providerCode": null,
      "status": "POSTED",
      "paymentData": null,
      "type": "DEBIT",
      "providerId": null
    },
    {
      "id": "05c693bf-c196-47ea-a28c-8251d6bb8a06",
      "description": "PAGO NETFLIX SERV",
      "descriptionRaw": "PAGO NETFLIX SERV",
      "currencyCode": "USD",
      "amount": -58,
      "amountInAccountCurrency": -298.19,
      "date": "2020-10-15T00:00:00.000Z",
      "balance": 4651.85,
      "category": "Video streaming",
      "accountId": "562b795d-1653-429f-be86-74ead9502813",
      "providerCode": null,
      "status": "POSTED",
      "paymentData": null,
      "type": "DEBIT",
      "providerId": null,
      "merchant": {
        "name": "Netflix",
        "businessName": "NETFLIX ENTRETENIMENTO BRASIL LTDA.",
        "cnpj": "11111111000111",
        "category": "Video streaming",
        "cnae": "5911100"
      }
    },
    {
      "id": "97536285-cc22-4a5a-9d05-f5fe24410d0c",
      "description": "* PROV * DEVOLUÇÃO DE MARGEM",
      "descriptionRaw": "* PROV * DEVOLUÇÃO DE MARGEM",
      "currencyCode": "BRL",
      "amount": 2482.26,
      "date": "2020-10-15T00:00:00.000Z",
      "balance": 4950.04,
      "category": "Margin Withdrawn",
      "accountId": "562b795d-1653-429f-be86-74ead9502813",
      "providerCode": null,
      "status": "POSTED",
      "paymentData": null,
      "type": "CREDIT",
      "providerId": null
    },
    {
      "id": "8caf328b-4528-4de6-b931-10639d0084c5",
      "description": "LIQUIDO DAS OPERAÇÕES BMF PR. 14/10/2020 NC. 870947",
      "descriptionRaw": "LIQUIDO DAS OPERAÇÕES BMF PR. 14/10/2020 NC. 870947",
      "currencyCode": "BRL",
      "amount": -1.06,
      "date": "2020-10-14T00:00:00.000Z",
      "balance": 2467.78,
      "category": "Investment",
      "accountId": "562b795d-1653-429f-be86-74ead9502813",
      "providerCode": null,
      "status": "POSTED",
      "paymentData": null,
      "type": "DEBIT",
      "providerId": null
    },
    {
      "id": "ff9ed929-edc4-408c-a959-d51f79ab1814",
      "description": "MERCADOLIVRE*2PRODUTOS",
      "currencyCode": "BRL",
      "amount": 159.2,
      "date": "2020-10-14T00:00:00.000Z",
      "balance": 2468.84,
      "category": "Investment",
      "accountId": "562b795d-1653-429f-be86-74ead9502813",
      "providerCode": null,
      "status": "POSTED",
      "paymentData": null,
      "type": "CREDIT",
      "creditCardMetadata": {
        "totalAmount": 320,
        "totalInstallments": 2,
        "installmentNumber": 2,
        "purchaseDate": "2020-09-14T00:00:00.000Z",
        "payeeMCC": 1234,
        "cardNumber": "0597",
        "billId": "abced929-edc4-408c-a959-d51f79ab1123",
        "billForecastDate": "2020-10"
      },
      "providerId": null
    },
    {
      "id": "093fc873-442a-4bd8-9171-51f17892fb09",
      "description": "LIQUIDO DAS OPERAÇÕES BM&F PR. 14/10/2020 NC. 870947",
      "descriptionRaw": "LIQUIDO DAS OPERAÇÕES BM&F PR. 14/10/2020 NC. 870947",
      "currencyCode": "BRL",
      "amount": -10.3,
      "date": "2020-10-14T00:00:00.000Z",
      "balance": 2309.64,
      "category": "Investment",
      "accountId": "562b795d-1653-429f-be86-74ead9502813",
      "providerCode": null,
      "status": "POSTED",
      "paymentData": null,
      "type": "DEBIT",
      "providerId": null
    },
    {
      "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": "Transfer",
      "accountId": "03cc0eff-4ec5-495c-adb3-1ef9611624fc",
      "providerCode": "123456",
      "type": "CREDIT",
      "status": "POSTED",
      "operationType": "TED",
      "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"
      },
      "providerId": null
    }
  ]
}