Pular para o conteúdo principal
PATCH
Atualizar a configuração da instituição por id

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

institutionId
string
obrigatório

The institution's unique identifier (UUID).

Exemplo:

"550e8400-e29b-41d4-a716-446655440000"

Corpo

application/json
connectorMetadata
any

Connector-specific configuration bag. When present, replaces the entire bag wholesale.

Exemplo:
connectorType
string

The outbound connector type. Omitted fields are left unchanged.

Exemplo:

"midaz"

enabled
boolean

Whether the connector configuration is active. Omitted leaves the flag unchanged; explicitly false disables it.

Exemplo:

false

institutionCode
string

The institution's BACEN CNPJ (8 digits). When present, replaces the stored value.

Exemplo:

"12345678"

retryPolicyConfig
any

Operational retry policy as arbitrary JSON. When present, replaces the stored value.

Exemplo:

Resposta

OK

connectorType
string
obrigatório

The outbound connector type for this institution.

Exemplo:

"midaz"

createdAt
string
obrigatório

RFC 3339 creation timestamp (UTC).

Exemplo:

"2024-01-15T10:30:00Z"

enabled
boolean
obrigatório

Whether the connector configuration is active.

Exemplo:

true

institutionCode
string
obrigatório

The institution's BACEN CNPJ (8 digits) for return-file headers and file header validation.

Exemplo:

"12345678"

institutionId
string
obrigatório

The institution's unique identifier (UUID).

Exemplo:

"550e8400-e29b-41d4-a716-446655440000"

updatedAt
string
obrigatório

RFC 3339 last-update timestamp (UTC).

Exemplo:

"2024-01-15T12:00:00Z"

connectorMetadata
any

Connector-specific configuration bag, scrubbed of secret-bearing keys.

Exemplo:
retryPolicyConfig
any

Operational retry policy (backoff/attempts) as arbitrary JSON.

Exemplo: