Holds
2 operações em Quadra Core API 0.5.0.
GET
/v1/holdsList holds
List holds — account-scoped (HOLD_ACCT rows) or global (GSI5).
Scoped to the calling tenant; an `account_id` belonging to another tenant reads as not found. **Page until `next_cursor` is null** — a short page is not the end of the list.
Parâmetros
| Nome | Tipo | Detalhe |
|---|---|---|
| account_id | string, opcional | query |
| status | string, opcional | query Filter by hold state |
| type | string, opcional | query Filter by hold_type |
| limit | integer | query |
| cursor | string, opcional | query |
Respostas
| Status | Corpo | Detalhe |
|---|---|---|
| 200 | HoldListResponse | Resposta bem-sucedida |
| 422 | HTTPValidationError | Erro de validação |
GET
/v1/holds/{hold_id}Get hold details
Parâmetros
| Nome | Tipo | Detalhe |
|---|---|---|
| hold_id | string | pathobrigatório |
Respostas
| Status | Corpo | Detalhe |
|---|---|---|
| 200 | HoldDetailResponse | Resposta bem-sucedida |
| 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.
HoldDetailResponse
| Campo | Tipo | Detalhe |
|---|---|---|
| account_id | string | obrigatório |
| amount_cents | integer | obrigatórioCurrently encumbered amount in centavos |
| capture_obligation_id | string, opcional | |
| captured_amount_cents | integer, opcional | |
| captured_at | string, opcional | |
| created_at | string | obrigatório |
| currency | string | obrigatório |
| expired_at | string, opcional | |
| expires_at | string, opcional | |
| hold_id | string | obrigatório |
| hold_type | string | obrigatório |
| metadata | object, opcional | |
| reference | string, opcional | |
| release_reason | string, opcional | |
| released_at | string, opcional | |
| released_remainder_cents | integer, opcional | |
| state | string | obrigatório |
| updated_at | string | obrigatório |
| void_reason | string, opcional |
HoldListResponse
| Campo | Tipo | Detalhe |
|---|---|---|
| items | array de HoldSummary | obrigatório |
| next_cursor | string, opcional |
HoldSummary
| Campo | Tipo | Detalhe |
|---|---|---|
| account_id | string | obrigatório |
| amount_cents | integer | obrigatórioCurrently encumbered amount in centavos |
| created_at | string | obrigatório |
| currency | string | obrigatório |
| expires_at | string, opcional | |
| hold_id | string | obrigatório |
| hold_type | string | obrigatório |
| state | string | obrigatório |
| updated_at | string | obrigatório |
HTTPValidationError
| Campo | Tipo | Detalhe |
|---|---|---|
| detail | array de ValidationError |
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 |