PATCH/items/{id}

Atualizar

Dispara uma nova sincronização do Item, opcionalmente atualizando as credenciais armazenadas.

Este endpoint deve ser chamado para acionar uma nova sincronização com a Instituição. As credenciais são opcionais neste caso; se não forem fornecidas, serão utilizadas as armazenadas.

Se você quiser enviar um novo conjunto de credenciais necessárias para executar o conector, terá que revisar as credenciais definidas em GET /connectors, que retorna um array de credentials para o conector específico.

Este objeto será criado como pares chave-valor, o name da credencial será a chave, e a entrada do usuário será o valor.

{}

{
  "user": "user-ok",
  "password": "password-ok"
}

{
  "token": "123456" 
}

❗️ MFA de 1 etapa

Se o conector exigir um parâmetro MFA, como um Token, para executar uma atualização, você será obrigado a enviar um MFA válido e diferente do último executado, para iniciar uma nova sincronização. Caso contrário, você receberá em ambos os cenários uma mensagem de erro HTTP 400 para enviar uma entrada correta.

Parameters

Path Parameters

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

Request Body

Requisição de atualização do item

object

Update Item Request

parametersobject

Parâmetros para atualizar as credenciais armazenadas do item.

<key>string

One of:

option 1object

option 2string

clientUserIdstring

Identificador externo do cliente para o usuário, pode ser um ID, UUID ou até mesmo um e-mail. Isso é livre para os clientes usarem.

webhookUrlstring (uri)

Url para ser notificado sobre mudanças de item

productsstring[]

Produtos a serem coletados na conexão

itemsstring

ACCOUNTSCREDIT_CARDSTRANSACTIONSPAYMENT_DATAINVESTMENTSINVESTMENTS_TRANSACTIONSIDENTITYBROKERAGE_NOTEMOVE_SECURITYLOANS

Example

json

{
  "webhookUrl": "https://example.com/webhook",
  "clientUserId": "My User App Id",
  "parameters": {
    "user": "user-ok",
    "password": "password-ok"
  }
}

Responses

200O item foi atualizado com sucesso e uma nova sincronização foi disparada

object

Item object

idrequiredstring

Identificador principal

connectorobject

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

hasMFAboolean

O conector requer um MFA para ser executado?

productsstring[]

Produtos suportados pelo conector

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.

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

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

statusrequiredstring

Status do Item

executionStatusrequiredstring

Status da execução da sincronização

errorobject

Mensagem de erro detalhada

coderequiredstring

Error code

messagerequiredstring

Detailed error message

providerMessagestring

Information provider by the institution mainly when user needs to perform an action

attributesobject

'{ [key]:[value] }'. Additional information necessary for future executions, used for example in some device authorization flow

parameterobject

Credential details for a connector

namerequiredstring

Nome da chave

labelrequiredstring

Rótulo para entrada

typerequiredstring

Tipo de credencial necessária

textpasswordnumberimageselect

assistiveTextstring

Texto para ajudar o usuário ao preencher a entrada

datastring

Usado para retornar imagens em base64

placeholderstring

Texto de exemplo para a entrada

validationstring

Validação de regex para a entrada do usuário

validationMessagestring

Mensagem de validação quando a entrada não corresponde à expressão regular

mfaboolean

A Credencial é um parâmetro MFA e deve ser atualizada a cada execução.

optionsobject[]

Lista de valores possíveis para a entrada

optionalrequiredboolean

Se a credencial pode ser deixada em branco. Sempre presente; padrão é falso.

instructionsstring

Instruções para ajudar o usuário a obter esta credencial

expiresAtstring (date-time)

Data de expiração do valor da credencial, quando a instituição define uma.

userActionobject

User action details for an item

instructionsrequiredstring

Instruções relacionadas à ação do usuário

attributesobject

'{ [key]:[value] }'. Informações adicionais relacionadas à ação do usuário, por exemplo, em algum fluxo de autorização de dispositivo

expiresAtstring (date-time)

Data de expiração da ação do usuário

typerequiredstring

Tipo de ação que o usuário deve realizar: escanear um código QR ou autorizar o acesso no aplicativo da instituição.

qrauthorize-access

webhookUrlstring

Url para ser notificado sobre mudanças de item

createdAtstring (date-time)

Data de criação

updatedAtstring (date-time)

Data da última modificação

lastUpdatedAtstring (date-time)

Data da última sincronização

statusDetailobject

Detailed status of the item. This field will be present when the status is PARTIAL_SUCCESS or when a product in the item has warnings

accountsobject