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

Resposta

OK

createdAt
string
obrigatório

RFC 3339 creation timestamp (UTC).

Exemplo:

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

enabled
boolean
obrigatório

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

retryPolicyConfig
any

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

Exemplo: