Skip to content

Corgi BankDocumentation

OpenAPI

The Payable Obligation object

Registered payable source and actual reserved, paid, returned and unpaid allocations.

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

The Payable Obligation object

{
  "blockers": [
    "string"
  ],
  "cash_ready": false,
  "obligation": {
    "account_id": "acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
    "amount_minor": 0,
    "content_sha256": "string",
    "created_at": "2026-09-17T14:30:00Z",
    "currency": "USD",
    "customer_id": "cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
    "evidence_reference": "string",
    "hold_id": "hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
    "id": "string",
    "issuer": "string",
    "jurisdiction": "string",
    "kind": "string",
    "legal_entity": "string",
    "loan_id": "loan_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
    "payee_reference": "string",
    "source": {
      "closure_component": "string",
      "closure_ledger_account_id": "lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
      "journal_id": "jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
      "journal_key": "string",
      "journal_sha256": "string",
      "ledger_account_id": "lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm"
    },
    "source_date": "2026-09-17",
    "source_date_basis": "string",
    "source_id": "string",
    "source_sha256": "string",
    "tax_customer_id": "cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
    "tax_period": "string"
  },
  "paid_minor": 0,
  "refunded_minor": 0,
  "remittance_ids": [
    "string"
  ],
  "reserved_minor": 0,
  "returned_minor": 0,
  "unallocated_minor": 0,
  "unpaid_minor": 0
}