Corgi BankDocumentation
OpenAPI

List all payable obligations

GET/payable-obligations

Verified staff/service with payments:read or staff with payments:operations:write authority is required. Read a forward-only queue with starting_after as a typed payable obligation ID, limit default 25 and maximum 100, status default unpaid or explicit all, and exact optional kind, issuer, account_id and loan_id filters. Returns complete items with has_more and next_cursor. Unknown or repeated query parameters, malformed encoding and invalid explicit limits are refused; the query is bounded to 8 KiB. This read does not reserve or remit money. Customer authority is refused. Requests are strict single JSON objects bounded to 8 MiB; complete responses are bounded to 16 MiB and never silently truncated.

Query parameters

starting_afterstringOptional
limitstringOptional
kindstringOptional
issuerstringOptional
account_idstringOptional
loan_idstringOptional
statusstringOptional

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