Direct Integration API

(0 reviews)

SalesChannel

Sample Request

{
    "Package": {
        "Content": {
            "Application": {
                "SalesChannel": {
                    "Company": {
                        "Contact": {
                            "OfficePhone": {
                                "@CountryCode": "64",
                                "@NewZealandDialingCode": "0800",
                                "@Number": "945658"
                            },
                            "@WebAddress": "www.peppermoney.co.nz",
                            "@x_Address": "d66ff9a1e37f"
                        },
                        "@CompanyName": "PEPPER DIRECT NEW ZEALAND",
                        "@NZBN": "9429031065153",
                        "@OtherIdentifier": "CJF1QZ"
                    },
                    "LoanWriter": {
                        "Contact": {
                            "Mobile": {
                                "@CountryCode": "64",
                                "@NewZealandDialingCode": "020",
                                "@Number": "123456"
                            },
                            "@Email": "bkumar_nzdirect@pepper.com.au"
                        },
                        "@AccreditationNumber": "051248012",
                        "@FirstName": "Balaji",
                        "@NameTitle": "Mr",
                        "@OtherIdentifier": "UQDA87",
                        "@Surname": "Kumar",
                        "@UniqueID": "c2080badb441"
                    },
                    "Aggregator": {
                        "@AccreditationNumber": "49541"
                    }
                }
            }
        }
    }
}

Detailed description of each field:

Field Name	Description	Type	Path	Required	Enumerations
SalesChannel	Captures information about the sales channel through which the product is sold to the applicant	object	Package.Content.Application.SalesChannel
Company	The company or bank branch that the loan writer works at	object	Package.Content.Application.SalesChannel.Company
Contact	Container element for contact details of the Sales Channel Company	object	Package.Content.Application.SalesChannel.Company.Contact
OfficePhone	Contains a contact phone number for the business channel	object	Package.Content.Application.SalesChannel.Company.Contact.OfficePhone
@CountryCode	Captures the international dialing code for the country in which the fixed phone number is located, e.g. \"61\" for Australia. Maximum length is 3 digits	string	Package.Content.Application.SalesChannel.Company.Contact.OfficePhone.CountryCode		64
@NewZealandDialingCode	The Area Code prefix for a New Zealand telephone number	string	Package.Content.Application.SalesChannel.Company.Contact.OfficePhone.NewZealandDialingCode
@OverseasDialingCode	The Dialing Code prefix for an overseas phone number	string	Package.Content.Application.SalesChannel.Company.Contact.OfficePhone.OverseasDialingCode
@Number	The local-dial number. For local rate, free call, satellite or similar special non-overseas numbers where the area or dialing code is not otherwise available, the full phone number. Required, allowed once only.	string	Package.Content.Application.SalesChannel.Company.Contact.OfficePhone.Number
OfficeFax	Contains a contact fax number for the business channel	object	Package.Content.Application.SalesChannel.Company.Contact.OfficeFax
@CountryCode	Captures the international dialing code for the country in which the fixed phone number is located, e.g. \"61\" for Australia. Maximum length is 3 digits	string	Package.Content.Application.SalesChannel.Company.Contact.OfficeFax.CountryCode
@NewZealandDialingCode	The Area Code prefix for a New Zealand telephone number	string	Package.Content.Application.SalesChannel.Company.Contact.OfficeFax.NewZealandDialingCode
@OverseasDialingCode	The Dialing Code prefix for an overseas phone number	string	Package.Content.Application.SalesChannel.Company.Contact.OfficeFax.OverseasDialingCode
@Number	The local-dial number. For local rate, free call, satellite or similar special non-overseas numbers where the area or dialing code is not otherwise available, the full phone number. Required, allowed once only.	string	Package.Content.Application.SalesChannel.Company.Contact.OfficeFax.Number
@Email	Captures an email address for the distribution channel to which the loan application is being submitted	string	Package.Content.Application.SalesChannel.Company.Contact.Email
@WebAddress	An internet address for web content associated with the business channel	string	Package.Content.Application.SalesChannel.Company.Contact.WebAddress
@x_Address	Address should capture the lender's address	string	Package.Content.Application.SalesChannel.Company.Contact.x_Address
@CompanyName	The name of the broker company or bank branch	string	Package.Content.Application.SalesChannel.Company.CompanyName
@NZBN	The NZBN of the broker company or bank branch	string	Package.Content.Application.SalesChannel.Company.NZBN
@OtherIdentifier	Captures an alternative identifier by which the company is known, typically issued by the originating organization rather than the lender	string	Package.Content.Application.SalesChannel.Company.OtherIdentifier
LoanWriter	The loan writer details	object	Package.Content.Application.SalesChannel.LoanWriter
Contact	Contains contact details for the Sales Channel Loan Writer	object	Package.Content.Application.SalesChannel.LoanWriter.Contact
Mobile	Contains a mobile number for the loan writer	object	Package.Content.Application.SalesChannel.LoanWriter.Contact.Mobile
@CountryCode	Captures the international dialing code for the country in which the fixed phone number is located, e.g. \"61\" for Australia. Maximum length is 3 digits	string	Package.Content.Application.SalesChannel.LoanWriter.Contact.Mobile.CountryCode		64
@NewZealandDialingCode	The Area Code prefix for a New Zealand telephone number	string	Package.Content.Application.SalesChannel.LoanWriter.Contact.Mobile.NewZealandDialingCode
@OverseasDialingCode	The Dialing Code prefix for an overseas phone number	string	Package.Content.Application.SalesChannel.LoanWriter.Contact.Mobile.OverseasDialingCode
@Number	The local-dial number. For local rate, free call, satellite or similar special non-overseas numbers where the area or dialing code is not otherwise available, the full phone number. Required, allowed once only.	string	Package.Content.Application.SalesChannel.LoanWriter.Contact.Mobile.Number
OfficePhone	Contains a contact phone number for the loan writer	object	Package.Content.Application.SalesChannel.LoanWriter.Contact.OfficePhone
@CountryCode	Captures the international dialing code for the country in which the fixed phone number is located, e.g. \"61\" for Australia. Maximum length is 3 digits	string	Package.Content.Application.SalesChannel.LoanWriter.Contact.OfficePhone.CountryCode		64
@NewZealandDialingCode	The Area Code prefix for a New Zealand telephone number	string	Package.Content.Application.SalesChannel.LoanWriter.Contact.OfficePhone.NewZealandDialingCode
@OverseasDialingCode	The Dialing Code prefix for an overseas phone number	string	Package.Content.Application.SalesChannel.LoanWriter.Contact.OfficePhone.OverseasDialingCode
@Number	The local-dial number. For local rate, free call, satellite or similar special non-overseas numbers where the area or dialing code is not otherwise available, the full phone number. Required, allowed once only.	string	Package.Content.Application.SalesChannel.LoanWriter.Contact.OfficePhone.Number
@Email	An email address should be captured for the broker or lender staff submitting the home loan application	string	Package.Content.Application.SalesChannel.LoanWriter.Contact.Email
@AccreditationNumber	Captures a number such as the accreditation number for the loan writer that has been assigned by the lender	string	Package.Content.Application.SalesChannel.LoanWriter.AccreditationNumber	Yes
@FirstName	A person's first name	string	Package.Content.Application.SalesChannel.LoanWriter.FirstName
@NameTitle	The name title this person uses when they are formally addressed	string	Package.Content.Application.SalesChannel.LoanWriter.NameTitle
@OtherIdentifier	Captures an alternative identifier by which the loan writer is known, typically issued by the originating organisation rather than the lender	string	Package.Content.Application.SalesChannel.LoanWriter.OtherIdentifier
@Surname	A person's surname	string	Package.Content.Application.SalesChannel.LoanWriter.Surname
@UniqueID	Unique ID	string	Package.Content.Application.SalesChannel.LoanWriter.UniqueID	Yes
Aggregator	The company that the loan writer aggregates under	object	Package.Content.Application.SalesChannel.Aggregator
@AccreditationNumber	Captures a number such as the accreditation number for the aggregator that has been assigned by the lender	string	Package.Content.Application.SalesChannel.Aggregator.AccreditationNumber	Yes
@CompanyName	Captures the legal name of the aggregator	string	Package.Content.Application.SalesChannel.Aggregator.CompanyName
@NZBN	The NZBN of the aggregator	string	Package.Content.Application.SalesChannel.Aggregator.NZBN
@OtherIdentifier	Captures an alternative identifier by which the aggregator is known, typically issued by the originating organisation rather than the lender	string	Package.Content.Application.SalesChannel.Aggregator.OtherIdentifier
Contact	Container element for Aggregator Contact information	object	Package.Content.Application.SalesChannel.Aggregator.Contact
OfficeFax	Contains a contact fax number for the aggregator	object	Package.Content.Application.SalesChannel.Aggregator.Contact.OfficeFax
@CountryCode	Captures the international dialing code for the country in which the fixed phone number is located, e.g. \"61\" for Australia. Maximum length is 3 digits	string	Package.Content.Application.SalesChannel.Aggregator.Contact.OfficeFax.CountryCode		64
@NewZealandDialingCode	The Area Code prefix for a New Zealand telephone number	string	Package.Content.Application.SalesChannel.Aggregator.Contact.OfficeFax.NewZealandDialingCode
@OverseasDialingCode	The Dialing Code prefix for an overseas phone number	string	Package.Content.Application.SalesChannel.Aggregator.Contact.OfficeFax.OverseasDialingCode
OfficePhone	Contains a contact phone number for the aggregator	object	Package.Content.Application.SalesChannel.Aggregator.Contact.OfficePhone
@Number	The local-dial number. For local rate, free call, satellite or similar special non-overseas numbers where the area or dialing code is not otherwise available, the full phone number. Required, allowed once only.	string	Package.Content.Application.SalesChannel.Aggregator.Contact.OfficePhone.Number
@CountryCode	Captures the international dialing code for the country in which the fixed phone number is located, e.g. \"61\" for Australia. Maximum length is 3 digits	string	Package.Content.Application.SalesChannel.Aggregator.Contact.OfficePhone.CountryCode		64
@NewZealandDialingCode	The Area Code prefix for a New Zealand telephone number	string	Package.Content.Application.SalesChannel.Aggregator.Contact.OfficePhone.NewZealandDialingCode
@OverseasDialingCode	The Dialing Code prefix for an overseas phone number	string	Package.Content.Application.SalesChannel.LoanWriter.Contact.OfficePhone.OverseasDialingCode
@Number	The local-dial number. For local rate, free call, satellite or similar special non-overseas numbers where the area or dialing code is not otherwise available, the full phone number. Required, allowed once only.	string	Package.Content.Application.SalesChannel.Aggregator.Contact.OfficePhone.Number
@Email	Captures an email address for the sales aggregator submitting the loan application	string	Package.Content.Application.SalesChannel.Aggregator.Contact.Email
@WebAddress	An internet address for web content associated with the aggregator	string	Package.Content.Application.SalesChannel.Aggregator.Contact.WebAddress
@x_Address	Address details for the aggregator at the time of the application submission	string	Package.Content.Application.SalesChannel.Aggregator.Contact.x_Address

SalesChannel

Sample Request

Detailed description of each field:

Reviews