Corgi BankDocumentation
OpenAPI

Read bounded current payable work queue under exact payments service authority

GET/ledger/payable-obligations

Verified svc_payments with existing ledger:post is required even locally. Bounded current operational work queue: optional starting_after typed obligation cursor, limit1–100(default25), kind, issuer, account_id, loan_id and status unpaid(default) or all. Returns immutable source/owner/tax context and current reserved/paid/returned/refunded/unallocated/unpaid amounts with opaque remittance identities. A page is not an immutable closing snapshot; current amounts are rechecked before issue. Unknown/duplicate query fields refuse; source issuers cannot enumerate the bank queue.

Returns

200 OK

has_morebooleanRequired
itemsarray of objectsRequired
10 child attributes
blockersarray of stringsOptional
cash_readybooleanRequired
obligationobjectRequired
22 child attributes
account_idstringOptional

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

amount_minorintegerRequired
content_sha256stringRequired
created_atstring · date-timeRequired
currencystringRequired
customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

evidence_referencestringRequired
hold_idstringRequired

Example hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm

idstringRequired
issuerstringRequired
jurisdictionstringOptional
kindstringRequired
legal_entitystringRequired
loan_idstringOptional

Example loan_2tVh8nqLxq4GbDe0K1F6S9zRcWm

payee_referencestringOptional
sourceobjectRequired
6 child attributes
closure_componentstringOptional
closure_ledger_account_idstringOptional

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

journal_idstringRequired

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

journal_keystringRequired
journal_sha256stringRequired
ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

source_datestring · dateRequired

A business date, YYYY-MM-DD

source_date_basisstringOptional
source_idstringRequired
source_sha256stringRequired
tax_customer_idstringOptional

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

tax_periodstringOptional
paid_minorintegerRequired
refunded_minorintegerRequired
remittance_idsarray of stringsRequired
reserved_minorintegerRequired
returned_minorintegerRequired
unallocated_minorintegerRequired
unpaid_minorintegerRequired
next_cursorstringOptional

Errors

Every error is a problem document with a stable code. See Errors.

400401403404409412413422424429500503

to move to open esc to close