Direct Integration API icon

Direct Integration API

2.0.x
(0 reviews)

Liabilities

Sample Request

{
    "Package": {
        "Content": {
            "Application": {
                "Liability": [{
                    "AccountNumber": {
                        "@FinancialInstitution": "test"
                    },
                    "Arrears": {
                        "@NumberOfMissedPayments": "test",
                        "@Amount": "test"
                    },
                    "PercentOwned": {
                        "Owner": [
                            {
                                "@Percent": "test",
                                "@x_Party": "c3ef4fcde732"
                            },
                            {
                                "@Percent": 33.3333333333333,
                                "@x_Party": "bbf1b108ae2a"
                            },
                            {
                                "@Percent": 33.3333333333333,
                                "@x_Party": "b2bd44f5ce50"
                            }
                        ],
                        "@Proportions": "Specified"
                    },
                    "RemainingTerm": {
                        "@Duration": "test",
                        "@Units": "test"
                    },
                    "Repayment": {
                        "@RepaymentAmount": "test",
                        "@RepaymentFrequency": "test"
                    },
                    "Security": [{
                        "@x_Security": "b2bd44f5ce50"
                    }],
                    "@ClearingFromThisLoan": "test",
                    "@CreditLimit": "test",
                    "@HasArrears": "test",
                    "@OutstandingBalance": "test",
                    "@RefinanceCosts": "test",
                    "@SequenceNumber": "0",
                    "@Type": "test",
                    "@UniqueID": "fbe0c96499c9"
                }]
            }
        }
    }
}
Detailed description of each field:
Field NameDescriptionTypePathRequiredEnumerationsNote
LiabilityA liability item is a debt owed to a creditor or lender - such as a loan, line of credit, or tax billobjectPackage.Content.Application.Liability
AccountNumberAccount details of the liabilityobjectPackage.Content.Application.Liability.AccountNumber
@AccountNumberThe unique number assigned to this account. (typically by the financial institution)stringPackage.Content.Application.Liability.AccountNumber.AccountNumberYes, if the liability exists (except for when liability type is contingent liability, Car Loan, Student Loan, Commercial Bill, Outstanding Taxation, Margin Loan, Credit card)
@FinancialInstitutionThe financial institution where the account is heldstringPackage.Content.Application.Liability.AccountNumber.FinancialInstitutionYes, if the liability exists (except for when liability type is contingent liability, Car Loan, Student Loan)ANZ Bank, ASB Bank, Bank of Baroda, Bank of China, Bank of India, Bank of New Zealand, Bank of Tokyo-Mitsubishi, Brighten Home Loans, China Construction Bank, Citibank, Citywide Home Loans, Commonwealth Bank, Deutsche Bank, Heartland Bank, International Commercial Bank of China, JPMorgan Chase Bank, Kiwibank, Kookmin Bank, Other, Pepper New Zealand, Rabobank Nederland, Rabobank New Zealand, Southland Building Society, The Co-operative Bank, The Hongkong and Shanghai Banking Corporation, TSB Bank, Westpac Bank
@OtherFINameFor a financial institution not listed, the text name of the FIstringPackage.Content.Application.Liability.AccountNumber.OtherFIName
@ClearingFromThisLoanIndicates whether the existing loan will be cleared, in whole or in part, using funds from the loan being applied forstringPackage.Content.Application.Liability.ClearingFromThisLoanYes if Liability ExistsYes, No, Partial, Prior to Settlement
@CreditLimitCaptures the limit for a credit card or a line of credit, or the scheduled balance for an amortising loan. This is typically the balance that the lender uses to assess the liability as the borrower is likely able to draw funds up to the limit, or to redraw principal repaid ahead of the scheduled balancenumberPackage.Content.Application.Liability.CreditLimitYes, if Liability Exists and Liability Type is Credit Card, Line of Credit, Store Card
@DescriptionCaptures a free text description of the liability when the selected Liability Type = "Other"stringPackage.Content.Application.Liability.Description
@HasArrearsThe applicant or financial system has declared a current arrears credit issue on this liabilitystringPackage.Content.Application.Liability.HasArrearsYes, No
@UniqueIDSystem assigned unique identifierstringPackage.Content.Application.Liability.UniqueIDYes if liabilities exist
@TypeThe type of liability. Types include credit card limits, HECS debt, existing loans, etc.stringPackage.Content.Application.Liability.TypeYes if Liability ExistsCar Loan, Commercial Bill, Contingent Liability, Credit Card, Hire Purchase, Lease, Line of Credit, Line of Credit, Loan as Guarantor, Margin Loan, Other Loan, Outstanding Taxation, Overdraft, Personal Loan, Store Card, Student Loan, Term Loan, Other
ArrearsContainer element for capturing Arrears detailobjectPackage.Content.Application.Liability.Arrears
@NumberOfMissedPaymentsCaptures the number of missed paymentsintegerPackage.Content.Application.Liability.Arrears.NumberOfMissedPayments
@AmountCaptures the amount in arrearsnumberPackage.Content.Application.Liability.Arrears.Amount
PercentOwnedIdentifies the party/s that are responsible for the liability and the amount they are responsible for, either as a borrower or guarantorobjectPackage.Content.Application.Liability.PercentOwned
@ProportionsFlag to indicate whether the ownership proportions are equal across all owners, specified individually for each one, or not specifiedstringPackage.Content.Application.Liability.PercentOwned.ProportionsYes, if Liability ExistsEqual, Specified
OwnerThe details of the ownership of this liability, either as borrower or guarantorobjectPackage.Content.Application.Liability.PercentOwned.Owner
@PercentCaptures the percentage of the liability that the linked party is responsible fornumberPackage.Content.Application.Liability.PercentOwned.Owner.PercentYes, if Liability Exists
@x_PartyA reference to a party that is an responsible for the liabilitystringPackage.Content.Application.Liability.PercentOwned.Owner.x_PartyYes, if Liability Exists
SecurityDetails to identify the security property for the loanobjectPackage.Content.Application.Liability.Security
@x_SecurityContains a reference link to the security (real estate or non real estate asset)stringPackage.Content.Application.Liability.Security.x_Security
@RefinanceCostsBorrowers must state the estimated cost associated with closing a credit facility. For each liability being refinanced the applicants will provide the Estimated Exit and Break Costs payable to the outgoing finance institutionstringPackage.Content.Application.Liability.RefinanceCosts
RemainingTermContainer element for capturing the remaining term of liabilities not being refinancedobjectPackage.Content.Application.Liability.RemainingTerm
@DurationThe duration of the remaining termintegerPackage.Content.Appliction.Liability.RemainingTerm.Duration
@UnitsThe units used to define the duration of the remaining termstringPackage.Content.Application.Liability.RemainingTerm.UnitsMonths, Weeks, Years
RepaymentDetails of the repayment expense associated with this loanobjectPackage.Content.Application.Liability.Repayment
@RepaymentAmountThe repayment expense amount associated with repaying this loannumberPackage.Content.Application.Liability.Repayment.RepaymentAmountYes if Liability Exists
@RepaymentFrequencyThe payment frequency of the repayment associated with this loanstringPackage.Content.Application.Liability.Repayment.RepaymentFrequencyYes if Liability ExistsFortnightly, Half Yearly, Monthly, Quarterly, Weekly, Yearly
@OutstandingBalanceThe payment frequency of the repayment associated with this loannumberPackage.Content.Application.Liability.OutstandingBalanceYes if Liability Exists

Reviews