Direct Integration API icon

Direct Integration API

(0 reviews)

BusinessChannel

Sample Request

{
    "Package": {
        "Content": {
            "Application": {
                "BusinessChannel": {
                    "Contact": {
                        "OfficePhone": {
                            "@CountryCode": "64",
                            "@NewZealandDialingCode": "0800",
                            "@Number": "945658"
                        },
                        "@WebAddress": "www.peppermoney.co.nz",
                        "@x_Address": "ddad34a49d9b"
                    },
                    "@CompanyName": "PEPPER DIRECT NEW ZEALAND",
                    "@NZBN": "9429031065153",
                    "@OtherIdentifier": "CJF1QZ",
                    "@Type": "Bank",
                    "@UniqueID": "ec2c07b1ddb1"
                }
            }
        }
    }
}

Detailed description of each field:
Field NameDescriptionTypePathRequiredEnumerationsNote
BusinessChannelCaptures information about the organisation that the loan application is being submitted to. Typically, the business channel is the lender. For an application being submitted to a mortgage manager, the mortgage manager is the business channelobjectPackage.Content.Application.BusinessChannel
ContactContains contact details for the business channelobjectPackage.Content.Application.BusinessChannel.Contact
OfficePhoneContains a contact phone number for the business channelobjectPackage.Content.Application.BusinessChannel.Contact.OfficePhone
@CountryCodeCaptures the international dialing code for the country in which the fixed phone number is located, e.g. \"61\" for Australia. Maximum length is 3 digitsstringPackage.Content.Application.BusinessChannel.Contact.OfficePhone.CountryCode
@NewZealandDialingCodeThe Area Code prefix for a New Zealand telephone numberstringPackage.Content.Application.BusinessChannel.Contact.OfficePhone.NewZealandDialingCode
@OverseasDialingCodeThe Dialing Code prefix for an overseas phone numberstringPackage.Content.Application.BusinessChannel.Contact.OfficePhone.OverseasDialingCode
@NumberThe 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.stringPackage.Content.Application.BusinessChannel.Contact.OfficePhone.Number
OfficeFaxContains a contact fax number for the business channelobjectPackage.Content.Application.BusinessChannel.Contact.OfficeFax
@CountryCodeCaptures the international dialing code for the country in which the fixed phone number is located, e.g. \"61\" for Australia. Maximum length is 3 digitsstringPackage.Content.Application.BusinessChannel.Contact.OfficeFax.CountryCode
@NewZealandDialingCodeThe Area Code prefix for a New Zealand telephone numberstringPackage.Content.Application.BusinessChannel.Contact.OfficeFax.NewZealandDialingCode
@OverseasDialingCodeThe Dialing Code prefix for an overseas phone numberstringPackage.Content.Application.BusinessChannel.Contact.OfficeFax.OverseasDialingCode
@NumberThe 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.stringPackage.Content.Application.BusinessChannel.Contact.OfficeFax.Number
@EmailCaptures an email address for the distribution channel to which the loan application is being submittedstringPackage.Content.Application.BusinessChannel.Contact.Email
@WebAddressAn internet address for web content associated with the business channelstringPackage.Content.Application.BusinessChannel.Contact.WebAddress
@x_AddressAddress should capture the lender's addressstringPackage.Content.Application.BusinessChannel.Contact.x_Address
@CompanyNameThe company name of the lender or mortgage managerstringPackage.Content.Application.BusinessChannel.CompanyName
@NZBNThe lenders NZBNstringPackage.Content.Application.BusinessChannel.NZBN
@OtherIdentifierCaptures an alternative identifier by which the business channel is known, typically issued by the originating organisation rather than the lenderstringPackage.Content.Application.BusinessChannel.OtherIdentifier
@TypeType of organisation that is the recipient of the application, typically a type of lenderstringPackage.Content.Application.BusinessChannel.TypeYesBank,Building Society,Credit Union,Mortgage Manager,Non Bank Lender
@UniqueIDSystem assigned unique identifierstringPackage.Content.Application.BusinessChannel.UniqueIDYes

Reviews