Skip to main content
GET
Get institution config by 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

createdAt
string
requerido

RFC 3339 creation timestamp (UTC).

Ejemplo:

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

enabled
boolean
requerido

Whether the institution 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"

retryPolicyConfig
any

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

Ejemplo: