CDD Engine Web Service v2.14.0.0

AllChecksDataRequestRequest

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


export class ApplicationDetails
{
    public specialInstructions?: string;
    public typeAcquiring?: boolean;
    public typePOS_F2F?: boolean;
    public typePOS_MOTO?: boolean;
    public typeOnlinePayments?: boolean;
    public typeVirtualTerminal?: boolean;
    public sellerCode?: string;
    public numOutlets?: number;
    public mccCode?: string;
    public offerDescription?: string;
    public pricingPackage?: string;
    public contractLength?: number;
    public settlementPeriodTPlus?: string;
    public ecomPSP?: string;
    public posPSP?: string;

    public constructor(init?: Partial<ApplicationDetails>) { (Object as any).assign(this, init); }
}

export class ContactNameData
{
    public title?: string;
    public firstName?: string;
    public middleName?: string;
    public lastName?: string;

    public constructor(init?: Partial<ContactNameData>) { (Object as any).assign(this, init); }
}

export class ContactDetails
{
    public name?: ContactNameData;
    public phone?: string;
    public email?: string;
    public position?: string;
    public altPhone?: string;
    public preferredContactMethod?: string;
    public preferredContactBestTime?: string;

    public constructor(init?: Partial<ContactDetails>) { (Object as any).assign(this, init); }
}

export class AddressData
{
    public address1?: string;
    public address2?: string;
    public address3?: string;
    public postalCode?: string;
    public city?: string;
    public state?: string;
    public countryCode?: string;

    public constructor(init?: Partial<AddressData>) { (Object as any).assign(this, init); }
}

export class CompanyDetails
{
    public legalName?: string;
    public tradingName?: string;
    public tradingAddress?: AddressData;
    public legalAddress?: AddressData;
    public website?: string;
    public companyType?: string;
    public registrationNumber?: string;
    public merchantCategoryPseudoName?: string;
    public vatNumber?: string;
    public hasStartedTrading?: boolean;
    public startedTradingMonth?: string;
    public startedTradingYear?: string;
    public companyTypeOther?: string;
    public isRegisteredCharity?: boolean;
    public countryOfIncorporation?: string;
    public regionOfIncorporation?: string;

    public constructor(init?: Partial<CompanyDetails>) { (Object as any).assign(this, init); }
}

export class BankDetails
{
    public sortCode?: string;
    public accountNumber?: string;
    public bankName?: string;
    public bankAccountName?: string;
    public settlementCurrency?: string;
    public swiftCode?: string;

    public constructor(init?: Partial<BankDetails>) { (Object as any).assign(this, init); }
}

export class DaysToDelivery
{
    public percentageOfOrders?: number;
    public numberOfDays?: number;

    public constructor(init?: Partial<DaysToDelivery>) { (Object as any).assign(this, init); }
}

export class PaymentDetails
{
    public percentageOfTotalTurnoverToRelatedBusiness?: number;
    public percentageOfTotalTurnoverTakenAsDeposit?: number;
    public averageDaysBetweenDepositAndFullPayment?: number;
    public averageDaysBetweenFullPaymentAndDelivery?: number;

    public constructor(init?: Partial<PaymentDetails>) { (Object as any).assign(this, init); }
}

export class BusinessProfile
{
    public descriptionOfYourGoodsAndServices?: string;
    public anticipatedAverageMonthlyTurnover?: number;
    public anticipatedPeakMonthlyTurnover?: number;
    public percentageOfPrepayments?: number;
    public percentageOfDeposits?: number;
    public percentageOfSubscriptions?: number;
    public daysFromOrderConfirmationToDelivery?: DaysToDelivery[];
    public depositPaymentDetails?: PaymentDetails[];
    public averageSubscriptionLengthInMonths?: number;
    public averageNumberOfSubscriptionPayments?: number;
    public anticipatedPercentageIncreaseInTurnoverForAYear?: number;
    public ccTurnover?: number;
    public totalCardTurnover?: number;
    public cnpPercentage?: number;
    public totalTurnover?: number;
    public avTransValue?: number;
    public cnpRequired?: boolean;
    public cashbackRequired?: boolean;
    public futurePayRequired?: boolean;
    public newToCards?: boolean;

    public constructor(init?: Partial<BusinessProfile>) { (Object as any).assign(this, init); }
}

export class IdentityVerificationDocuments
{
    public documentId?: string;
    public authenticity?: string;

    public constructor(init?: Partial<IdentityVerificationDocuments>) { (Object as any).assign(this, init); }
}

export class OwnerDetails
{
    public dayOfBirth?: number;
    public monthOfBirth?: number;
    public yearOfBirth?: number;
    public ownershipPercentage?: number;
    public homeAddress?: AddressData;
    public currentAddressLessThanThreeYears?: boolean;
    public previousHomeAddress?: AddressData;
    public name?: ContactNameData;
    public director?: boolean;
    public nationality?: string;
    public position?: string;
    public timeAtHomeAddressYears?: number;
    public timeAtHomeAddressMonths?: number;
    public PrimaryPartyID?: string;
    public identityVerificationDocuments?: IdentityVerificationDocuments[];

    public constructor(init?: Partial<OwnerDetails>) { (Object as any).assign(this, init); }
}

export class AllChecksDataRequestRequest
{
    public ApplicationGUID?: string;
    public CSR?: number;
    public ApplicationDetails: ApplicationDetails;
    public MainBusinessRepresentative: ContactDetails;
    public CompanyDetail: CompanyDetails;
    public BankDetail: BankDetails;
    public BusinessProfile: BusinessProfile;
    public Owners: OwnerDetails[];
    public NapPartyId?: string;

    public constructor(init?: Partial<AllChecksDataRequestRequest>) { (Object as any).assign(this, init); }
}

TypeScript 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>