MBOnlineCreditApplicationService

<back to all web services

CreateOCAv2Request

The following routes are available for this service:
PUT/CreateOCAv2/
import java.math.*
import java.util.*
import net.servicestack.client.*


@DataContract
open class CreateOCAv2Request
{
    @DataMember
    var Username:String? = null

    @DataMember
    var Timestamp:String? = null

    @DataMember
    var Token:String? = null

    @DataMember
    var GeneralDetails:GeneralDetailsv2? = null

    @DataMember
    var FinanceDetails:FinanceDetailsv2? = null

    @DataMember
    var VehicleDetails:VehicleDetailsv2? = null

    @DataMember
    var DeliveryDetails:DeliveryDetailsv2? = null

    @DataMember
    var ExistingVehicleDetails:ExistingVehicleDetailsv2? = null

    @DataMember
    var InsuranceDetails:InsuranceDetails? = null

    @DataMember
    var CreditApplicationIndividual:CreditApplicationIndividualV2? = null

    @DataMember
    var CreditApplicationBusiness:CreditApplicationBusinessV2? = null

    @DataMember
    var PaymentDetails:PaymentDetails? = null

    @DataMember
    var Notes:ArrayList<NoteDetails>? = null

    @DataMember
    var DiPDetails:DiPDetails? = null
}

open class GeneralDetailsv2
{
    var OCAApprovalNumber:String? = null
    var EnquiryDateTime:String? = null
    var Brand:Int? = null
    var CustomerReferenceNumber:String? = null
    var CustomerType:String? = null
    var SourceofBusiness:String? = null
    var TagURL:String? = null
    var RequestSource:Int? = null
    var FormID:String? = null
    var ProposalCreated:String? = null
    var LoadFullData:String? = null
    var ProposalNumber:String? = null
    var POSSystem:String? = null
}

open class FinanceDetailsv2
{
    var FinancialProduct:String? = null
    var CampaignCode:String? = null
    var PhoenixFinanceProductCode:String? = null
    var Fixed:String? = null
    var FleetNonFleet:String? = null
    var RFLCover:String? = null
    var Duration:Int? = null
    var PaymentRentalAmount:BigDecimal? = null
    var RentalAmountExcVAT:BigDecimal? = null
    var AdvanceArrears:String? = null
    var AnnualMileage:Int? = null
    var ExcessMileageRate:BigDecimal? = null
    var CustomerDepositContribution:BigDecimal? = null
    var RetailerDepositContribution:BigDecimal? = null
    var RetailerDepositContributionNet:BigDecimal? = null
    var ManufacturerDepositContribution:BigDecimal? = null
    var ManufacturerDepositContributionNet:BigDecimal? = null
    var TotalDepositContribution:BigDecimal? = null
    var LumpSum:BigDecimal? = null
    var CostForCredit:BigDecimal? = null
    var PurchaseActivationFee:BigDecimal? = null
    var TotalAmountPayable:BigDecimal? = null
    var FixedInterestRate:BigDecimal? = null
    var RepresentativeAPR:BigDecimal? = null
    var TrueFlatRate:String? = null
    var RVReferenceNumber:String? = null
    var OptionalPurchasePayment:BigDecimal? = null
    var AdvancedRentalAmount:BigDecimal? = null
    var NumberofAdvanceRentals:String? = null
    var PaymentProfile:String? = null
    var RandMIncluded:String? = null
    var RandMLevel:String? = null
    var ProductType:String? = null
    var Frequency:String? = null
    var PauseType:String? = null
    var EqualsFinance:BigDecimal? = null
    var AcceptanceFee:BigDecimal? = null
}

open class VehicleDetailsv2
{
    var OnlineCode:String? = null
    var ModelClass:String? = null
    var ModelBody:String? = null
    var ModelDerivative:String? = null
    var TotalPrice:BigDecimal? = null
    var OTRPrice:BigDecimal? = null
    var VIN:String? = null
    var RegNo:String? = null
    var CommissionNumber:String? = null
    var EngineNumber:String? = null
    var CurrentMileage:Int? = null
    var MilesKilometers:String? = null
    var FirstRegistrationDate:String? = null
    var NewUsedFlag:String? = null
    var NewVehicleModelOptionDetails:ArrayList<ModelOptionDetailsv2>? = null
    var VID:String? = null
    var Baumuster:String? = null
    var VehiclePrice:BigDecimal? = null
    var TotalVAT:BigDecimal? = null
    var OLEVGrant:BigDecimal? = null
    var ExtrasTotalExcVAT:BigDecimal? = null
    var CombinedCO2:String? = null
    var VehicleVATTickBox:String? = null
    var FirstYearRFLIncluded:String? = null
    var FirstYearRFLAmount:BigDecimal? = null
    var FirstRegFeeIncludedFlag:String? = null
    var FirstRegFeeAmount:BigDecimal? = null
    var HighLowVEDSupplementFlag:String? = null
    var LeaseRFLSubsequentYears:String? = null
    var LeaseRFLSubsequentYearsAmount:BigDecimal? = null
}

open class ModelOptionDetailsv2
{
    var Seq:Int? = null
    var Type:String? = null
    var Code:String? = null
    var Description:String? = null
    var Price:BigDecimal? = null
    var PriceGross:BigDecimal? = null
    var VATCategory:String? = null
    var VATAmount:BigDecimal? = null
}

open class DeliveryDetailsv2
{
    var DealerCode:String? = null
    var DeliveryPreference:String? = null
    var DeliveryDate:String? = null
}

open class ExistingVehicleDetailsv2
{
    var TradeInFlag:String? = null
    var TradeInIncludedInCalc:String? = null
    var TradeInValue:BigDecimal? = null
    var TradeInValueNet:BigDecimal? = null
    var TradeInRegNo:String? = null
    var TradeInVIN:String? = null
    var TradeInMileage:Int? = null
    var TradeInCondition:String? = null
    var SettlementFlag:String? = null
    var SettlementIncludedInCalc:String? = null
    var SettlementValue:BigDecimal? = null
    var SettlementValueNet:BigDecimal? = null
    var SettlementRegNo:String? = null
    var SettlementVIN:String? = null
    var SettlementMileage:Int? = null
}

open class InsuranceDetails
{
    var InterestedInFirstCoverFlag:String? = null
}

open class CreditApplicationIndividualV2
{
    var Title:String? = null
    var Initial:String? = null
    var FirstName:String? = null
    var Surname:String? = null
    var DateofBirth:String? = null
    var Gender:String? = null
    var MaritalStatus:String? = null
    var ResidentialStatus:String? = null
    var CurrentAddress:AddressWithTimeLinev2? = null
    var PreviousAddresses:ArrayList<PreviousAddressv2>? = null
    var HomePhone:String? = null
    var MobilePhone:String? = null
    var WorkPhone:String? = null
    var ContactAtWork:String? = null
    var Email:String? = null
    var BankSortCode:String? = null
    var BankAccountNumber:String? = null
    var BankAccountName:String? = null
    var BankName:String? = null
    var BankAddress:Address? = null
    var BankPaymentType:String? = null
    var DrivingLicenceNumber:String? = null
    var CurrentEmploymentDetails:CurrentEmploymentDetailsv2? = null
    var PreviousEmploymentDetails:ArrayList<PreviousEmploymentv2>? = null
    var MarketingPreference:MarketingPreference? = null
    var CreditCheckConsent:String? = null
}

open class AddressWithTimeLinev2
{
    var AddressLine1:String? = null
    var AddressLine2:String? = null
    var AddressLine3:String? = null
    var Town:String? = null
    var County:String? = null
    var Country:String? = null
    var Postcode:String? = null
    var Duration:String? = null
    var DateStarted:String? = null
    var TotalNumberOfMonths:String? = null
}

open class PreviousAddressv2
{
    var Seq:Int? = null
    var Address:AddressWithTimeLinev2? = null
}

open class Address
{
    var AddressLine1:String? = null
    var AddressLine2:String? = null
    var AddressLine3:String? = null
    var AddressLine4:String? = null
    var AddressLine5:String? = null
    var Postcode:String? = null
}

open class CurrentEmploymentDetailsv2
{
    var EmployerDetails:EmployerDetailsv2? = null
    var MonthsAtEmployer:String? = null
    var DateEmploymentCommenced:String? = null
    var AnnualIncome:String? = null
}

open class EmployerDetailsv2
{
    var EmploymentType:String? = null
    var EmployersName:String? = null
    var Occupation:String? = null
    var EmployersAddress:AddressWithTimeLinev2? = null
}

open class PreviousEmploymentv2
{
    var Seq:Int? = null
    var previousEmployment:EmployerDetailsv2? = null
}

open class MarketingPreference
{
    var OptInMail:String? = null
    var OptInTelephone:String? = null
    var OptInEmail:String? = null
    var OptInSMS:String? = null
}

open class CreditApplicationBusinessV2
{
    var TypeOfBusiness:String? = null
    var BusinessContactPosition:String? = null
    var Title:String? = null
    var Initial:String? = null
    var FirstName:String? = null
    var Surname:String? = null
    var CurrentHomeAddress:AddressWithTimeLinev2? = null
    var HomePhone:String? = null
    var WorkPhone:String? = null
    var MobilePhone:String? = null
    var Email:String? = null
    var CompanyName:String? = null
    var CompanyRegistrationNumber:String? = null
    var TradingAs:String? = null
    var BusinessActivity:String? = null
    var NumberOfEmployees:Int? = null
    var YearsTrading:Int? = null
    var Position:String? = null
    var BankSortCode:String? = null
    var BankAccountNumber:String? = null
    var BankAccountName:String? = null
    var BankName:String? = null
    var BankAddress:Address? = null
    var NumberofPartners:Int? = null
    var BusinessPartners:ArrayList<BusinessPartnerv2>? = null
    var MarketingPreference:MarketingPreference? = null
    var PreviousAddresses:ArrayList<PreviousAddressv2>? = null
}

open class BusinessPartnerv2
{
    var Seq:Int? = null
    var Title:String? = null
    var Initial:String? = null
    var FirstName:String? = null
    var Surname:String? = null
    var DateofBirth:String? = null
    var Gender:String? = null
    var MaritalStatus:String? = null
    var ResidentialStatus:String? = null
    var CurrentAddress:AddressWithTimeLinev2? = null
    var PreviousAddresses:ArrayList<PreviousAddressv2>? = null
    var HomePhone:String? = null
    var MobilePhone:String? = null
    var BusinessPhone:String? = null
    var Relationship:String? = null
    var Email:String? = null
    var CurrentEmploymentDetails:CurrentEmploymentDetailsv2? = null
    var PreviousEmploymentDetails:ArrayList<PreviousEmploymentv2>? = null
    var PartnerType:String? = null
}

open class PaymentDetails
{
    var paymentDetails:ArrayList<PaymentDetail>? = null
}

open class PaymentDetail
{
    var Seq:Int? = null
    var PaymentType:String? = null
    var AmountPaid:BigDecimal? = null
    var PaymentTransactionID:String? = null
    var Description:String? = null
    var PaymentDateTime:String? = null
}

open class NoteDetails
{
    var Seq:Int? = null
    var Note:String? = null
}

open class DiPDetails
{
    var DiPCustomerId:String? = null
    var DiPTimestamp:String? = null
    var DiPRequestID:String? = null
    var DiPDecisionType:String? = null
    var DiPPrimaryDecisionCode:String? = null
    var DiPDecisionDescription:String? = null
    var DipDecisionDescriptionCode:String? = null
    var DipPrimaryDecisionReason:String? = null
    var DiPPrimaryDecisionReasonDealerMessage:String? = null
    var diPReasons:ArrayList<DiPReasons>? = null
}

open class DiPReasons
{
    var DipReasonSeq:Int? = null
    var DipDecisionCode:String? = null
    var DiPDecisionReason:String? = null
    var DiPDealerMessage:String? = null
}

@DataContract
open class CreateOCAv2RequestResponse
{
    @DataMember
    var Code:String? = null

    @DataMember
    var Message:String? = null

    @DataMember
    var URN:Int? = null
}

Kotlin CreateOCAv2Request DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /CreateOCAv2/ HTTP/1.1 
Host: webservices.mbukdatabase.co.uk 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Username":"String","Timestamp":"String","Token":"String","GeneralDetails":{"OCAApprovalNumber":"String","EnquiryDateTime":"String","Brand":0,"CustomerReferenceNumber":"String","CustomerType":"String","SourceofBusiness":"String","TagURL":"String","RequestSource":0,"FormID":"String","ProposalCreated":"String","LoadFullData":"String","ProposalNumber":"String","POSSystem":"String"},"FinanceDetails":{"FinancialProduct":"String","CampaignCode":"String","PhoenixFinanceProductCode":"String","Fixed":"String","FleetNonFleet":"String","RFLCover":"String","Duration":0,"PaymentRentalAmount":0,"RentalAmountExcVAT":0,"AdvanceArrears":"String","AnnualMileage":0,"ExcessMileageRate":0,"CustomerDepositContribution":0,"RetailerDepositContribution":0,"RetailerDepositContributionNet":0,"ManufacturerDepositContribution":0,"ManufacturerDepositContributionNet":0,"TotalDepositContribution":0,"LumpSum":0,"CostForCredit":0,"PurchaseActivationFee":0,"TotalAmountPayable":0,"FixedInterestRate":0,"RepresentativeAPR":0,"TrueFlatRate":"String","RVReferenceNumber":"String","OptionalPurchasePayment":0,"AdvancedRentalAmount":0,"NumberofAdvanceRentals":"String","PaymentProfile":"String","RandMIncluded":"String","RandMLevel":"String","ProductType":"String","Frequency":"String","PauseType":"String","EqualsFinance":0,"AcceptanceFee":0},"VehicleDetails":{"OnlineCode":"String","ModelClass":"String","ModelBody":"String","ModelDerivative":"String","TotalPrice":0,"OTRPrice":0,"VIN":"String","RegNo":"String","CommissionNumber":"String","EngineNumber":"String","CurrentMileage":0,"MilesKilometers":"String","FirstRegistrationDate":"String","NewUsedFlag":"String","NewVehicleModelOptionDetails":[{"Seq":0,"Type":"String","Code":"String","Description":"String","Price":0,"PriceGross":0,"VATCategory":"String","VATAmount":0}],"VID":"String","Baumuster":"String","VehiclePrice":0,"TotalVAT":0,"OLEVGrant":0,"ExtrasTotalExcVAT":0,"CombinedCO2":"String","VehicleVATTickBox":"String","FirstYearRFLIncluded":"String","FirstYearRFLAmount":0,"FirstRegFeeIncludedFlag":"String","FirstRegFeeAmount":0,"HighLowVEDSupplementFlag":"String","LeaseRFLSubsequentYears":"String","LeaseRFLSubsequentYearsAmount":0},"DeliveryDetails":{"DealerCode":"String","DeliveryPreference":"String","DeliveryDate":"String"},"ExistingVehicleDetails":{"TradeInFlag":"String","TradeInIncludedInCalc":"String","TradeInValue":0,"TradeInValueNet":0,"TradeInRegNo":"String","TradeInVIN":"String","TradeInMileage":0,"TradeInCondition":"String","SettlementFlag":"String","SettlementIncludedInCalc":"String","SettlementValue":0,"SettlementValueNet":0,"SettlementRegNo":"String","SettlementVIN":"String","SettlementMileage":0},"InsuranceDetails":{"InterestedInFirstCoverFlag":"String"},"CreditApplicationIndividual":{"Title":"String","Initial":"String","FirstName":"String","Surname":"String","DateofBirth":"String","Gender":"String","MaritalStatus":"String","ResidentialStatus":"String","CurrentAddress":{"AddressLine1":"String","AddressLine2":"String","AddressLine3":"String","Town":"String","County":"String","Country":"String","Postcode":"String","Duration":"String","DateStarted":"String","TotalNumberOfMonths":"String"},"PreviousAddresses":[{"Seq":0,"Address":{"AddressLine1":"String","AddressLine2":"String","AddressLine3":"String","Town":"String","County":"String","Country":"String","Postcode":"String","Duration":"String","DateStarted":"String","TotalNumberOfMonths":"String"}}],"HomePhone":"String","MobilePhone":"String","WorkPhone":"String","ContactAtWork":"String","Email":"String","BankSortCode":"String","BankAccountNumber":"String","BankAccountName":"String","BankName":"String","BankAddress":{"AddressLine1":"String","AddressLine2":"String","AddressLine3":"String","AddressLine4":"String","AddressLine5":"String","Postcode":"String"},"BankPaymentType":"String","DrivingLicenceNumber":"String","CurrentEmploymentDetails":{"EmployerDetails":{"EmploymentType":"String","EmployersName":"String","Occupation":"String","EmployersAddress":{"AddressLine1":"String","AddressLine2":"String","AddressLine3":"String","Town":"String","County":"String","Country":"String","Postcode":"String","Duration":"String","DateStarted":"String","TotalNumberOfMonths":"String"}},"MonthsAtEmployer":"String","DateEmploymentCommenced":"String","AnnualIncome":"String"},"PreviousEmploymentDetails":[{"Seq":0,"previousEmployment":{"EmploymentType":"String","EmployersName":"String","Occupation":"String","EmployersAddress":{"AddressLine1":"String","AddressLine2":"String","AddressLine3":"String","Town":"String","County":"String","Country":"String","Postcode":"String","Duration":"String","DateStarted":"String","TotalNumberOfMonths":"String"}}}],"MarketingPreference":{"OptInMail":"String","OptInTelephone":"String","OptInEmail":"String","OptInSMS":"String"},"CreditCheckConsent":"String"},"CreditApplicationBusiness":{"TypeOfBusiness":"String","BusinessContactPosition":"String","Title":"String","Initial":"String","FirstName":"String","Surname":"String","CurrentHomeAddress":{"AddressLine1":"String","AddressLine2":"String","AddressLine3":"String","Town":"String","County":"String","Country":"String","Postcode":"String","Duration":"String","DateStarted":"String","TotalNumberOfMonths":"String"},"HomePhone":"String","WorkPhone":"String","MobilePhone":"String","Email":"String","CompanyName":"String","CompanyRegistrationNumber":"String","TradingAs":"String","BusinessActivity":"String","NumberOfEmployees":0,"YearsTrading":0,"Position":"String","BankSortCode":"String","BankAccountNumber":"String","BankAccountName":"String","BankName":"String","BankAddress":{"AddressLine1":"String","AddressLine2":"String","AddressLine3":"String","AddressLine4":"String","AddressLine5":"String","Postcode":"String"},"NumberofPartners":0,"BusinessPartners":[{"Seq":0,"Title":"String","Initial":"String","FirstName":"String","Surname":"String","DateofBirth":"String","Gender":"String","MaritalStatus":"String","ResidentialStatus":"String","CurrentAddress":{"AddressLine1":"String","AddressLine2":"String","AddressLine3":"String","Town":"String","County":"String","Country":"String","Postcode":"String","Duration":"String","DateStarted":"String","TotalNumberOfMonths":"String"},"PreviousAddresses":[{"Seq":0,"Address":{"AddressLine1":"String","AddressLine2":"String","AddressLine3":"String","Town":"String","County":"String","Country":"String","Postcode":"String","Duration":"String","DateStarted":"String","TotalNumberOfMonths":"String"}}],"HomePhone":"String","MobilePhone":"String","BusinessPhone":"String","Relationship":"String","Email":"String","CurrentEmploymentDetails":{"EmployerDetails":{"EmploymentType":"String","EmployersName":"String","Occupation":"String","EmployersAddress":{"AddressLine1":"String","AddressLine2":"String","AddressLine3":"String","Town":"String","County":"String","Country":"String","Postcode":"String","Duration":"String","DateStarted":"String","TotalNumberOfMonths":"String"}},"MonthsAtEmployer":"String","DateEmploymentCommenced":"String","AnnualIncome":"String"},"PreviousEmploymentDetails":[{"Seq":0,"previousEmployment":{"EmploymentType":"String","EmployersName":"String","Occupation":"String","EmployersAddress":{"AddressLine1":"String","AddressLine2":"String","AddressLine3":"String","Town":"String","County":"String","Country":"String","Postcode":"String","Duration":"String","DateStarted":"String","TotalNumberOfMonths":"String"}}}],"PartnerType":"String"}],"MarketingPreference":{"OptInMail":"String","OptInTelephone":"String","OptInEmail":"String","OptInSMS":"String"},"PreviousAddresses":[{"Seq":0,"Address":{"AddressLine1":"String","AddressLine2":"String","AddressLine3":"String","Town":"String","County":"String","Country":"String","Postcode":"String","Duration":"String","DateStarted":"String","TotalNumberOfMonths":"String"}}]},"PaymentDetails":{"paymentDetails":[{"Seq":0,"PaymentType":"String","AmountPaid":0,"PaymentTransactionID":"String","Description":"String","PaymentDateTime":"String"}]},"Notes":[{"Seq":0,"Note":"String"}],"DiPDetails":{"DiPCustomerId":"String","DiPTimestamp":"String","DiPRequestID":"String","DiPDecisionType":"String","DiPPrimaryDecisionCode":"String","DiPDecisionDescription":"String","DipDecisionDescriptionCode":"String","DipPrimaryDecisionReason":"String","DiPPrimaryDecisionReasonDealerMessage":"String","diPReasons":[{"DipReasonSeq":0,"DipDecisionCode":"String","DiPDecisionReason":"String","DiPDealerMessage":"String"}]}}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Code":"String","Message":"String","URN":0}