v1

latestOpenAPI 3.1.0MIT2026-07-2484155300.5 KB
Transaction

List by Page (deprecated)

Deprecated: this endpoint is deprecated and will be available only until 2026-12-31, after which it will be removed. Please migrate to GET /v2/transactions, which uses cursor-based pagination.

Recovers all transactions collected for the acount provided.

get/transactions

Query parameters

accountIdstring uuid required

Account primary identifier

idsstring[]

Array of transaction identifiers. If defined, 'from' and 'to' parameters will be discarded

fromstring date-time

Filter greater than date. Format (yyyy-mm-dd)

tostring date-time

Filter lower than date. Format (yyyy-mm-dd)

pageSizenumber double

Page size for the paging request, default: 500

pagenumber double

Page number for the paging request, default: 1

billIdstring uuid

Credit Card Bill's primary identifier, if account is a credit card.

createdAtFromstring date-time

Filter greater than createdAt. Format (yyyy-mm-ddThh:mm:ss.000Z)

Response

Retrieve a list of all transactions for an account

pagenumber double required
totalnumber double required
totalPagesnumber double required

Example response

{
  "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
    }
  ]
}