CDD Engine Web Service v2.14.0.0

AllChecksDataRequestRequest

The following routes are available for this service:
POST	/allchecks/submit/data

namespace CDD_Engine_DLL.DataObjects

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ApplicationDetails() = 
        member val specialInstructions:String = null with get,set
        member val typeAcquiring:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val typePOS_F2F:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val typePOS_MOTO:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val typeOnlinePayments:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val typeVirtualTerminal:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val sellerCode:String = null with get,set
        member val numOutlets:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val mccCode:String = null with get,set
        member val offerDescription:String = null with get,set
        member val pricingPackage:String = null with get,set
        member val contractLength:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val settlementPeriodTPlus:String = null with get,set
        member val ecomPSP:String = null with get,set
        member val posPSP:String = null with get,set

    [<AllowNullLiteral>]
    type ContactNameData() = 
        member val title:String = null with get,set
        member val firstName:String = null with get,set
        member val middleName:String = null with get,set
        member val lastName:String = null with get,set

    [<AllowNullLiteral>]
    type ContactDetails() = 
        member val name:ContactNameData = null with get,set
        member val phone:String = null with get,set
        member val email:String = null with get,set
        member val position:String = null with get,set
        member val altPhone:String = null with get,set
        member val preferredContactMethod:String = null with get,set
        member val preferredContactBestTime:String = null with get,set

    [<AllowNullLiteral>]
    type AddressData() = 
        member val address1:String = null with get,set
        member val address2:String = null with get,set
        member val address3:String = null with get,set
        member val postalCode:String = null with get,set
        member val city:String = null with get,set
        member val state:String = null with get,set
        member val countryCode:String = null with get,set

    [<AllowNullLiteral>]
    type CompanyDetails() = 
        member val legalName:String = null with get,set
        member val tradingName:String = null with get,set
        member val tradingAddress:AddressData = null with get,set
        member val legalAddress:AddressData = null with get,set
        member val website:String = null with get,set
        member val companyType:String = null with get,set
        member val registrationNumber:String = null with get,set
        member val merchantCategoryPseudoName:String = null with get,set
        member val vatNumber:String = null with get,set
        member val hasStartedTrading:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val startedTradingMonth:String = null with get,set
        member val startedTradingYear:String = null with get,set
        member val companyTypeOther:String = null with get,set
        member val isRegisteredCharity:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val countryOfIncorporation:String = null with get,set
        member val regionOfIncorporation:String = null with get,set

    [<AllowNullLiteral>]
    type BankDetails() = 
        member val sortCode:String = null with get,set
        member val accountNumber:String = null with get,set
        member val bankName:String = null with get,set
        member val bankAccountName:String = null with get,set
        member val settlementCurrency:String = null with get,set
        member val swiftCode:String = null with get,set

    [<AllowNullLiteral>]
    type DaysToDelivery() = 
        member val percentageOfOrders:Nullable<Double> = new Nullable<Double>() with get,set
        member val numberOfDays:Nullable<Int32> = new Nullable<Int32>() with get,set

    [<AllowNullLiteral>]
    type PaymentDetails() = 
        member val percentageOfTotalTurnoverToRelatedBusiness:Nullable<Double> = new Nullable<Double>() with get,set
        member val percentageOfTotalTurnoverTakenAsDeposit:Nullable<Double> = new Nullable<Double>() with get,set
        member val averageDaysBetweenDepositAndFullPayment:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val averageDaysBetweenFullPaymentAndDelivery:Nullable<Int32> = new Nullable<Int32>() with get,set

    [<AllowNullLiteral>]
    type BusinessProfile() = 
        member val descriptionOfYourGoodsAndServices:String = null with get,set
        member val anticipatedAverageMonthlyTurnover:Nullable<Double> = new Nullable<Double>() with get,set
        member val anticipatedPeakMonthlyTurnover:Nullable<Double> = new Nullable<Double>() with get,set
        member val percentageOfPrepayments:Nullable<Double> = new Nullable<Double>() with get,set
        member val percentageOfDeposits:Nullable<Double> = new Nullable<Double>() with get,set
        member val percentageOfSubscriptions:Nullable<Double> = new Nullable<Double>() with get,set
        member val daysFromOrderConfirmationToDelivery:ResizeArray<DaysToDelivery> = new ResizeArray<DaysToDelivery>() with get,set
        member val depositPaymentDetails:ResizeArray<PaymentDetails> = new ResizeArray<PaymentDetails>() with get,set
        member val averageSubscriptionLengthInMonths:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val averageNumberOfSubscriptionPayments:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val anticipatedPercentageIncreaseInTurnoverForAYear:Nullable<Double> = new Nullable<Double>() with get,set
        member val ccTurnover:Nullable<Double> = new Nullable<Double>() with get,set
        member val totalCardTurnover:Nullable<Double> = new Nullable<Double>() with get,set
        member val cnpPercentage:Nullable<Double> = new Nullable<Double>() with get,set
        member val totalTurnover:Nullable<Double> = new Nullable<Double>() with get,set
        member val avTransValue:Nullable<Double> = new Nullable<Double>() with get,set
        member val cnpRequired:Boolean = new Boolean() with get,set
        member val cashbackRequired:Boolean = new Boolean() with get,set
        member val futurePayRequired:Boolean = new Boolean() with get,set
        member val newToCards:Nullable<Boolean> = new Nullable<Boolean>() with get,set

    [<AllowNullLiteral>]
    type IdentityVerificationDocuments() = 
        member val documentId:String = null with get,set
        member val authenticity:String = null with get,set

    [<AllowNullLiteral>]
    type OwnerDetails() = 
        member val dayOfBirth:Int32 = new Int32() with get,set
        member val monthOfBirth:Int32 = new Int32() with get,set
        member val yearOfBirth:Int32 = new Int32() with get,set
        member val ownershipPercentage:Nullable<Double> = new Nullable<Double>() with get,set
        member val homeAddress:AddressData = null with get,set
        member val currentAddressLessThanThreeYears:Boolean = new Boolean() with get,set
        member val previousHomeAddress:AddressData = null with get,set
        member val name:ContactNameData = null with get,set
        member val director:Boolean = new Boolean() with get,set
        member val nationality:String = null with get,set
        member val position:String = null with get,set
        member val timeAtHomeAddressYears:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val timeAtHomeAddressMonths:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val PrimaryPartyID:String = null with get,set
        member val identityVerificationDocuments:ResizeArray<IdentityVerificationDocuments> = new ResizeArray<IdentityVerificationDocuments>() with get,set

    [<AllowNullLiteral>]
    type AllChecksDataRequestRequest() = 
        member val ApplicationGUID:String = null with get,set
        member val CSR:Int32 = new Int32() with get,set
        member val ApplicationDetails:ApplicationDetails = null with get,set
        member val MainBusinessRepresentative:ContactDetails = null with get,set
        member val CompanyDetail:CompanyDetails = null with get,set
        member val BankDetail:BankDetails = null with get,set
        member val BusinessProfile:BusinessProfile = null with get,set
        member val Owners:ResizeArray<OwnerDetails> = new ResizeArray<OwnerDetails>() with get,set
        member val NapPartyId:String = null with get,set

F# AllChecksDataRequestRequest DTOs

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

HTTP + XML

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

POST /allchecks/submit/data HTTP/1.1 
Host: wpcdd-featuretest-ws.worldpay.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AllChecksDataRequestRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CDD_Engine_WS.dto.Requests">
  <ApplicationDetails xmlns:d2p1="http://schemas.datacontract.org/2004/07/CDD_Engine_DLL.DataObjects">
    <d2p1:contractLength>0</d2p1:contractLength>
    <d2p1:csr>String</d2p1:csr>
    <d2p1:ecomPSP>String</d2p1:ecomPSP>
    <d2p1:mccCode>String</d2p1:mccCode>
    <d2p1:numOutlets>0</d2p1:numOutlets>
    <d2p1:offerDescription>String</d2p1:offerDescription>
    <d2p1:posPSP>String</d2p1:posPSP>
    <d2p1:sellerCode>String</d2p1:sellerCode>
    <d2p1:settlementPeriodTPlus>String</d2p1:settlementPeriodTPlus>
    <d2p1:specialInstructions>String</d2p1:specialInstructions>
    <d2p1:typeAcquiring>false</d2p1:typeAcquiring>
    <d2p1:typeOnlinePayments>false</d2p1:typeOnlinePayments>
    <d2p1:typePOS_F2F>false</d2p1:typePOS_F2F>
    <d2p1:typePOS_MOTO>false</d2p1:typePOS_MOTO>
    <d2p1:typeVirtualTerminal>false</d2p1:typeVirtualTerminal>
  </ApplicationDetails>
  <ApplicationGUID>String</ApplicationGUID>
  <BankDetail xmlns:d2p1="http://schemas.datacontract.org/2004/07/CDD_Engine_DLL.DataObjects">
    <d2p1:accountNumber>String</d2p1:accountNumber>
    <d2p1:bankAccountName>String</d2p1:bankAccountName>
    <d2p1:bankName>String</d2p1:bankName>
    <d2p1:settlementCurrency>String</d2p1:settlementCurrency>
    <d2p1:sortCode>String</d2p1:sortCode>
    <d2p1:swiftCode>String</d2p1:swiftCode>
  </BankDetail>
  <BusinessProfile xmlns:d2p1="http://schemas.datacontract.org/2004/07/CDD_Engine_DLL.DataObjects">
    <d2p1:anticipatedAverageMonthlyTurnover>0</d2p1:anticipatedAverageMonthlyTurnover>
    <d2p1:anticipatedPeakMonthlyTurnover>0</d2p1:anticipatedPeakMonthlyTurnover>
    <d2p1:anticipatedPercentageIncreaseInTurnoverForAYear>0</d2p1:anticipatedPercentageIncreaseInTurnoverForAYear>
    <d2p1:avTransValue>0</d2p1:avTransValue>
    <d2p1:averageNumberOfSubscriptionPayments>0</d2p1:averageNumberOfSubscriptionPayments>
    <d2p1:averageSubscriptionLengthInMonths>0</d2p1:averageSubscriptionLengthInMonths>
    <d2p1:cashbackRequired>false</d2p1:cashbackRequired>
    <d2p1:ccTurnover>0</d2p1:ccTurnover>
    <d2p1:cnpPercentage>0</d2p1:cnpPercentage>
    <d2p1:cnpRequired>false</d2p1:cnpRequired>
    <d2p1:daysFromOrderConfirmationToDelivery>
      <d2p1:DaysToDelivery>
        <d2p1:numberOfDays>0</d2p1:numberOfDays>
        <d2p1:percentageOfOrders>0</d2p1:percentageOfOrders>
      </d2p1:DaysToDelivery>
    </d2p1:daysFromOrderConfirmationToDelivery>
    <d2p1:depositPaymentDetails>
      <d2p1:PaymentDetails>
        <d2p1:averageDaysBetweenDepositAndFullPayment>0</d2p1:averageDaysBetweenDepositAndFullPayment>
        <d2p1:averageDaysBetweenFullPaymentAndDelivery>0</d2p1:averageDaysBetweenFullPaymentAndDelivery>
        <d2p1:percentageOfTotalTurnoverTakenAsDeposit>0</d2p1:percentageOfTotalTurnoverTakenAsDeposit>
        <d2p1:percentageOfTotalTurnoverToRelatedBusiness>0</d2p1:percentageOfTotalTurnoverToRelatedBusiness>
      </d2p1:PaymentDetails>
    </d2p1:depositPaymentDetails>
    <d2p1:descriptionOfYourGoodsAndServices>String</d2p1:descriptionOfYourGoodsAndServices>
    <d2p1:futurePayRequired>false</d2p1:futurePayRequired>
    <d2p1:newToCards>false</d2p1:newToCards>
    <d2p1:percentageOfDeposits>0</d2p1:percentageOfDeposits>
    <d2p1:percentageOfPrepayments>0</d2p1:percentageOfPrepayments>
    <d2p1:percentageOfSubscriptions>0</d2p1:percentageOfSubscriptions>
    <d2p1:totalCardTurnover>0</d2p1:totalCardTurnover>
    <d2p1:totalTurnover>0</d2p1:totalTurnover>
  </BusinessProfile>
  <CSR>0</CSR>
  <CompanyDetail xmlns:d2p1="http://schemas.datacontract.org/2004/07/CDD_Engine_DLL.DataObjects">
    <d2p1:companyType>String</d2p1:companyType>
    <d2p1:companyTypeOther>String</d2p1:companyTypeOther>
    <d2p1:countryOfIncorporation>String</d2p1:countryOfIncorporation>
    <d2p1:hasStartedTrading>false</d2p1:hasStartedTrading>
    <d2p1:isRegisteredCharity>false</d2p1:isRegisteredCharity>
    <d2p1:legalAddress>
      <d2p1:address1>String</d2p1:address1>
      <d2p1:address2>String</d2p1:address2>
      <d2p1:address3>String</d2p1:address3>
      <d2p1:city>String</d2p1:city>
      <d2p1:countryCode>String</d2p1:countryCode>
      <d2p1:postalCode>String</d2p1:postalCode>
      <d2p1:state>String</d2p1:state>
    </d2p1:legalAddress>
    <d2p1:legalName>String</d2p1:legalName>
    <d2p1:merchantCategoryPseudoName>String</d2p1:merchantCategoryPseudoName>
    <d2p1:regionOfIncorporation>String</d2p1:regionOfIncorporation>
    <d2p1:registrationNumber>String</d2p1:registrationNumber>
    <d2p1:startedTradingMonth>String</d2p1:startedTradingMonth>
    <d2p1:startedTradingYear>String</d2p1:startedTradingYear>
    <d2p1:tradingAddress>
      <d2p1:address1>String</d2p1:address1>
      <d2p1:address2>String</d2p1:address2>
      <d2p1:address3>String</d2p1:address3>
      <d2p1:city>String</d2p1:city>
      <d2p1:countryCode>String</d2p1:countryCode>
      <d2p1:postalCode>String</d2p1:postalCode>
      <d2p1:state>String</d2p1:state>
    </d2p1:tradingAddress>
    <d2p1:tradingName>String</d2p1:tradingName>
    <d2p1:vatNumber>String</d2p1:vatNumber>
    <d2p1:website>String</d2p1:website>
  </CompanyDetail>
  <MainBusinessRepresentative xmlns:d2p1="http://schemas.datacontract.org/2004/07/CDD_Engine_DLL.DataObjects">
    <d2p1:altPhone>String</d2p1:altPhone>
    <d2p1:email>String</d2p1:email>
    <d2p1:name>
      <d2p1:firstName>String</d2p1:firstName>
      <d2p1:lastName>String</d2p1:lastName>
      <d2p1:middleName>String</d2p1:middleName>
      <d2p1:title>String</d2p1:title>
    </d2p1:name>
    <d2p1:phone>String</d2p1:phone>
    <d2p1:position>String</d2p1:position>
    <d2p1:preferredContactBestTime>String</d2p1:preferredContactBestTime>
    <d2p1:preferredContactMethod>String</d2p1:preferredContactMethod>
  </MainBusinessRepresentative>
  <NapPartyId>String</NapPartyId>
  <Owners xmlns:d2p1="http://schemas.datacontract.org/2004/07/CDD_Engine_DLL.DataObjects">
    <d2p1:OwnerDetails>
      <d2p1:PrimaryPartyID>String</d2p1:PrimaryPartyID>
      <d2p1:currentAddressLessThanThreeYears>false</d2p1:currentAddressLessThanThreeYears>
      <d2p1:dayOfBirth>0</d2p1:dayOfBirth>
      <d2p1:director>false</d2p1:director>
      <d2p1:homeAddress>
        <d2p1:address1>String</d2p1:address1>
        <d2p1:address2>String</d2p1:address2>
        <d2p1:address3>String</d2p1:address3>
        <d2p1:city>String</d2p1:city>
        <d2p1:countryCode>String</d2p1:countryCode>
        <d2p1:postalCode>String</d2p1:postalCode>
        <d2p1:state>String</d2p1:state>
      </d2p1:homeAddress>
      <d2p1:identityVerificationDocuments>
        <d2p1:IdentityVerificationDocuments>
          <d2p1:authenticity>String</d2p1:authenticity>
          <d2p1:documentId>String</d2p1:documentId>
        </d2p1:IdentityVerificationDocuments>
      </d2p1:identityVerificationDocuments>
      <d2p1:monthOfBirth>0</d2p1:monthOfBirth>
      <d2p1:name>
        <d2p1:firstName>String</d2p1:firstName>
        <d2p1:lastName>String</d2p1:lastName>
        <d2p1:middleName>String</d2p1:middleName>
        <d2p1:title>String</d2p1:title>
      </d2p1:name>
      <d2p1:nationality>String</d2p1:nationality>
      <d2p1:ownershipPercentage>0</d2p1:ownershipPercentage>
      <d2p1:position>String</d2p1:position>
      <d2p1:previousHomeAddress>
        <d2p1:address1>String</d2p1:address1>
        <d2p1:address2>String</d2p1:address2>
        <d2p1:address3>String</d2p1:address3>
        <d2p1:city>String</d2p1:city>
        <d2p1:countryCode>String</d2p1:countryCode>
        <d2p1:postalCode>String</d2p1:postalCode>
        <d2p1:state>String</d2p1:state>
      </d2p1:previousHomeAddress>
      <d2p1:timeAtHomeAddressMonths>0</d2p1:timeAtHomeAddressMonths>
      <d2p1:timeAtHomeAddressYears>0</d2p1:timeAtHomeAddressYears>
      <d2p1:yearOfBirth>0</d2p1:yearOfBirth>
    </d2p1:OwnerDetails>
  </Owners>
</AllChecksDataRequestRequest>