Referência / Quadra Command API
Schedules
6 operações em Quadra Command API 0.2.0.
/v1/scheduler/tickDrive one engine tick (internal — the D8 EventBridge belt)
Idempotent by construction (every claim/transition is conditional), so double-driving against the in-process ticker is harmless. The production belt calls this at rate(1 minute) via an EventBridge API destination.
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. |
/v1/schedulesCreate a scheduled action (Pix Agendado / recurring rule)
Create a ONE_SHOT or RECURRING schedule whose action runs through the ordinary obligation funnel at each due instant. Requires an Idempotency-Key header.
Parâmetros
| Nome | Tipo | Detalhe |
|---|---|---|
| Idempotency-Key | string | headerobrigatório |
Corpo da requisição
CreateScheduleRequest — 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/schedules/{schedule_id}Cancel a schedule (terminal)
Parâmetros
| Nome | Tipo | Detalhe |
|---|---|---|
| schedule_id | string | pathobrigatório |
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 |
/v1/schedules/{schedule_id}Edit a schedule (amount, creditor, rule, timezone, grace, retry)
Parâmetros
| Nome | Tipo | Detalhe |
|---|---|---|
| schedule_id | string | pathobrigatório |
Corpo da requisição
PatchScheduleRequest — 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 |
/v1/schedules/{schedule_id}/pausePause an ACTIVE schedule (clears the due pointer)
Parâmetros
| Nome | Tipo | Detalhe |
|---|---|---|
| schedule_id | string | pathobrigatório |
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 |
/v1/schedules/{schedule_id}/resumeResume a PAUSED schedule (next occurrence recomputed from now)
Parâmetros
| Nome | Tipo | Detalhe |
|---|---|---|
| schedule_id | string | pathobrigatório |
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.
CreateScheduleRequest
| Campo | Tipo | Detalhe |
|---|---|---|
| account_id | string | obrigatórioOwning account (= debtor) |
| action | ScheduleAction | obrigatório |
| first_run_at | string, opcional | RECURRING anchor; defaults to creation time |
| misfire_grace_seconds | integer | Padrão 86400 |
| recurrence | RecurrenceRule, opcional | |
| retry_policy | RetryPolicy, opcional | |
| run_at | string, opcional | ONE_SHOT: the scheduled instant |
| schedule_type | "ONE_SHOT" | "RECURRING" | obrigatório |
| timezone | string | IANA zone for wall-clock recurrence mathPadrão "America/Sao_Paulo" |
HTTPValidationError
| Campo | Tipo | Detalhe |
|---|---|---|
| detail | array de ValidationError |
PatchScheduleRequest
All-optional subset; PATCH on a mandate-owned schedule is rejected upstream with 422 MANDATE_MANAGED.
| Campo | Tipo | Detalhe |
|---|---|---|
| action | ScheduleAction, opcional | |
| misfire_grace_seconds | integer, opcional | |
| recurrence | RecurrenceRule, opcional | |
| retry_policy | RetryPolicy, opcional | |
| run_at | string, opcional | |
| timezone | string, opcional |
RecurrenceRule
| Campo | Tipo | Detalhe |
|---|---|---|
| by_day | array de "MO" | "TU" | "WE" | "TH" | "FR" | "SA" | "SU", opcional | WEEKLY only; defaults to the anchor's weekday |
| count | integer, opcional | |
| day_of_month | integer, opcional | MONTHLY only; end-of-month clamp applies |
| frequency | "DAILY" | "WEEKLY" | "MONTHLY" | "YEARLY" | obrigatório |
| interval | integer | Padrão 1 |
| until | string, opcional | Inclusive ISO-8601 UTC instant; mutually exclusive with count |
RetryPolicy
Local self-retry for generic schedules only (D7) — mandate charge retentativa is rail-side and never configured here.
| Campo | Tipo | Detalhe |
|---|---|---|
| max_attempts | integer | obrigatório |
| retry_interval_seconds | integer | obrigatório |
ScheduleAction
Closed enum with one value — extensible without a DSL (Tier-4).
| Campo | Tipo | Detalhe |
|---|---|---|
| action_type | string | obrigatório |
| amount_cents | integer | obrigatório |
| creditor | ScheduleActionParty | obrigatório |
| currency | string | Padrão "BRL" |
| debtor_account_id | string | obrigatório |
| description | string, opcional | |
| rail | "QUADRA" | "ACH" | "MOCK" | "PIX" | obrigatório |
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 |