Referência / Quadra Command API
Holds
4 operações em Quadra Command API 0.2.0.
/v1/holdsPlace a Hold on Account Funds
Reserve funds on an account: they leave `available`, appear in `held`, and remain in the owner's custody until captured or released. Optional deadline (`expires_at` XOR `expires_in_hours`); absent = indefinite.
Parâmetros
| Nome | Tipo | Detalhe |
|---|---|---|
| Idempotency-Key | string | headerobrigatório |
Corpo da requisição
PlaceHoldRequest — 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/holds/{hold_id}Adjust a Hold's Amount or Expiry
Decrease the hold amount (re-split; the difference is released) and/or change the expiry (record-only; explicit null clears the deadline). Amount increases are rejected — place a second hold.
Parâmetros
| Nome | Tipo | Detalhe |
|---|---|---|
| hold_id | string | pathobrigatório |
| Idempotency-Key | string | headerobrigatório |
Corpo da requisição
AdjustHoldRequest — 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/holds/{hold_id}/captureCapture a Hold into an Obligation
Convert the hold (fully or partially) into an ordinary obligation to the creditor; any remainder returns to the holder's available balance. Single-shot: the hold goes terminal CAPTURED.
Parâmetros
| Nome | Tipo | Detalhe |
|---|---|---|
| hold_id | string | pathobrigatório |
| Idempotency-Key | string | headerobrigatório |
Corpo da requisição
CaptureHoldRequest — 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/holds/{hold_id}/releaseRelease a Hold
Release held funds back to the holder's spendable balance (chain-free).
Parâmetros
| Nome | Tipo | Detalhe |
|---|---|---|
| hold_id | string | pathobrigatório |
| Idempotency-Key | string | headerobrigatório |
Corpo da requisição
ReleaseHoldRequest, opcional — opcional. 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.
AdjustHoldRequest
| Campo | Tipo | Detalhe |
|---|---|---|
| amount_cents | integer, opcional | New (smaller) hold amount in centavos; increases are rejected |
| expires_at | string, opcional | New ISO-8601 expiry; explicit null clears the deadline (indefinite) |
CaptureHoldRequest
| Campo | Tipo | Detalhe |
|---|---|---|
| amount_cents | integer, opcional | Partial capture amount in centavos; omitted = full capture |
| creditor_account_id | string | obrigatórioAccount receiving the captured funds |
HTTPValidationError
| Campo | Tipo | Detalhe |
|---|---|---|
| detail | array de ValidationError |
PlaceHoldRequest
| Campo | Tipo | Detalhe |
|---|---|---|
| account_id | string | obrigatórioHolder account (funds never leave it) |
| amount_cents | integer | obrigatórioAmount to encumber, in centavos |
| currency | string | ISO 4217 currency codePadrão "BRL" |
| expires_at | string, opcional | ISO-8601 expiry; mutually exclusive with expires_in_hours. Absent = indefinite. |
| expires_in_hours | integer, opcional | Relative expiry in hours; mutually exclusive with expires_at |
| hold_type | string | obrigatórioFree-form hold classification (e.g. CARD_AUTH, PIX_AUTOMATICO) |
| metadata | object, opcional | |
| reference | string, opcional |
ReleaseHoldRequest
| Campo | Tipo | Detalhe |
|---|---|---|
| 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 |