List all payable obligations
/payable-obligationsVerified 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_afterstringOptionallimitstringOptionalkindstringOptionalissuerstringOptionalaccount_idstringOptionalloan_idstringOptionalstatusstringOptionalReturns
200 OK
has_morebooleanRequireditemsarray of objectsRequired10 child attributes
blockersarray of stringsOptionalcash_readybooleanRequiredobligationobjectRequired22 child attributes
account_idstringOptionalExample acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm
amount_minorintegerRequiredcontent_sha256stringRequiredcreated_atstring · date-timeRequiredcurrencystringRequiredcustomer_idstringRequiredExample cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm
evidence_referencestringRequiredhold_idstringRequiredExample hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm
idstringRequiredissuerstringRequiredjurisdictionstringOptionalkindstringRequiredlegal_entitystringRequiredloan_idstringOptionalExample loan_2tVh8nqLxq4GbDe0K1F6S9zRcWm
payee_referencestringOptionalsourceobjectRequired6 child attributes
closure_componentstringOptionalclosure_ledger_account_idstringOptionalExample lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm
journal_idstringRequiredExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
journal_keystringRequiredjournal_sha256stringRequiredledger_account_idstringRequiredExample lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm
source_datestring · dateRequiredA business date, YYYY-MM-DD
source_date_basisstringOptionalsource_idstringRequiredsource_sha256stringRequiredtax_customer_idstringOptionalExample cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm
tax_periodstringOptionalpaid_minorintegerRequiredrefunded_minorintegerRequiredremittance_idsarray of stringsRequiredreserved_minorintegerRequiredreturned_minorintegerRequiredunallocated_minorintegerRequiredunpaid_minorintegerRequirednext_cursorstringOptionalErrors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503