GET/items/{id}/resources

Recursos de Item

Open Finance apenas. Lista os recursos que a instituição financeira declarou para o consentimento deste item, exatamente como a instituição os relatou. Use isso para responder o que um consentimento realmente cobre e o que a instituição diz sobre cada parte dele. Um recurso relatado como `PENDING_AUTHORISATION` ou `UNAVAILABLE` explica um produto ausente e é algo que o usuário final pode agir em seu banco. Se a Pluggy possui o registro correspondente é uma questão separada: use os endpoints de produto (`/accounts`, `/investments`, `/loans`) e o `statusDetail` do Item para isso. A lista é uma captura da última execução que alcançou a instituição, portanto, pode ser mais antiga do que o próprio item. O `resourcesCollectedAt` do Item diz quando foi coletado — e uma lista vazia significa que a instituição não compartilhou nada apenas quando esse campo está definido; quando está `null`, a lista nunca foi obtida. Itens em conectores que não são Open Finance retornam uma página vazia em vez de um erro.

Parameters

Path Parameters

Name	Type	Description
`id`required	string (uuid)	Identificador primário do Item

Query Parameters

Name	Type	Description
`pageSize`	number (double)	Tamanho da página para a solicitação de paginação, padrão: 500
`page`	number (double)	Número da página para a solicitação de paginação, padrão: 1
`status`	string	Apenas recursos com este status, escrito como o Open Finance relata. `PENDING_AUTHORISATION` lista o que ainda está aguardando autorização na instituição. `AVAILABLEUNAVAILABLETEMPORARILY_UNAVAILABLEPENDING_AUTHORISATION`

Responses

200Os recursos declarados para o consentimento do item

object

pagenumber (double)

totalnumber (double)

totalPagesnumber (double)

resultsobject[]

List of declared resources

itemsobject

Um recurso que a instituição financeira declarou para o consentimento de Open Finance do item, relatado verbatim.

Example response

json

{
  "page": 1,
  "total": 3,
  "totalPages": 1,
  "results": [
    {
      "resourceId": "1f9a5e0c-3d2b-4a1e-9c7f-2b8d6e4a1c30",
      "type": "ACCOUNT",
      "status": "AVAILABLE"
    },
    {
      "resourceId": "6c2d8b41-7e5a-4f03-b19d-8a4e2c7f5b60",
      "type": "CREDIT_CARD_ACCOUNT",
      "status": "PENDING_AUTHORISATION"
    },
    {
      "resourceId": "a3e71d92-5b48-4c6f-8e20-1d9c3b7a4e50",
      "type": "FUND",
      "status": "UNAVAILABLE"
    }
  ]
}

curl -X GET \
  'https://api.pluggy.ai/items/{id}/resources' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY'

Resposta de exemplo

{
  "page": 1,
  "total": 3,
  "totalPages": 1,
  "results": [
    {
      "resourceId": "1f9a5e0c-3d2b-4a1e-9c7f-2b8d6e4a1c30",
      "type": "ACCOUNT",
      "status": "AVAILABLE"
    },
    {
      "resourceId": "6c2d8b41-7e5a-4f03-b19d-8a4e2c7f5b60",
      "type": "CREDIT_CARD_ACCOUNT",
      "status": "PENDING_AUTHORISATION"
    },
    {
      "resourceId": "a3e71d92-5b48-4c6f-8e20-1d9c3b7a4e50",
      "type": "FUND",
      "status": "UNAVAILABLE"
    }
  ]
}