Direct Integration API icon

Direct Integration API

(0 reviews)

LoanDetails

Sample Request

{
    "Package": {
        "Content": {
            "Application": {
                "LoanDetails": {
                    "FeaturesSelected": {
                        "@Redraw": "No"
                    },
                    "LendingPurpose": {
                        "@PurposeAmount": "185000",
                        "@PurposeOfFunds": "Fix Natural Disaster Affected Home",
                        "@UniqueID": "d8ef1c368f98",
                        "@ABSLendingPurposeCode": "12345"
                    },
                    "LoanPurpose": {
                        "@PrimaryPurpose": "Investment Residential"
                    },
                    "Term": {
                        "InterestOnlyReason": {
                            "@Reason": "Variable income",
                            "@UniqueID": "a55a4e644b73"
                        },
                        "@InterestType": "Fixed Rate",
                        "@InterestTypeDuration": "2",
                        "@InterestTypeUnits": "Years",
                        "@PaymentType": "Interest Only",
                        "@PaymentTypeDuration": "2",
                        "@PaymentTypeUnits": "Years",
                        "@TotalTermDuration": "30",
                        "@TotalTermType": "Total Term",
                        "@TotalTermUnits": "Years"
                    },
                    "@AmountRequested": "185000",
                    "@EstimatedSettlementDate": "2023-11-16",
                    "@LoanType": "Mortgage Loan",
                    "@MainProduct": "Yes",
                    "@OriginatorReferenceID": "PDEADIFI-LD-INO",
                    "@ProductCode": "1090",
                    "@ProductName": "Pepper Direct Easy Alt Doc INV Fixed IO",
                    "@SequenceNumber": "0",
                    "@UniqueID": "efd4795eb61a"
                }
            }
        }
    }
}

Detailed description of each field:
Field NameDescriptionTypePathRequiredEnumerationsNote
LoanDetailsInformation about an individual credit facility that is being applied for including but not limited to: term loans; revolving credit facilities; overdrafts; credit cards; equipment finance; commercial bills; margin loans; personal loans; and reverse mortgagesobjectPackage.Content.Application.LoanDetails
FeaturesSelectedContains information about the product features requested by the applicantobjectPackage.Content.Application.LoanDetails.FeaturesSelected
@RedrawIndicates whether the applicant requests that the loan product permit the redraw of loan principal that has been repaid in advance of the amortisation schedule for the loanstringPackage.Content.Application.LoanDetails.FeaturesSelected.RedrawYes, No
@OffsetIndicates whether the applicant requests that a 100% offset account facility be established for the loan accountstringPackage.Content.Application.Content.Application.LoanDetails.FeaturesSelected.OffsetYes, No
LendingPurposeDetails of the purpose for which the applicant intends to use the loan fundsobjectPackage.Content.Application.LoanDetails.LendingPurpose
@PurposeAmountThe amount of the loan funds that will be used for the specified purposenumberPackage.Content.Application.LoanDetails.LendingPurpose.PurposeAmount
@PurposeOfFundsThe purpose for which the loan funds will be usedstringPackage.Content.Application.LoanDetails.LendingPurpose.PurposeOfFundsDebt Consolidation, EECA Energy Efficiency Funding, Fix Leaky Home, Fix Natural Disaster Affected Home, Holiday/Travel, Other Purpose, Purchase of Dwelling, Purchase Vehicle, Refinance of Liabilities with Current Lender, Refinance of Liabilities with Other Lenders
@RefinancingReasonBorrowers should inform the lender of the reason for refinancing liabilitiesstringPackage.Content.Application.LoanDetails.LendingPurpose.RefinancingReasonConsolidating or Restructuring Finances, Convenience / Flexibility, Dissatisfaction with Service at Current Lender, More Competitive Pricing, Specific Product or Feature
@UniqueIDUnique Identifier for this Lending Purpose ElementstringPackage.Content.Application.LoanDetails.LendingPurpose.UniqueID
@ABSLendingPurposeCodeCaptures the free text description of the ABS Lending Purpose CodestringPackage.Content.Application.LoanDetails.LendingPurpose.ABSLendingPurposeCode
ProposedRepaymentContains information that specifies how the borrower(s) intend to make regular or structured repaymentsobjectPackage.Content.Application.LoanDetails.ProposedRepayment
@MethodThe payment method that will be used to effect the transfer of repayments on the loan to the lender. Examples include salary sacrifice, direct debit and BPAYstringPackage.Content.Application.LoanDetails.ProposedRepayment.MethodDirect Debit Existing Account
RegularRepaymentContainer element for information associated with regular repaymentsobjectPackage.Content.Application.LoanDetails.ProposedRepayment.RegularRepayment
@AmountPreferred or nominated total regular repayment amount (incorporating any GST or Stamp Duty in the case of Equipment Finance Transactions)numberPackage.Content.Application.LoanDetailsProposedRepayment.RegularRepayment.Amount
@FrequencyCaptures the applicants' preferred period for making loan repayments for the loan account. Captured when the loan product selected offers a range of repayment periods, enabling the applicant to nominate a period which best suits their needs in terms of income and the desire to reduce interest over the life of the loan by accelerating the reduction of the principal balancestringPackage.Content.Application.LoanDetails.ProposedRepayment.RegularRepayment.FrequencyWeekly, Fortnightly, Monthly
LoanPurposeContains information about the main purpose for which the applicant intends to use the loan fundsobjectPackage.Content.Application.LoanDetails.LoanPurpose
@PrimaryPurposeCaptures the primary purpose for which the loan funds will be used by the applicant. Categories reflect the categories used in classifying a loan as regulated or unregulated under the NCCPstringPackage.Content.Application.LoanDetails.LoanPurpose.PrimaryPurposeInvestment Non Residential, Investment Residential, Owner Occupied
TermDetails of the total term of the credit product and any introductory terms, such as an interest only term (including interest only reasons) or a fixed rate term that applies for an initial period at the start of the productobjectPackage.Content.Application.LoanDetails.Term
InterestOnlyReasonThe applicants' reasons for applying for an interest-only term within this loanobjectPackage.Content.Application.LoanDetails.Term.InterestOnlyReason
@DescriptionA free-text description provided by the applicant/s that provides further detail regarding this reason for applying for an interest-only term within this loanstringPackage.Content.Application.LoanDetails.Term.InterestOnlyReason.Description
@ReasonThe reason that the applicant is applying for an interest-only term within this loanstringPackage.Content.Application.LoanDetails.Term.InterestOnlyReason.ReasonCreate funds for investment purposes, Large non-recurring expenses, Maximise cash flow, Other reason, Plan to convert to investment property, Principal reductions in an offset facility, "Taxation, financial or accounting reasons", Temporary reduction in income, Variable income
@UniqueIDUnique Identifier for this interest-only reasonstringPackage.Content.Application.LoanDetails.Term.InterestOnlyReason.UniqueID
@InterestTypeCaptures the type of interest that is to be paid during the specified termstringPackage.Content.Application.LoanDetails.Term.InterestTypeYesFixed Rate, Variable
@InterestTypeDurationThe duration of the fixed interest rate period, as a whole number multiple of the UnitsintegerPackage.Content.Application.LoanDetails.Term.InterestTypeDurationYesMandatory if Interest Type is Fixed Rate OR Payment Type is Interest Only and Interest Type is Fixed Rate
@InterestTypeUnitsThe units of time that are used to define the duration of the fixed interest rate periodstringPackage.Content.Application.LoanDetails.Term.InterestTypeUnitsYes, mandatory if Payment Type is Interest Only and Interest Type is Fixed RateDays, Months, Weeks, Years
@PaymentTypeCaptures the type of repayment that is to be made during the specified termstringPackage.Content.Application.LoanDetails.Term.PaymentTypeYesPrincipal and Interest, Interest Only
@PaymentTypeDurationThe duration of the interest only period, as a whole number multiple of the UnitsintegerPackage.Content.Application.LoanDetails.Term.PaymentTypeDuration
@PaymentTypeUnitsThe units of time that are used to define the duration of the interest only periodstringPackage.Content.Application.LoanDetails.Term.PaymentTypeUnitsYesYearsMandatory if Payment Type is Interest Only, and Interest Type is Fixed Rate
@TotalTermDurationThe Duration of the specified loan term, as a multiple of the UnitsintegerPackage.Content.Application.LoanDetails.Term.TotalTermDurationYes
@TotalTermTypeThe type of loan term should indicate that the loan term is either the total length of the term or the amortised term as required by the lenderstringPackage.Content.Application.LoanDetails.Term.TotalTermType
@TotalTermUnitsCaptures the period described by the number specified for termstringPackage.Content.Application.LoanDetails.Term.TotalTermUnitsYesYears
@AmountRequestedCaptures the loan amount as requested by the applicant for this loan account, exclusive of to-be-capitalised fees and/or LMIstringPackage.Content.Application.LoanDetails.AmountRequestedYes
@EstimatedSettlementDateCaptures the date that the applicant estimates that the application will settlestringPackage.Content.Application.LoanDetails.EstimatedSettlementDateYes
@LoanTypeThe type of credit facilitystringPackage.Content.Application.LoanDetails.LoanTypeYesMortgage Loan
@MainProductWhere a lender requires that the applicant nominate one loan account/product as being the primary or main account within a package or portfolio or accounts, indicates whether this is the main accountstringPackage.Content.Application.LoanDetails.MainProductYesYes, No
@OriginatorReferenceIDUnique identifier assigned to the loan detail by the originator systemstringPackage.Content.Application.LoanDetails.OriginatorReferenceID
@ProductCodeCaptures an identifying code for the loan product applied for. This code is typically issued by the lender and enables the lender's systems to uniquely identify the productstringPackage.Content.Application.LoanDetails.ProductCode
@ProductNameCaptures the name of the loan product applied forstringPackage.Content.Application.LoanDetails.ProductName
@ProposedAnnualInterestRateThe interest rate that applies to the loan account. Typically expressed as an annual interest ratenumberPackage.Content.Application.LoanDetails.ProposedAnnualInterestRate
@SequenceNumberThe order of this loan details within the sequencestringPackage.Content.Application.LoanDetails.SequenceNumber
@UniqueIDSystem assigned unique identifierstringPackage.Content.Application.LoanDetails.UniqueIDYes

Reviews