Developer guide
The objects behind a financial workflow.
Connect the borrower, credit evidence, facility terms and payment events. This guide describes the proposed lending data model; it does not define production endpoints.
Map your workflow to a domain.
- Borrowers and permissions
Identify the business, its authorised representatives and which parties can access or act on each record.
- Evidence and credit decisions
Link source documents and their versions to the review, decision and accepted terms.
- Facilities and funding
Represent the facility, capital source, funding asset, recipient currency and settlement instructions. Link provider confirmations to the original instruction.
- Repayments and servicing
Distinguish scheduled payments, incoming receipts, reconciled repayments, exceptions and recoveries.
A request needs a recorded outcome.
Accepting a request does not mean the financial operation has completed. Use the API contract's object identifiers, explicit states and error definitions to track the result.
- Before a write
- Check the required permissions, validation rules and idempotency contract.
- After acceptance
- Keep the operation identifier and distinguish processing from final success or failure.
- When retrying
- Follow the documented retry rules so a repeated request does not repeat the financial operation.