Skip to main content
POST
Suspender participante

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

Idempotency-Key
string

Idempotency key, max 255 characters

Parâmetros de caminho

ispb
string
obrigatório

ISPB (8 numeric digits)

Exemplo:

"12345678"

Resposta

OK

createdAt
string
obrigatório

UTC timestamp when the participant was created, RFC 3339 format.

Exemplo:

"2025-03-07T14:30:00Z"

id
string
obrigatório

Server-assigned UUID of the participant.

Exemplo:

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

ispb
string
obrigatório

ISPB of the participant, exactly 8 numeric digits.

Exemplo:

"12345678"

name
string
obrigatório

Legal name of the participant institution.

Exemplo:

"Banco Exemplo S.A."

status
string
obrigatório

Lifecycle state of the participant: ACTIVE, SUSPENDED, OFFBOARDED, PENDING (indirect reda.014 in flight), REGISTRATION_REJECTED (reda.016 REJT), or OFFBOARD_PENDING (reda.031 in flight).

Exemplo:

"ACTIVE"

type
string
obrigatório

Connection type: DIRECT (connects directly to BACEN) or INDIRECT (routes through a sponsor).

Exemplo:

"DIRECT"

updatedAt
string
obrigatório

UTC timestamp of the last update to the participant, RFC 3339 format.

Exemplo:

"2025-03-07T14:30:00Z"

config
object

Quota and routing configuration; present only for indirect participants.

sponsorISPB
string

ISPB of the sponsoring participant (8 numeric digits); present only for INDIRECT participants.

Exemplo:

""