GET/connectors/{id}

Recuperar

Este endpoint recupera um conector específico.

Parameters

Path Parameters

Name	Type	Description
`id`required	number	Identificador principal do conector

Query Parameters

Name	Type	Description
`healthDetails`	boolean	Inclua detalhes de saúde sobre as últimas conexões e a porcentagem de erros (taxa de conexão)

Responses

200Recuperar um conector.

object

Connector object

idrequirednumber (integer)

Identificador principal

namestring

Nome da instituição

institutionUrlstring

Página inicial da instituição

imageUrlstring

Imagem do logotipo hospedado pelo Pluggy

primaryColorstring

Cor primária

typestring

Tipo de instituição

countrystring

País localizado

credentialsobject[]

Parâmetros necessários para iniciar a conexão

itemsobject

Credential details for a connector

hasMFAboolean

O conector requer um MFA para ser executado?

productsstring[]

Produtos suportados pelo conector

itemsstring

ACCOUNTSCREDIT_CARDSTRANSACTIONSPAYMENT_DATAINVESTMENTSINVESTMENTS_TRANSACTIONSIDENTITYBROKERAGE_NOTEMOVE_SECURITYLOANS

productCoveragestring[]

Which sub-products the institution serves, in the Open Finance directory's own vocabulary (for example INVESTMENTS:TREASURE_TITLES, CREDIT_OPERATIONS:INVOICE_FINANCINGS). Where products says whether the connector serves investments at all, this says which ones: a connector listing INVESTMENTS may serve one of the five investment resources or all five. Absent for direct connectors, which have no Open Finance participant.

itemsstring

oauthboolean

Se 'true', o conector requerirá um fluxo Oauth para ser executado

oauthUrlstring

URL para realizar o fluxo Oauth, se necessário

resetPasswordUrlstring

URL para a instituição financeira para redefinir a senha

healthobject

Connector health status

statusstring

'ONLINE' | 'OFFLINE' | 'INSTÁVEL'

stagestring | null

incidentsobject[]

Incidentes que estão afetando atualmente este conector, conforme publicado em https://status.pluggy.ai. Ausente quando o conector não tem nenhum, portanto o payload de um conector saudável permanece inalterado. Ordenado do pior para o melhor, então a primeira entrada é a que deve ser exibida se você mostrar apenas uma. Observe que isso se refere à instituição, não às suas próprias conexões: use isso para avisar um usuário antes que ele escolha um banco que se sabe que está com problemas no momento.

detailsobject

Estatísticas sobre suas conexões recentes no conector e a taxa de conexão recente (porcentagem de conexões saudáveis). Este campo só está presente se você incluir o parâmetro healthDetails=true. Isso será nulo se houver um erro ao obter os detalhes de saúde.

isOpenFinanceboolean

Indica se o conector utiliza as APIs regulamentadas de Open Finance

isSandboxboolean

Indica se o conector é um conector de sandbox, destinado a testes em vez de uma instituição real

supportsPaymentInitiationboolean

Indica se o conector suporta a API de iniciação de pagamento

supportsScheduledPaymentsboolean

Indica se o conector suporta pagamentos agendados

supportsSmartTransfersboolean

Indica se o conector suporta transferências inteligentes

supportsBoletoManagementboolean

Indica se o conector suporta gerenciamento de boleto

supportsAutomaticPixboolean

Indica se o conector suporta Pix automático

createdAtstring (date-time)

Data de criação

updatedAtstring (date-time)

Data da última modificação

Example response

json

{
  "id": 601,
  "name": "Itaú",
  "primaryColor": "EC7000",
  "institutionUrl": "https://www.itau.com.br",
  "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,
  "supportsAutomaticPix": true
}

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

Resposta de exemplo

{
  "id": 601,
  "name": "Itaú",
  "primaryColor": "EC7000",
  "institutionUrl": "https://www.itau.com.br",
  "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,
  "supportsAutomaticPix": true
}