Loan Creation Guide

This guide outlines the end-to-end API process for creating a loan in Biz Core. It details each step in sequence, showing data dependencies and the logical flow between API calls.

---

Workflow Overview

The loan creation flow comprises six stages — four mandatory and two optional. Each step describes the relevant API endpoints, their purpose, and the expected outputs.

---

Authentication

The Lending Module uses HAWK authentication — see Getting Started for implementation details, API key generation, and library recommendations.

---

Step 1 — Retrieve Reference Data

Biz Core offers a suite of auxiliary endpoints that return enumerated values (countries, states, vehicle types, loan products, etc.) required to build customer intake forms and validate loan parameters.

For the complete catalogue of resource endpoints, caching guidance, and refresh strategy, see Reference Data Endpoints.

For loan creation specifically, the following reference data is most relevant:

• Countries and States — for address validation.
• Loan Products and Risk Categories — to determine valid loan terms, limits, and fees.
• Vehicle Types and Property Types — for assets attached in Step 6.
• Transaction Source Types and PayID Types — for payment configuration in Steps 3 and 4.
• Loan Reasons — for the loan purpose.

Output

Reference data cached locally for use in later steps, particularly customer and loan creation.

---

Step 2 — Customer Details

This step gathers or verifies all customer information required to proceed with loan creation.

Workflow

1. Customer matching — Determine if the customer already exists in your system using identifiers such as email, name, or phone number.
2. If existing customer:
   • Call Get Customer Outstanding Refinances and store the result as OutstandingRefinances.
   • Retain the existing CustomerId for later use.
3. If new customer:
   • Call Create Individual Customer and store the returned CustomerId.

Output

• CustomerId
• OutstandingRefinances (if applicable)

---

Step 3 — Create Direct Debit Transaction Source

This step defines how loan repayments will be collected via Direct Debit.

Workflow

1. For existing customers, retrieve linked transaction sources using Get Customer Transaction Sources.
2. Either:
   • Reuse an existing bank account transaction source, or
   • Call Create AU Bank Transaction Source to create a new one.
3. Store the returned TransactionSourceId. This source will be used for Direct Debit repayments. Also store the same value as DisbursementMethodSourceId — by default, loan funds disburse to the same account used for repayments.

Output

• TransactionSourceId
• DisbursementMethodSourceId

---

Step 4 — Set PayID as Disbursement Method (optional)

If loan funds will be disbursed via PayID rather than to the customer's bank account, create a PayID transaction source for the customer.

Workflow

1. (Recommended) Validate the customer-provided PayID using Validate PayID.
2. Call Create PayID Transaction Source.
3. Override DisbursementMethodSourceId with the returned PayID TransactionSourceId.

Output

• DisbursementMethodSourceId (PayID source)

PayID test data (UAT only)

---

Step 5 — Create Loan

Once customer and transaction source data are ready, the loan can be created.

Workflow

1. Assemble the request using values from previous steps:
   • CustomerId
   • LoanProductId
   • DisbursementMethodSourceId
   • TransactionSourceId (for Direct Debit)
   • Loan parameters: amount, term, start date, frequency, etc.
2. Set loanProvider to your organisation name. This distinguishes loans originated via your integration from those originated within Biz Core, for reporting purposes.
3. Call Create Loan.

Output

• LoanId — unique identifier for the newly created loan.

---

Step 6 — Provide Additional Loan Data (optional)

Attach assessment, credit decision data, or asset records to the created loan for traceability.

Workflow

Output

• Assessment data and assets linked to the loan record.

---

Summary

---

Error Handling

Refer to the Getting Started — Error Handling section for the standard response codes returned by all Lending Module endpoints.