GET/v2/transactions

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

Cursor-based paginated response for transactions

resultsrequiredobject[]

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

itemsobject

Transaction product

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": "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
    }
  ],
  "next": "string"
}

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": "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
    }
  ],
  "next": "string"
}