Referência da API
Quadra Command API
Command ingestion API for Quadra ledger operations. Versão 0.2.0, 121 caminhos e 141 operações em 16 tags.
Versão
0.2.0
Especificação
Accounts
Blocks
Evidence
GL Accounts
Holds
KYC
- POST
/v1/kyc/rescreen-sweepRe-screen verified parties past cadence or marked due - POST
/v1/kyc/webhooks/{provider_id}KYC provider webhook receiver - POST
/v1/parties/{party_id}/kycSubmit KYC verification for a party - PATCH
/v1/parties/{party_id}/kyc/statusOperator KYC review resolution - POST
/v1/parties/{party_id}/risk-flagsAdd a risk flag to a party - DELETE
/v1/parties/{party_id}/risk-flags/{flag_id}Resolve a risk flag (soft-resolve; row kept for audit)
Limits
Obligations
Operator
- POST
/v1/evidence/{evidence_id}/resolveManually match an unmatched evidence to an obligation - POST
/v1/evidence/{evidence_id}/retryRetry a failed evidence ingest - POST
/v1/obligations/{obligation_id}/redispatchRe-drive a failed outbound dispatch - POST
/v1/obligations/{obligation_id}/resolveOperator resolve of a stuck obligation - GET
/v1/operator/tenants/{tenant}/foundry/compilesList a tenant's compile jobs - POST
/v1/operator/tenants/{tenant}/foundry/compilesSubmit a product bundle to the Foundry - GET
/v1/operator/tenants/{tenant}/foundry/compiles/{compile_id}Get one compile job and its gate report - GET
/v1/operator/tenants/{tenant}/foundry/compiles/{compile_id}/sourceRead a submission's source (the P6 countersigner's read) - GET
/v1/operator/tenants/{tenant}/product-keysRead a tenant's bundle-signing key enrollment - POST
/v1/operator/tenants/{tenant}/product-keysEnroll a tenant's bundle-signing public key - GET
/v1/operator/tenants/{tenant}/productsList a tenant's product bindings - GET
/v1/operator/tenants/{tenant}/products/{product_id}Get a tenant product binding - PATCH
/v1/operator/tenants/{tenant}/products/{product_id}Move a product binding through its lifecycle - POST
/v1/operator/tenants/{tenant}/products/{product_id}Bind a certified product artifact to one tenant - GET
/v1/operator/tenants/{tenant}/products/{product_id}/certificationRead a product's certification envelope - POST
/v1/operator/tenants/{tenant}/products/{product_id}/certificationCertify a product binding against its evidence - GET
/v1/operator/tenants/{tenant}/products/{product_id}/drainPlan a drain: how each open instance would be closed - POST
/v1/operator/tenants/{tenant}/products/{product_id}/drainDrain a product: close the named instances - GET
/v1/operator/tenants/{tenant}/provider-accountsList a tenant's processor accounts - POST
/v1/operator/tenants/{tenant}/provider-accountsOpen a tenant's account at a processor - POST
/v1/operator/tenants/{tenant}/provider-accounts/{provider_id}/transfersMove value between two accounts inside one processor - GET
/v1/operator/tenants/{tenant}/qbrl-policyRead a tenant's QBRL minting policy binding - POST
/v1/operator/tenants/{tenant}/qbrl-policyBind a tenant to its own QBRL minting policy - GET
/v1/operator/tenants/{tenant}/quotasRead a tenant's quota and current usage - PUT
/v1/operator/tenants/{tenant}/quotasSet a tenant's quota overrides - GET
/v1/operator/tenants/{tenant}/rail-bindingsList a tenant's inbound provider routes - POST
/v1/operator/tenants/{tenant}/rail-bindingsAssign a provider's inbound credits to a tenant - GET
/v1/operator/tenants/{tenant}/transfer-templatesList a tenant's transfer templates - POST
/v1/operator/tenants/{tenant}/transfer-templatesAuthor a tenant transfer template - GET
/v1/operator/tenants/{tenant}/transfer-templates/{template_id}Get a tenant transfer template - PATCH
/v1/operator/tenants/{tenant}/transfer-templates/{template_id}Retire a tenant transfer template
Pix
- POST
/v1/pix/keysRegister a Pix key via the sponsor's DICT access - DELETE
/v1/pix/keys/{key_id}Exclude a Pix key from the DICT - POST
/v1/pix/keys/{key_id}/portability/cancelCancel the key's active claim - POST
/v1/pix/keys/{key_id}/portability/claimOpen a portability claim (we are the claimer) - POST
/v1/pix/keys/{key_id}/portability/confirmConfirm the key's active claim - POST
/v1/pix/keys/eventsSponsor DICT key-event ingest (deprecated alias) - POST
/v1/pix/keys/events/{provider_id}Sponsor DICT key-event ingest - GET
/v1/pix/keys/lookupPre-payment DICT lookup - POST
/v1/pix/mandates/{mandate_id}/authorizeAuthorize a Pix Automático mandate (relayed to the sponsor) - POST
/v1/pix/mandates/{mandate_id}/charges/{charge_id}/cancelCancel a pending mandate charge pre-debit (relayed to the sponsor) - POST
/v1/pix/mandates/{mandate_id}/rejectReject a pending Pix Automático mandate - POST
/v1/pix/mandates/{mandate_id}/revokeRevoke an ACTIVE mandate (releases holds, cancels pending charges) - POST
/v1/pix/mandates/eventsSponsor Pix Automático event ingest (deprecated alias) - POST
/v1/pix/mandates/events/{provider_id}Sponsor Pix Automático mandate/charge event ingest - POST
/v1/pix/med/casesFile a MED infraction with the sponsor - POST
/v1/pix/med/cases/{case_id}/resolveResolve a MED case (RETURN or RELEASE) - POST
/v1/pix/med/eventsSponsor MED case-event receiver (deprecated alias) - POST
/v1/pix/med/events/{provider_id}Sponsor MED case-event receiver (infractions) - POST
/v1/pix/qr/{account_id}/dynamicCreate a dynamic Pix QR (sponsor-hosted single-use charge) - POST
/v1/pix/qr/decodeDecode a scanned BR Code payload - POST
/v1/pix/returnInitiate a devolução of a received Pix credit - POST
/v1/pix/webhooks/{provider_id}Sponsor Pix inbound webhook receiver
Products
- GET
/v1/foundry/compilesList your own compile jobs - POST
/v1/foundry/compilesSubmit your own Product Bundle to the Foundry - GET
/v1/foundry/compiles/{compile_id}Read one of your compile jobs and its gate report - GET
/v1/foundry/quotaHow much of your daily compile allowance is left - GET
/v1/openapiYour tenant's own OpenAPI document - GET
/v1/openapi/sdk/{language}A generated client for your own products - POST
/v1/products/{product_id}Bind a shipped template as your own DRAFT product - POST
/v1/products/{product_id}/batteryRun the adversarial battery against your own product - GET
/v1/products/{product_id}/battery/{battery_id}Read a battery run and its report card - GET
/v1/products/{product_id}/certificationYour product's certification, and whether it has gone stale - POST
/v1/products/{product_id}/certificationCertify your own product from the evidence it produced - GET
/v1/products/{product_id}/certification/evidence/{kind}One evidence document a certification references - POST
/v1/products/{product_id}/conformanceOpen a conformance run against your own product - GET
/v1/products/{product_id}/conformance/{run_id}Read a conformance run, its steps and its verdict - POST
/v1/products/{product_id}/conformance/{run_id}/steps/{index}Drive one step of a conformance run - POST
/v1/products/{product_id}/instancesCreate an instance of a tenant product - POST
/v1/products/{product_id}/instances/{instance_id}/actions/{action}Drive a declared action on a product instance - POST
/v1/products/{product_id}/instances/{instance_id}/closeClose a product instance and release its value - GET
/v1/products/{product_id}/scenariosThe scenarios this product's manifest declares
Reconciliation
Schedules
- POST
/v1/scheduler/tickDrive one engine tick (internal — the D8 EventBridge belt) - POST
/v1/schedulesCreate a scheduled action (Pix Agendado / recurring rule) - DELETE
/v1/schedules/{schedule_id}Cancel a schedule (terminal) - PATCH
/v1/schedules/{schedule_id}Edit a schedule (amount, creditor, rule, timezone, grace, retry) - POST
/v1/schedules/{schedule_id}/pausePause an ACTIVE schedule (clears the due pointer) - POST
/v1/schedules/{schedule_id}/resumeResume a PAUSED schedule (next occurrence recomputed from now)
Squads
- POST
/v1/squadsCreate a Squad shared account - PATCH
/v1/squads/{sqd_id}Owner: edit a squad's display metadata (name / emoji / image / location) - PUT
/v1/squads/{sqd_id}/auto-collect/consentMember: grant / refresh auto-collect consent for a conta - DELETE
/v1/squads/{sqd_id}/auto-collect/consent/{consent_id}Member: revoke auto-collect consent (one tap) - POST
/v1/squads/{sqd_id}/closeClose the squad (OWNER; terminal, irreversible) - POST
/v1/squads/{sqd_id}/contributionsContribute to a Squad (kind=FUNDED deposits QBRL; kind=ACCOUNTING records a split) - DELETE
/v1/squads/{sqd_id}/contributions/{entry_seq}Void (forgive) an accounting entry's unsettled shares (creditor only) - PATCH
/v1/squads/{sqd_id}/entries/{entry_seq}/splitOwner: manually re-split one expense's open shares - POST
/v1/squads/{sqd_id}/freezeOwner: freeze a squad (wind-down; reversible) - DELETE
/v1/squads/{sqd_id}/goalOwner: remove a squad's savings goal - PUT
/v1/squads/{sqd_id}/goalOwner: set or edit a squad's savings goal (target amount + optional date) - POST
/v1/squads/{sqd_id}/invitationsInvite one or more accounts to a Squad - DELETE
/v1/squads/{sqd_id}/invitations/{invitee_account_id}Revoke a pending Squad invitation - POST
/v1/squads/{sqd_id}/invitations/acceptAccept a Squad invitation - POST
/v1/squads/{sqd_id}/invitations/declineDecline a Squad invitation - DELETE
/v1/squads/{sqd_id}/members/{member_account_id}Remove a member from a Squad - PATCH
/v1/squads/{sqd_id}/members/{member_account_id}/quotaChange a member's quota (cota) count - PATCH
/v1/squads/{sqd_id}/members/{member_account_id}/rolePromote/demote a member between OWNER and SPENDER - PUT
/v1/squads/{sqd_id}/recurrenceOwner: enable / edit / disable a squad's monthly cycles - POST
/v1/squads/{sqd_id}/recurring-expensesOwner: create a recurring expense (conta / bill template) - DELETE
/v1/squads/{sqd_id}/recurring-expenses/{rex_id}Owner: delete a recurring expense (conta) - PATCH
/v1/squads/{sqd_id}/recurring-expenses/{rex_id}Owner: edit a recurring expense (conta) - POST
/v1/squads/{sqd_id}/recurring-expenses/{rex_id}/confirmPayer: confirm a variable conta's real amount for the current period - DELETE
/v1/squads/{sqd_id}/rulesOwner: remove a squad's spend-approval policy - PUT
/v1/squads/{sqd_id}/rulesOwner: set or edit a squad's spend-approval policy (Regras) - POST
/v1/squads/{sqd_id}/settleSettle the caller's own shares (per-debtor self-settle) - POST
/v1/squads/{sqd_id}/simplify-debtsSimplify the squad's debts (OWNER; minimal multi-party netting) - POST
/v1/squads/{sqd_id}/spend-requests/{spr_id}/approveApprove a pending squad spend-request (the Nth approval executes it) - POST
/v1/squads/{sqd_id}/spend-requests/{spr_id}/rejectReject (kill) a pending squad spend-request - POST
/v1/squads/{sqd_id}/spendsSpend from a Squad to an external recipient - POST
/v1/squads/{sqd_id}/unfreezeOwner: unfreeze a squad (resume normal activity)