Pluggy

https://docs.pluggy.ai/
Admin
Pluggy is a comprehensive financial API platform that aggregates user financial data, enables secure...
Tokens:450,283
Snippets:3,071
Trust Score:8
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Example response for GET /payments/customers

Source: https://docs.pluggy.ai/en/reference/payment-customer/payment-customers-list

Example response for the GET /payments/customers endpoint, showing a paginated list with one payment customer.

```json
{
  "page": 1,
  "total": 1,
  "totalPages": 1,
  "results": [
    {
      "id": "05c693bf-c196-47ea-a28c-8251d6bb8a06",
      "type": "INDIVIDUAL",
      "name": "Marco Silva",
      "email": "marco.silva@example.com",
      "createdAt": "2023-11-06T13:03:45.689Z",
      "updatedAt": "2023-11-06T13:03:45.689Z"
    }
  ]
}
```

--------------------------------

### Example response for GET /webhooks

Source: https://docs.pluggy.ai/en/reference/webhook/webhooks-list

Example response for the GET /webhooks endpoint, showing a paginated list of webhooks with fields such as id, event, url, disabledAt, createdAt, updatedAt, and headers.

```json
{
  "page": 1,
  "total": 2,
  "totalPages": 1,
  "results": [
    {
      "id": "d619cfde-a8d7-4fe0-a10d-6de488bde4e0",
      "event": "item/updated",
      "url": "https://www.myapi.com/notifications",
      "disabledAt": "2020-06-24T21:29:40.300Z",
          "createdAt": "2020-06-24T21:29:40.300Z",
      "updatedAt": "2020-06-24T21:29:40.300Z",
      "headers": {
        "X-Signature": "my-secret"
      }
    },
    {
      "id": "207f5bcd-312a-439c-abbe-166b6632c980",
      "event": "item/all",
      "url": "https://www.myapi.com/notifications",
      "disabledAt": null,
      "createdAt": "2020-06-24T21:29:40.300Z",
      "updatedAt": "2020-06-24T21:29:40.300Z",
      "headers": {}
    }
  ]
}
```

--------------------------------

### Example response for GET /payments/intents

Source: https://docs.pluggy.ai/en/reference/payment-intent/payment-intents-list

Example response for the GET /payments/intents endpoint. Shows a paginated list of payment intents, including the payment request, connector details, and consent URL.

```json
{
  "page": 1,
  "total": 1,
  "totalPages": 1,
  "results": [
    {
      "id": "4cfe1f6d-ae71-4c35-aae0-8f8a535ffbbd",
      "status": "CONSENT_AWAITING_AUTHORIZATION",
      "createdAt": "2023-11-06T15:38:47.861Z",
      "updatedAt": "2023-11-06T15:38:47.861Z",
      "paymentRequest": {
        "id": "c2a6b7d9-3349-435d-8341-44021449ebbc",
        "amount": 100.5,
        "description": "Transferência",
        "status": "IN_PROGRESS",
        "createdAt": "2023-11-06T13:03:45.689Z",
        "updatedAt": "2023-11-06T15:38:47.861Z",
        "callbackUrls": null,
        "recipient": null,
        "paymentUrl": "https://pay.pluggy.ai/05c693bf-c196-47ea-a28c-8251d6bb8a06",
        "isSandbox": false
      },
      "connector": {
        "id": 603,
        "name": "Bradesco",
        "primaryColor": "e5173f",
        "institutionUrl": "https://banco.bradesco/open-finance/logo/icones_vetorial-pf.svg",
        "country": "BR",
        "type": "PERSONAL_BANK",
        "credentials": [
          {
            "validation": "^\\d{3}\\.?\\d{3}\\.?\\d{3}-?\\d{2}$",
            "validationMessage": "CPF deve ter 11 números.",
            "label": "CPF",
            "name": "cpf",
            "type": "number",
            "placeholder": "",
            "optional": false
          }
        ],
        "imageUrl": "https://cdn.pluggy.ai/assets/connector-icons/203.svg",
        "hasMFA": false,
        "oauth": true,
        "health": {
          "status": "ONLINE",
          "stage": null
        },
        "products": [
          "ACCOUNTS",
          "TRANSACTIONS",
          "IDENTITY",
          "CREDIT_CARDS",
          "PAYMENT_DATA",
          "LOANS",
          "INVESTMENTS"
        ],
        "createdAt": "2023-07-12T20:20:17.253Z",
        "isSandbox": false,
        "isOpenFinance": true
      },
      "consentUrl": "https://consenturl.com"
    }
  ]
}
```

--------------------------------

### Example response for GET /consents

Source: https://docs.pluggy.ai/en/reference/consent/consents-list

Example response for the GET /consents endpoint, showing a list of consents with fields such as id, itemId, products, openFinancePermissionsGranted, createdAt, expiresAt, and revokedAt.

```json
{
  "total": 1,
  "totalPages": 1,
  "page": 1,
  "results": [
    {
      "id": "71996b6d-8991-450c-8542-ae59069d1a9d",
      "itemId": "9aab8d24-c89b-4b0e-8974-7dd5614686e4",
          "products": [
        "ACCOUNTS",
        "IDENTITY"
      ],
      "openFinancePermissionsGranted": [
        "ACCOUNTS_ALL",
        "REGISTRATION_ALL"
      ],
      "createdAt": "2023-10-02T03:00:00.000Z",
      "expiresAt": "2024-10-02T03:00:00.000Z",
      "revokedAt": null
    }
  ]
}
```

--------------------------------

### Example response for GET /categories/{id}

Source: https://docs.pluggy.ai/en/reference/category/categories-retrieve

Example response for the GET /categories/{id} endpoint. Shows the category resource fields: id, description, parentId, and parentDescription.

```json
{
  "id": "01010000",
  "description": "Salary/pro-labore",
  "parentId": "01000000",
  "parentDescription": "Income"
}
```

--------------------------------

### Sample response for GET /accounts/{id}/balance

Source: https://docs.pluggy.ai/en/reference/account-balance-get

Another example of the response body, identical to the first example response.

```json
{  
  "balance": 1500.5,  
  "blockedBalance": 0,  
  "automaticallyInvestedBalance": 200,  
  "currencyCode": "BRL",  
  "updateDateTime": "2024-01-15T10:30:00Z"  
}
```

--------------------------------

### Example response for GET /bills/{id}

Source: https://docs.pluggy.ai/en/reference/bill/bills-retrieve

Example response for the GET /bills/{id} endpoint, showing the structure of a credit card bill with finance charges and payments.

```json
{
  "id": "05c693bf-c196-47ea-a28c-8251d6bb8a06",
  "dueDate": "2023-07-20T00:00:00",
  "billClosingDate": "2023-07-13T00:00:00",
  "totalAmount": 50000,
  "totalAmountCurrencyCode": "BRL",
  "minimumPaymentAmount": 50000,
  "allowsInstallments": true,
  "financeCharges": [
    {
      "id": "123456bf-c196-47ea-a28c-8251d6bb8777",
      "type": "IOF",
      "amount": 20.51,
      "currencyCode": "BRL",
      "additionalInfo": "NA"
    }
  ],
  "payments": [
    {
      "id": "9f1c7b2e-5d3a-4c8b-a1e2-6f7d8c9b0a1b",
      "valueType": "FULL_PAYMENT",
      "paymentDate": "2023-07-20T00:00:00",
      "paymentMode": "DEBIT_ACCOUNT",
      "amount": 50000,
      "currencyCode": "BRL"
    }
  ]
}
```

--------------------------------

### Sample response for GET /api/summary

Source: https://docs.pluggy.ai/en/reference/status/status-summary

Sample response for the GET /api/summary endpoint, showing the same structure as the example response but with different formatting.

```json
{  
  "status": "op",  
  "labels": {  
    "pt": "string",  
    "es": "string",  
    "en": "string"  
  },  
  "openIncidents": 0,  
  "updatedAt": "2024-01-01T00:00:00Z"  
}
```

--------------------------------

### Sample response for GET /categories/{id}

Source: https://docs.pluggy.ai/en/reference/category/categories-retrieve

Sample response for the GET /categories/{id} endpoint. Shows the same category resource as the example response.

```json
{  
  "id": "01010000",  
  "description": "Salary/pro-labore",  
  "parentId": "01000000",  
  "parentDescription": "Income"  
}
```

--------------------------------

### Sample response for GET /merchants

Source: https://docs.pluggy.ai/en/reference/merchant/merchants-get-by-cnpj

Sample response for the GET /merchants endpoint, identical to the example response but displayed separately in the documentation.

```json
{  
  "foundMerchants": [  
    {  
      "businessName": "BANCO DO BRASIL SA",  
      "cnpj": "66666666000166",  
      "name": "BANCO DO BRASIL",  
      "cnae": "6422100",  
      "category": "Banking"  
    }  
  ],  
  "notFoundMerchants": [],  
  "invalidCnpjs": []  
}
```

--------------------------------

### Sample response for GET /webhooks

Source: https://docs.pluggy.ai/en/reference/webhook/webhooks-list

Sample response for the GET /webhooks endpoint, showing the same structure as the example response but with different formatting.

```json
{  
  "page": 1,  
  "total": 2,  
  "totalPages": 1,  
  "results": [  
    {  
      "id": "d619cfde-a8d7-4fe0-a10d-6de488bde4e0",  
      "event": "item/updated",  
      "url": "https://www.myapi.com/notifications",  
      "disabledAt": "2020-06-24T21:29:40.300Z",  
      "createdAt": "2020-06-24T21:29:40.300Z",  
      "updatedAt": "2020-06-24T21:29:40.300Z",  
      "headers": {  
        "X-Signature": "my-secret"  
      }  
    },  
    {  
      "id": "207f5bcd-312a-439c-abbe-166b6632c980",  
      "event": "item/all",  
      "url": "https://www.myapi.com/notifications",  
      "disabledAt": null,  
      "createdAt": "2020-06-24T21:29:40.300Z",  
      "updatedAt": "2020-06-24T21:29:40.300Z",  
      "headers": {}  
    }  
  ]  
}
```

--------------------------------

### Example parameters object

Source: https://docs.pluggy.ai/en/reference/items-create

Shows an example of the parameters object with the user's input values for the credentials.

```json
{
  "agency": "1234",
  "account": "123456",
  "password": "123456"
}
```

--------------------------------

### Example JSON response for GET /loans

Source: https://docs.pluggy.ai/en/reference/loan/loans-list

Shows the structure of a successful 200 response, including loan details such as contract number, interest rates, fees, charges, warranties, installments, and payments.

```json
{
  "page": 1,
  "total": 1,
  "totalPages": 1,
  "results": [
    {
      "id": "05c693bf-c196-47ea-a28c-8251d6bb8a06",
      "kind": "LOAN",
      "itemId": "5e9f8f8f-f8f8-4f8f-8f8f-8f8f8f8f8f8f",
      "contractNumber": "000000721792794",
      "ipocCode": "92792126019929279212650822221989319252576",
      "productName": "Crédito Pessoal Consignado",
      "type": "CREDITO_PESSOAL_COM_CONSIGNACAO",
      "date": "2023-07-20T00:00:00",
      "contractDate": "2022-08-01T00:00:00",
      "disbursementDates": [
        "2018-01-15T00:00:00"
      ],
      "settlementDate": "2018-01-15T00:00:00",
      "contractAmount": 50000,
      "currencyCode": "BRL",
      "dueDate": "2028-01-15T00:00:00",
      "installmentPeriodicity": "MONTHLY",
      "installmentPeriodicityAdditionalInfo": "",
      "firstInstallmentDueDate": "2018-02-15T00:00:00",
      "CET": 0.29,
      "amortizationScheduled": "SAC",
      "amortizationScheduledAdditionalInfo": "",
      "cnpjConsignee": "55.555.555/0001-55",
      "interestRates": [
        {
          "taxType": "EFETIVA",
          "interestRateType": "SIMPLES",
          "taxPeriodicity": "AA",
          "calculation": "21/252",
          "referentialRateIndexerType": "PRE_FIXADO",
          "referentialRateIndexerSubType": "TJLP",
          "referentialRateIndexerAdditionalInfo": "",
          "preFixedRate": 0.6,
          "postFixedRate": 0.55,
          "additionalInfo": ""
        }
      ],
      "contractedFees": [
        {
          "name": "Renovação de cadastro",
          "code": "CADASTRO",
          "chargeType": "UNICA",
          "charge": "MINIMO",
          "amount": 100000.04,
          "rate": 0.062
        }
      ],
      "contractedFinanceCharges": [
        {
          "type": "JUROS_REMUNERATORIOS_POR_ATRASO",
          "additionalInfo": "",
          "rate": 0.07
        }
      ],
      "warranties": [
        {
          "currencyCode": "BRL",
          "type": "CESSAO_DIREITOS_CREDITORIOS",
          "subtype": "NOTAS_PROMISSORIAS_OUTROS_DIREITOS_CREDITO",
          "amount": 1000.04
        }
      ],
      "installments": {
        "typeNumberOfInstallments": "MES",
        "totalNumberOfInstallments": 130632,
        "typeContractRemaining": "DIA",
        "contractRemainingNumber": 14600,
        "paidInstallments": 73,
        "dueInstallments": 57,
        "pastDueInstallments": 73,
        "balloonPayments": [
          {
            "dueDate": "2021-05-21T00:00:00",
            "amount": {
              "value": 1000.04,
              "currencyCode": "BRL"
            }
          }
        ]
      },
      "payments": {
        "contractOutstandingBalance": 1000.04,
        "releases": [
          {
            "isOverParcelPayment": true,
            "installmentId": "WGx0aExYcEJMVm93TFRsZFcyRXRla0V0V2pBdE9Wd3RYWH",
            "paidDate": "2021-05-21T00:00:00",
            "currencyCode": "BRL",
            "paidAmount": 1000.04,
            "overParcel": {
              "fees": [
                {
                  "name": "Reavaliação periódica do bem",
                  "code": "aval_bem",
                  "amount": 100000.04
                }
              ],
              "charges": [
                {
                  "type": "JUROS_REMUNERATORIOS_POR_ATRASO",
                  "additionalInfo": "",
                  "amount": 1000.04
                }
              ]
            }
          }
        ]
      }
    }
  ]
}
```

--------------------------------

### Response example (JSON)

Source: https://docs.pluggy.ai/en/reference/auth/auth-create

Example response for the POST /auth endpoint. Contains the generated apiKey.

```json
{
  "apiKey": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
}
```

--------------------------------

### Sample response for GET /accounts/{id}/statements

Source: https://docs.pluggy.ai/en/reference/account/account-statements-list

Sample response body showing the same structure as the example response.

```json
{  
  "total": 2,  
  "totalPages": 1,  
  "page": 1,  
  "results": [  
    {  
      "id": "a8534c85-53ce-4f21-94d7-50e9d2ee4957",  
      "monthYear": "01-2025",  
      "url": "signed-aws-url"  
    },  
    {  
      "id": "05c693bf-c196-47ea-a28c-8251d6bb8a06",  
      "monthYear": "02-2025",  
      "url": "signed-aws-url"  
    }  
  ]  
}
```

--------------------------------

### Example response for GET /connectors

Source: https://docs.pluggy.ai/en/reference/connector/connectors-list

Example response for the GET /connectors endpoint. Shows a single connector (Itaú) with its credentials, health status, products, and feature flags.

```json
{
  "page": 1,
  "total": 1,
  "totalPages": 1,
  "results": [
    {
      "id": 601,
      "name": "Itaú",
      "primaryColor": "EC7000",
      "institutionUrl": "https://www.itau.com.br/assets/dam/publisher/07_itau_empresas/13_open_banking/logos_regulatorio_bacen/opb_log_reg_bac_itau_img_01.svg",
      "country": "BR",
      "type": "PERSONAL_BANK",
      "credentials": [
        {
          "validation": "^\\d{3}\\.?\\d{3}\\.?\\d{3}-?\\d{2}$",
          "validationMessage": "CPF deve ter 11 números.",
          "label": "CPF",
          "name": "cpf",
          "type": "number",
          "placeholder": "",
          "optional": false
        }
      ],
      "imageUrl": "https://cdn.pluggy.ai/assets/connector-icons/201.svg",
      "hasMFA": false,
      "oauth": true,
      "health": {
        "status": "ONLINE",
        "stage": null
      },
      "products": [
        "ACCOUNTS",
        "TRANSACTIONS",
        "IDENTITY",
        "CREDIT_CARDS",
        "PAYMENT_DATA",
        "LOANS",
        "INVESTMENTS"
      ],
      "createdAt": "2023-09-01T18:05:09.145Z",
      "isSandbox": false,
      "isOpenFinance": true,
      "updatedAt": "2024-07-16T15:34:08.028Z",
      "supportsPaymentInitiation": true,
      "supportsScheduledPayments": true,
      "supportsSmartTransfers": true,
      "supportsBoletoManagement": true
    }
  ]
}
```

--------------------------------

### Sample response for GET /investments/{id}

Source: https://docs.pluggy.ai/en/reference/investment/investments-retrieve

Sample response for the GET /investments/{id} endpoint, showing the same investment object structure as the example response. Includes the investment details and an inline transactions array.

```json
{  
  "id": "f77eccf4-7714-498e-92a9-1bebe70335d9",  
  "code": "22.222.222/0001-22",  
  "name": "Bahia AM Advisory FIC de FIM",  
  "balance": 1359.39,  
  "currencyCode": "BRL",  
  "type": "MUTUAL_FUND",  
  "subtype": "MULTIMARKET_FUND",  
  "lastMonthRate": 0.24,  
  "annualRate": 3.24,  
  "lastTwelveMonthsRate": 3,  
  "itemId": "207f5bcd-312a-439c-abbe-166b6632c980",  
  "value": 500,  
  "quantity": 3,  
  "amount": 1500,  
  "taxes": 40.61,  
  "taxes2": 100,  
  "date": "2020-07-19T18:27:41.802Z",  
  "owner": "John Doe",  
  "number": null,  
  "amountProfit": 310.5,  
  "amountWithdrawal": 1310.5,  
  "amountOriginal": 1000,  
  "status": "ACTIVE",  
  "transactions": [  
    {  
      "tradeDate": "2020-10-01T00:00:00.000Z",  
      "date": "2020-10-01T00:00:00.000Z",  
      "description": "Aplicação Fondo de Investimento Premium",  
      "quantity": 1.25,  
      "value": 2,  
      "amount": 5,  
      "type": "BUY",  
      "movementType": "CREDIT"  
    }  
  ]  
}
```

--------------------------------

### Example request body for POST /items

Source: https://docs.pluggy.ai/en/reference/items-create

Shows a complete example of the request body for creating an item, including connectorId, parameters, and webhookUrl.

```json
{
  "connectorId": 2,
  "parameters": {
    "user": "user-ok",
    "password": "password-ok"
  },
  "webhookUrl": "https://example.com/webhook"
}
```

--------------------------------

### Example response (JSON)

Source: https://docs.pluggy.ai/en/reference/items/items-retrieve

Shows the full JSON structure returned when retrieving an item, including connector details, status, and products.

```json
{
  "id": "e062ab2b-9006-45e8-b689-defabba53647",
  "connector": {
    "id": 200,
    "name": "MeuPluggy",
    "primaryColor": "ef294b",
    "institutionUrl": "https://meu.pluggy.ai/",
    "country": "BR",
    "type": "PERSONAL_BANK",
    "credentials": [],
    "imageUrl": "https://cdn.pluggy.ai/assets/connector-icons/sandbox.svg",
    "hasMFA": false,
    "oauth": true,
    "health": {
      "status": "ONLINE",
      "stage": null
    },
    "products": [
      "ACCOUNTS",
      "TRANSACTIONS",
      "CREDIT_CARDS",
      "INVESTMENTS",
      "INVESTMENTS_TRANSACTIONS",
      "PAYMENT_DATA",
      "IDENTITY",
      "BROKERAGE_NOTE"
    ],
    "createdAt": "2023-09-12T16:44:13.900Z",
    "isSandbox": false,
    "isOpenFinance": false,
    "updatedAt": "2024-11-26T13:33:44.296Z",
    "supportsPaymentInitiation": false,
    "supportsScheduledPayments": false,
    "supportsSmartTransfers": false,
    "supportsBoletoManagement": false
  },
  "createdAt": "2024-09-19T13:10:31.212Z",
  "updatedAt": "2024-09-19T13:11:23.613Z",
  "status": "UPDATED",
  "executionStatus": "SUCCESS",
  "lastUpdatedAt": "2024-09-19T13:11:23.595Z",
  "webhookUrl": null,
  "error": null,
  "clientUserId": "user@example.com",
  "consecutiveFailedLoginAttempts": 0,
  "statusDetail": null,
  "parameter": null,
  "userAction": null,
  "nextAutoSyncAt": null,
  "consentExpiresAt": null,
  "resourcesCollectedAt": null,
  "hasResourcesPendingAuthorization": null,
  "products": [
    "ACCOUNTS",
    "CREDIT_CARDS",
    "TRANSACTIONS",
    "INVESTMENTS",
    "IDENTITY",
    "INVESTMENTS_TRANSACTIONS",
    "PAYMENT_DATA"
  ],
  "oauthRedirectUri": null
}
```

--------------------------------

### Example response for GET /api/summary

Source: https://docs.pluggy.ai/en/reference/status/status-summary

Example response for the GET /api/summary endpoint. Shows the overall status, localized labels, open incidents count, and the last update timestamp.

```json
{
  "status": "op",
  "labels": {
    "pt": "string",
    "es": "string",
    "en": "string"
  },
  "openIncidents": 0,
  "updatedAt": "2024-01-01T00:00:00Z"
}
```

--------------------------------

### Sample response for GET /connectors

Source: https://docs.pluggy.ai/en/reference/connector/connectors-list

Sample response for the cURL request, showing the same connector data as the example response.

```json
{  
  "page": 1,  
  "total": 1,  
  "totalPages": 1,  
  "results": [  
    {  
      "id": 601,  
      "name": "Itaú",  
      "primaryColor": "EC7000",  
      "institutionUrl": "https://www.itau.com.br/assets/dam/publisher/07_itau_empresas/13_open_banking/logos_regulatorio_bacen/opb_log_reg_bac_itau_img_01.svg",  
      "country": "BR",  
      "type": "PERSONAL_BANK",  
      "credentials": [  
        {  
          "validation": "^\\d{3}\\.?\\d{3}\\.?\\d{3}-?\\d{2}$",  
          "validationMessage": "CPF deve ter 11 números.",  
          "label": "CPF",  
          "name": "cpf",  
          "type": "number",  
          "placeholder": "",  
          "optional": false  
        }  
      ],  
      "imageUrl": "https://cdn.pluggy.ai/assets/connector-icons/201.svg",  
      "hasMFA": false,  
      "oauth": true,  
      "health": {  
        "status": "ONLINE",  
        "stage": null  
      },  
      "products": [  
        "ACCOUNTS",  
        "TRANSACTIONS",  
        "IDENTITY",  
        "CREDIT_CARDS",  
        "PAYMENT_DATA",  
        "LOANS",  
        "INVESTMENTS"  
      ],  
      "createdAt": "2023-09-01T18:05:09.145Z",  
      "isSandbox": false,  
      "isOpenFinance": true,  
      "updatedAt": "2024-07-16T15:34:08.028Z",  
      "supportsPaymentInitiation": true,  
      "supportsScheduledPayments": true,  
      "supportsSmartTransfers": true,  
      "supportsBoletoManagement": true  
    }  
  ]  
}
```

--------------------------------

### GET /transactions with date filters example

Source: https://docs.pluggy.ai/en/docs/products/transactions

Example of a GET request to /transactions with date filters and the resulting JSON array showing positive and negative amounts for credit card transactions.

```json
// GET /transactions?from=2025-06-01&to=2025-06-30
[
  {
    "id": "txn_001",
    "date": "2025-06-05",
    "description": "Grocery Store",
    "amount": 75.00
  },
  {
    "id": "txn_002",
    "date": "2025-06-10",
    "description": "Statement Payment",
    "amount": -150.00
  }
]
```

--------------------------------

### Example response for GET /v2/transactions

Source: https://docs.pluggy.ai/en/reference/transaction/transactions-list-by-cursor

Example response for the GET /v2/transactions endpoint. Shows a single transaction object with fields like id, createdAt, amount, category, and the next cursor for pagination.

```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=="
}
```

--------------------------------

### GET /categories Example Response

Source: https://docs.pluggy.ai/en/reference/categories-list

Example response for the GET /categories endpoint. Shows a paginated list of transaction categories with fields like id, description, descriptionTranslated, and optional parentId and parentDescription.

```json
{
  "page": 1,
  "total": 2,
  "totalPages": 1,
  "results": [
    {
      "id": "01000000",
      "description": "Income",
      "descriptionTranslated": "Renda"
    },
    {
      "id": "01010000",
      "description": "Salary/pro-labore",
      "descriptionTranslated": "Salário",
      "parentId": "01000000",
      "parentDescription": "Income"
    }
  ]
}
```

--------------------------------

### Example Response

Source: https://docs.pluggy.ai/en/reference/payment-customer/payment-customer-create

Example response for creating a payment customer. Shows the created customer object with id, type, name, email, formatted CPF, null CNPJ and connector, and timestamps.

```json
{
  "id": "5e9f8f8f-f8f8-4f8f-8f8f-8f8f8f8f8f8f",
  "type": "INDIVIDUAL",
  "name": "Marco Silva",
  "email": "marco.silva@example.com",
  "cpf": "222.222.222-22",
  "cnpj": null,
  "connector": null,
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}
```

--------------------------------

### Example response for GET /payments/recipients

Source: https://docs.pluggy.ai/en/reference/payment-recipient/payment-recipients-list

Example response for the GET /payments/recipients endpoint. Shows a paginated list of payment recipients with a single BANK_ACCOUNT item, including payment institution, account details, and timestamps.

```json
{
  "page": 0,
  "total": 0,
  "totalPages": 0,
  "results": [
    {
      "type": "BANK_ACCOUNT",
      "id": "5e9f8f8f-f8f8-4f8f-8f8f-8f8f8f8f8f8f",
      "name": "Conta empresa",
      "taxNumber": "22222222222",
          "paymentInstitution": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "Banco J. Safra S.A.",
        "ispb": "03017677",
        "tradeName": "Banco Safra",
        "compe": "074",
        "createdAt": "2020-04-21T15:00:00.000Z",
        "updatedAt": "2020-04-21T15:00:00.000Z"
      },
      "account": {
        "branch": "0001",
        "number": "123456",
        "type": "CHECKING_ACCOUNT"
      },
      "isDefault": false,
      "pixKey": null,
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-01-15T10:30:00.000Z"
    }
  ]
}
```
Tokens:
Raw