Procurando a documentação anterior?Acesse v1.docs.pluggy.ai
PluggyDocs
GET/accounts

Lista

Recupera todas as contas coletadas para o item fornecido

Parameters

Query Parameters

NameType
itemIdrequired
string (uuid)
type
string
pageSize
number (double)
page
number (double)

Responses

200Recupere uma lista de todas as contas
object
pagenumber (double)
totalnumber (double)
totalPagesnumber (double)
resultsobject[]

List of retrieved accounts

itemsobject

Conta do tipo banco

Example response

json
{
  "page": 1,
  "total": 2,
  "totalPages": 1,
  "results": [
    {
      "id": "a658c848-e475-457b-8565-d1fffba127c4",
      "createdAt": "2020-06-24T21:29:40.300Z",
      "updatedAt": "2020-06-24T21:29:40.300Z",
      "type": "BANK",
      "subtype": "CHECKING_ACCOUNT",
      "number": "0001/12345-0",
      "name": "Conta Corrente",
      "marketingName": "GOLD Conta Corrente",
      "balance": 120950,
      "itemId": "a0922d6f-2007-4169-a181-b961500608db",
      "taxNumber": "333.333.333-33",
      "owner": "John Doe",
      "currencyCode": "BRL",
      "bankData": {
        "transferNumber": "0001/12345-0",
        "closingBalance": 120950,
        "automaticallyInvestedBalance": 100,
        "overdraftContractedLimit": 0,
        "overdraftUsedLimit": 0,
        "unarrangedOverdraftAmount": 0
      }
    },
    {
      "id": "a658c848-e475-457b-8565-d1fffba127c4",
      "type": "CREDIT",
      "subtype": "CREDIT_CARD",
      "number": "xxxx8670",
      "name": "Mastercard Black",
      "marketingName": "PLUGGY UNICLASS MASTERCARD BLACK",
      "balance": 120950,
      "itemId": "a0922d6f-2007-4169-a181-b961500608db",
      "taxNumber": "333.333.333-33",
      "owner": "John Doe",
      "currencyCode": "BRL",
      "creditData": {
        "level": "BLACK",
        "brand": "MASTERCARD",
        "balanceCloseDate": "2022-01-03",
        "balanceDueDate": "2022-01-03",
        "availableCreditLimit": 200000,
        "balanceForeignCurrency": 0,
        "minimumPayment": 16190,
        "creditLimit": 300000,
        "status": "ACTIVE",
        "holderType": "MAIN"
      }
    }
  ]
}
curl -X GET \
'https://api.pluggy.ai/accounts' \
-H 'Content-Type: application/json' \
-H 'X-API-KEY: YOUR_API_KEY'
Resposta de exemplo
{
"page": 1,
"total": 2,
"totalPages": 1,
"results": [
{
"id": "a658c848-e475-457b-8565-d1fffba127c4",
"createdAt": "2020-06-24T21:29:40.300Z",
"updatedAt": "2020-06-24T21:29:40.300Z",
"type": "BANK",
"subtype": "CHECKING_ACCOUNT",
"number": "0001/12345-0",
"name": "Conta Corrente",
"marketingName": "GOLD Conta Corrente",
"balance": 120950,
"itemId": "a0922d6f-2007-4169-a181-b961500608db",
"taxNumber": "333.333.333-33",
"owner": "John Doe",
"currencyCode": "BRL",
"bankData": {
"transferNumber": "0001/12345-0",
"closingBalance": 120950,
"automaticallyInvestedBalance": 100,
"overdraftContractedLimit": 0,
"overdraftUsedLimit": 0,
"unarrangedOverdraftAmount": 0
}
},
{
"id": "a658c848-e475-457b-8565-d1fffba127c4",
"type": "CREDIT",
"subtype": "CREDIT_CARD",
"number": "xxxx8670",
"name": "Mastercard Black",
"marketingName": "PLUGGY UNICLASS MASTERCARD BLACK",
"balance": 120950,
"itemId": "a0922d6f-2007-4169-a181-b961500608db",
"taxNumber": "333.333.333-33",
"owner": "John Doe",
"currencyCode": "BRL",
"creditData": {
"level": "BLACK",
"brand": "MASTERCARD",
"balanceCloseDate": "2022-01-03",
"balanceDueDate": "2022-01-03",
"availableCreditLimit": 200000,
"balanceForeignCurrency": 0,
"minimumPayment": 16190,
"creditLimit": 300000,
"status": "ACTIVE",
"holderType": "MAIN"
}
}
]
}