Referência / Quadra Command API
Blocks
2 operações em Quadra Command API 0.2.0.
/v1/accounts/{account_id}/blocksPlace a Targeted Compliance Block (Bloqueio Cautelar)
Freeze ``amount_cents`` of the account (never the whole account) as a COMPLIANCE_BLOCK hold only the block routes can release. Consumes no velocity budget (LaaS-07 D3). ``expires_at`` absent = 72 h default TTL; explicit null = indefinite (judicial). ``allow_partial`` blocks ``min(amount, available)`` — the 201 body carries ``requested_amount_cents`` vs the placed ``amount_cents``.
Parâmetros
| Nome | Tipo | Detalhe |
|---|---|---|
| account_id | string | pathobrigatório |
| Idempotency-Key | string | headerobrigatório |
Corpo da requisição
PlaceBlockRequest — obrigatório. Os campos estão listados em Esquemas, abaixo.
Respostas
| Status | Corpo | Detalhe |
|---|---|---|
| 201 | — | Resposta bem-sucedidaO contrato não declara um modelo para esta resposta, então a forma dela não está documentada aqui. Um roteiro de demonstração mostra a forma que ela realmente devolve. |
| 422 | HTTPValidationError | Erro de validação |
/v1/blocks/{block_id}/releaseRelease a Compliance Block
The only release path for a COMPLIANCE_BLOCK (the ordinary hold routes 422 on reserved types). Compensates no velocity budget — the place consumed none (LaaS-07 D3).
Parâmetros
| Nome | Tipo | Detalhe |
|---|---|---|
| block_id | string | pathobrigatório |
| Idempotency-Key | string | headerobrigatório |
Corpo da requisição
ReleaseBlockRequest — obrigatório. Os campos estão listados em Esquemas, abaixo.
Respostas
| Status | Corpo | Detalhe |
|---|---|---|
| 200 | — | Resposta bem-sucedidaO contrato não declara um modelo para esta resposta, então a forma dela não está documentada aqui. Um roteiro de demonstração mostra a forma que ela realmente devolve. |
| 422 | HTTPValidationError | Erro de validação |
Esquemas
Os modelos que as operações acima aceitam e devolvem. Campos opcionais estão marcados como tal; um campo tipado como outro modelo está documentado sob o nome dele.
HTTPValidationError
| Campo | Tipo | Detalhe |
|---|---|---|
| detail | array de ValidationError |
PlaceBlockRequest
Operator-class bloqueio cautelar placement (LaaS-07 D2/D4).
| Campo | Tipo | Detalhe |
|---|---|---|
| actor | string | obrigatórioOperator identity (caller-injected until laas-23 authz lands) |
| allow_partial | boolean | Block min(amount, available) — MED must block whatever is left of suspect fundsPadrão true |
| amount_cents | integer | obrigatórioAmount to block, in centavos |
| case_ref | string | obrigatórioCompliance case linkage (MED infraction id, court order, ...) — stored as the hold reference |
| case_type | string, opcional | Case classification (e.g. MED, JUDICIAL); stored in hold metadata |
| currency | string | ISO 4217 currency codePadrão "BRL" |
| expires_at | string, opcional | ISO-8601 expiry. ABSENT = default TTL (72h, Res. BCB 147/2021); explicit null = indefinite (judicial blocks never auto-lapse) |
| metadata | object, opcional |
ReleaseBlockRequest
| Campo | Tipo | Detalhe |
|---|---|---|
| actor | string | obrigatório |
| case_ref | string, opcional | Audit cross-reference only |
| reason | string, opcional |
ValidationError
| Campo | Tipo | Detalhe |
|---|---|---|
| ctx | object | |
| input | não declarado | |
| loc | array de string ou integer | obrigatório |
| msg | string | obrigatório |
| type | string | obrigatório |