Referência da API
Quadra Core API
API for Quadra Core ledger. Versão 0.5.0, 68 caminhos e 72 operações em 19 tags.
Versão
0.5.0
Especificação
Accounts
- GET
/v1/accountsSearch Accounts - POST
/v1/accountsCreate an Account - GET
/v1/accounts/{account_id}Get an Account - GET
/v1/accounts/{account_id}/balanceGet Account Balance - POST
/v1/accounts/{account_id}/payment-methodsBind a Payment Method - GET
/v1/accounts/{account_id}/statementFormal account statement for a date range - GET
/v1/accounts/{account_id}/transactionsList Account Transactions
Events
Evidences
External Accounts
GL Accounts
GL Entries
Guest Accounts
Health
Holds
Journal
- GET
/v1/journal/accounts/{account_id}List an account's journal deltas (JACC) - GET
/v1/journal/entriesList journal entries by sequence range - GET
/v1/journal/entries/{seq_no}Get one journal entry (includes the canonical payload) - GET
/v1/journal/obligations/{obligation_id}Journal correlation for an obligation (creation + consumption entries)
Limits
Parties
Pix
- GET
/v1/pix/keysList Pix keys for an account - GET
/v1/pix/keys/{key_id}Get a Pix key with its claims - GET
/v1/pix/mandatesList Pix Automático mandates - GET
/v1/pix/mandates/{mandate_id}Get a Pix Automático mandate with its charges - GET
/v1/pix/med/casesList MED cases - GET
/v1/pix/med/cases/{case_id}Get a MED case - GET
/v1/pix/qr/{account_id}/staticGenerate a static Pix QR (BR Code) for an account - GET
/v1/pix/qr/chargesList dynamic Pix QR charges for an account - GET
/v1/pix/qr/charges/{txid}Get a dynamic Pix QR charge
Products
- GET
/v1/accounts/{account_id}/product-instancesList an account's product instances - GET
/v1/productsList the products bound to the caller's tenant - GET
/v1/products/{product_id}Get one bound product - GET
/v1/products/{product_id}/instancesList a product's instances - GET
/v1/products/{product_id}/instances/{instance_id}Get one product instance and its on-chain timeline
Reconciliation
Schedules
Squads
- GET
/v1/accounts/{acc_id}/invitationsList the squad invitations addressed to an account (the inbox) - GET
/v1/accounts/{acc_id}/squadsList the squads an account is a member of - GET
/v1/accounts/{acc_id}/squads/{sqd_id}/settlement-planGet the caller's open debts in a squad (settlement plan) - GET
/v1/squadsList all squads (admin) - GET
/v1/squads/{sqd_id}Get squad detail (config + members + ledger summary) - GET
/v1/squads/{sqd_id}/invitationsList a squad's pending invitations - GET
/v1/squads/{sqd_id}/membersGet a squad's active member roster - GET
/v1/squads/{sqd_id}/simplify-previewPreview debt simplification (before vs after net debts; OWNER-only) - GET
/v1/squads/{sqd_id}/spend-requestsList a squad's N-of-M spend-requests with approval history (Regras) - GET
/v1/squads/{sqd_id}/transactionsList a squad's activity (parent expenses, deposits, spends, settlements)