Skip to main content
PATCH
Update institution config by id

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Path Parameters

institutionId
string
required

The institution's unique identifier (UUID).

Example:

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

Body

application/json
connectorMetadata
any

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

Example:
connectorType
string

The outbound connector type. Omitted fields are left unchanged.

Example:

"midaz"

enabled
boolean

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

Example:

false

institutionCode
string

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

Example:

"12345678"

retryPolicyConfig
any

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

Example:

Response

OK

connectorType
string
required

The outbound connector type for this institution.

Example:

"midaz"

createdAt
string
required

RFC 3339 creation timestamp (UTC).

Example:

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

enabled
boolean
required

Whether the connector configuration is active.

Example:

true

institutionCode
string
required

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

Example:

"12345678"

institutionId
string
required

The institution's unique identifier (UUID).

Example:

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

updatedAt
string
required

RFC 3339 last-update timestamp (UTC).

Example:

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

connectorMetadata
any

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

Example:
retryPolicyConfig
any

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

Example: