Pix

9 operações em Quadra Core API 0.5.0.

GET/v1/pix/keys

List Pix keys for an account

List the account's sponsor-registered DICT keys (GSI1 ACCOUNT_PIXKEY# rows). Writes live on command-api (POST /v1/pix/keys).

Parâmetros

Nome	Tipo	Detalhe
account_id	string	queryobrigatório
limit	integer	query
cursor	string, opcional	query

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

GET/v1/pix/keys/{key_id}

Get a Pix key with its claims

Get a single Pix key registry row plus its claim history (each claim carries the read-side `expired` flag) and the key's state_history.

Parâmetros

Nome	Tipo	Detalhe
key_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

GET/v1/pix/mandates

List Pix Automático mandates

List mandates — per-account via the MANDACCT# direct-PK rows, or globally via the sparse GSI9 MANDATE_ALL listing (newest first).

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 Filter to one account
status	string, opcional	query Filter by mandate status
limit	integer	query
cursor	string, opcional	query

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

GET/v1/pix/mandates/{mandate_id}

Get a Pix Automático mandate with its charges

Parâmetros

Nome	Tipo	Detalhe
mandate_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

GET/v1/pix/med/cases

List MED cases

List MED cases newest-first (operations-table GSI1 listing — low-cardinality admin query). Filters apply in-memory per page (the hold-views posture), so a filtered page may return fewer than ``limit`` items while ``next_cursor`` still advances.

Parâmetros

Nome	Tipo	Detalhe
status	string, opcional	query Filter by case state
account_id	string, opcional	query Filter by suspect account
limit	integer	query
cursor	string, opcional	query

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

GET/v1/pix/med/cases/{case_id}

Get a MED case

Get a single MED case with its full history[].

Parâmetros

Nome	Tipo	Detalhe
case_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

GET/v1/pix/qr/{account_id}/static

Generate a static Pix QR (BR Code) for an account

Generate a reusable static BR Code entirely locally (LaaS-15 D5): a pure read of the account's ACTIVE Ticket-14 key + owner party -> the shared/brcode.py codec. Stateless — no PIXQR# row, no status. key_id is defaulted when the account has exactly one ACTIVE key (else 422).

Parâmetros

Nome	Tipo	Detalhe
account_id	string	pathobrigatório
key_id	string, opcional	query
amount_cents	integer, opcional	query
description	string, opcional	query
txid	string, opcional	query

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

GET/v1/pix/qr/charges

List dynamic Pix QR charges for an account

List the account's PIXQR# charge rows (GSI1 ACCOUNT_PIXQR# rows). Writes live on command-api (POST /v1/pix/qr/{account_id}/dynamic).

Parâmetros

Nome	Tipo	Detalhe
account_id	string	queryobrigatório
limit	integer	query
cursor	string, opcional	query

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

GET/v1/pix/qr/charges/{txid}

Get a dynamic Pix QR charge

Read one PIXQR# charge row (pure DynamoDB — the polling surface the guest settle flow consumes). Computes the read-side `expired` flag.

Parâmetros

Nome	Tipo	Detalhe
txid	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.

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

← Quadra Core API Chamar no playground →