Lista

Recupera todas as transações da conta fornecida usando paginação baseada em cursor.

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.

Note

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	Lista de identificadores de transação separados por vírgula (UUIDs). Máximo de 500 ids por solicitação.
`dateFrom`	string (date-time)	Filtrar transações com data maior ou igual à data fornecida. Formato (aaaa-mm-dd). Não pode ser usado junto com createdAtFrom.
`dateTo`	string (date-time)	Filtrar transações com data menor ou igual à data fornecida. Formato (aaaa-mm-dd).
`createdAtFrom`	string (date-time)	Filtrar transações criadas nesta data ou depois. Formato (aaaa-mm-ddThh:mm:ss.000Z)
`after`	string	Cursor para a próxima página de resultados. Para paginar, anexe o valor 'next' da resposta anterior ao caminho do endpoint como a string de consulta completa (GET /v2/transactions{next}). Se estiver construindo a solicitação manualmente, envie aqui apenas o valor 'after' decodificado da URL contido em 'next' — nunca a string inteira 'next'.

Responses

200Recupere uma lista de transações para uma conta usando paginação baseada em cursor

object

Resposta paginada baseada em cursor para transações

resultsrequiredobject[]

Lista de transações para a página atual

itemsobject

Produto de transação

nextrequiredstring | null

String de consulta pronta para uso para a próxima página: anexe-a como está ao caminho do endpoint (GET /v2/transactions{next}). Nulo se não houver mais resultados.

Example response

json

{
  "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
    }
  ],
  "next": "?accountId=562b795d-1653-429f-be86-74ead9502813&after=MjAyMC0xMC0xNVQwMDowMDowMC4wMDBafGE4NTM0Yzg1LTUzY2UtNGYyMS05NGQ3LTUwZTlkMmVlNDk1Nw=="
}

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

Resposta de exemplo

{
  "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
    }
  ],
  "next": "?accountId=562b795d-1653-429f-be86-74ead9502813&after=MjAyMC0xMC0xNVQwMDowMDowMC4wMDBafGE4NTM0Yzg1LTUzY2UtNGYyMS05NGQ3LTUwZTlkMmVlNDk1Nw=="
}