Skip to main content
GET
Obtener la configuración de institución por id

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

institutionId
string
requerido

The institution's unique identifier (UUID).

Ejemplo:

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

Respuesta

OK

connectorType
string
requerido

The outbound connector type for this institution.

Ejemplo:

"midaz"

createdAt
string
requerido

RFC 3339 creation timestamp (UTC).

Ejemplo:

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

enabled
boolean
requerido

Whether the connector configuration is active.

Ejemplo:

true

institutionCode
string
requerido

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

Ejemplo:

"12345678"

institutionId
string
requerido

The institution's unique identifier (UUID).

Ejemplo:

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

updatedAt
string
requerido

RFC 3339 last-update timestamp (UTC).

Ejemplo:

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

connectorMetadata
any

Connector-specific configuration bag. The non-secret connector-owned keys (baseUrl, authAddress, crmBaseUrl, organizations[], blockableBalances, blockableAccountTypes, salaryAccountTypes) are preserved verbatim; secret-bearing keys — the whole credentials subtree included — are removed and never echoed. blockableBalances carries the LEDGER's balance-key values — for Midaz, balanceKey (default/overdraft/a client-registered key), not the available/onHold fields of a balance.

Ejemplo:
retryPolicyConfig
any

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

Ejemplo: