CDD Engine Web Service v2.14.0.0

<back to all web services

AllChecksDataRequestRequest

Requires Authentication
The following routes are available for this service:
POST/allchecks/submit/data
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CDD_Engine_WS.dto.Requests;
using CDD_Engine_DLL.DataObjects;

namespace CDD_Engine_DLL.DataObjects
{
    public partial class AddressData
    {
        public virtual string address1 { get; set; }
        public virtual string address2 { get; set; }
        public virtual string address3 { get; set; }
        public virtual string postalCode { get; set; }
        public virtual string city { get; set; }
        public virtual string state { get; set; }
        public virtual string countryCode { get; set; }
    }

    public partial class ApplicationDetails
    {
        public virtual string specialInstructions { get; set; }
        public virtual bool? typeAcquiring { get; set; }
        public virtual bool? typePOS_F2F { get; set; }
        public virtual bool? typePOS_MOTO { get; set; }
        public virtual bool? typeOnlinePayments { get; set; }
        public virtual bool? typeVirtualTerminal { get; set; }
        public virtual string sellerCode { get; set; }
        public virtual int? numOutlets { get; set; }
        public virtual string mccCode { get; set; }
        public virtual string offerDescription { get; set; }
        public virtual string pricingPackage { get; set; }
        public virtual int? contractLength { get; set; }
        public virtual string settlementPeriodTPlus { get; set; }
        public virtual string ecomPSP { get; set; }
        public virtual string posPSP { get; set; }
    }

    public partial class BankDetails
    {
        public virtual string sortCode { get; set; }
        public virtual string accountNumber { get; set; }
        public virtual string bankName { get; set; }
        public virtual string bankAccountName { get; set; }
        public virtual string settlementCurrency { get; set; }
        public virtual string swiftCode { get; set; }
    }

    public partial class BusinessProfile
    {
        public BusinessProfile()
        {
            daysFromOrderConfirmationToDelivery = new List<DaysToDelivery>{};
            depositPaymentDetails = new List<PaymentDetails>{};
        }

        public virtual string descriptionOfYourGoodsAndServices { get; set; }
        public virtual double? anticipatedAverageMonthlyTurnover { get; set; }
        public virtual double? anticipatedPeakMonthlyTurnover { get; set; }
        public virtual double? percentageOfPrepayments { get; set; }
        public virtual double? percentageOfDeposits { get; set; }
        public virtual double? percentageOfSubscriptions { get; set; }
        public virtual List<DaysToDelivery> daysFromOrderConfirmationToDelivery { get; set; }
        public virtual List<PaymentDetails> depositPaymentDetails { get; set; }
        public virtual int? averageSubscriptionLengthInMonths { get; set; }
        public virtual int? averageNumberOfSubscriptionPayments { get; set; }
        public virtual double? anticipatedPercentageIncreaseInTurnoverForAYear { get; set; }
        public virtual double? ccTurnover { get; set; }
        public virtual double? totalCardTurnover { get; set; }
        public virtual double? cnpPercentage { get; set; }
        public virtual double? totalTurnover { get; set; }
        public virtual double? avTransValue { get; set; }
        public virtual bool cnpRequired { get; set; }
        public virtual bool cashbackRequired { get; set; }
        public virtual bool futurePayRequired { get; set; }
        public virtual bool? newToCards { get; set; }
    }

    public partial class CompanyDetails
    {
        public virtual string legalName { get; set; }
        public virtual string tradingName { get; set; }
        public virtual AddressData tradingAddress { get; set; }
        public virtual AddressData legalAddress { get; set; }
        public virtual string website { get; set; }
        public virtual string companyType { get; set; }
        public virtual string registrationNumber { get; set; }
        public virtual string merchantCategoryPseudoName { get; set; }
        public virtual string vatNumber { get; set; }
        public virtual bool? hasStartedTrading { get; set; }
        public virtual string startedTradingMonth { get; set; }
        public virtual string startedTradingYear { get; set; }
        public virtual string companyTypeOther { get; set; }
        public virtual bool? isRegisteredCharity { get; set; }
        public virtual string countryOfIncorporation { get; set; }
        public virtual string regionOfIncorporation { get; set; }
    }

    public partial class ContactDetails
    {
        public virtual ContactNameData name { get; set; }
        public virtual string phone { get; set; }
        public virtual string email { get; set; }
        public virtual string position { get; set; }
        public virtual string altPhone { get; set; }
        public virtual string preferredContactMethod { get; set; }
        public virtual string preferredContactBestTime { get; set; }
    }

    public partial class ContactNameData
    {
        public virtual string title { get; set; }
        public virtual string firstName { get; set; }
        public virtual string middleName { get; set; }
        public virtual string lastName { get; set; }
    }

    public partial class DaysToDelivery
    {
        public virtual double? percentageOfOrders { get; set; }
        public virtual int? numberOfDays { get; set; }
    }

    public partial class IdentityVerificationDocuments
    {
        public virtual string documentId { get; set; }
        public virtual string authenticity { get; set; }
    }

    public partial class OwnerDetails
    {
        public OwnerDetails()
        {
            identityVerificationDocuments = new List<IdentityVerificationDocuments>{};
        }

        public virtual int dayOfBirth { get; set; }
        public virtual int monthOfBirth { get; set; }
        public virtual int yearOfBirth { get; set; }
        public virtual double? ownershipPercentage { get; set; }
        public virtual AddressData homeAddress { get; set; }
        public virtual bool currentAddressLessThanThreeYears { get; set; }
        public virtual AddressData previousHomeAddress { get; set; }
        public virtual ContactNameData name { get; set; }
        public virtual bool director { get; set; }
        public virtual string nationality { get; set; }
        public virtual string position { get; set; }
        public virtual int? timeAtHomeAddressYears { get; set; }
        public virtual int? timeAtHomeAddressMonths { get; set; }
        public virtual string PrimaryPartyID { get; set; }
        public virtual List<IdentityVerificationDocuments> identityVerificationDocuments { get; set; }
    }

    public partial class PaymentDetails
    {
        public virtual double? percentageOfTotalTurnoverToRelatedBusiness { get; set; }
        public virtual double? percentageOfTotalTurnoverTakenAsDeposit { get; set; }
        public virtual int? averageDaysBetweenDepositAndFullPayment { get; set; }
        public virtual int? averageDaysBetweenFullPaymentAndDelivery { get; set; }
    }

}

namespace CDD_Engine_WS.dto.Requests
{
    public partial class AllChecksDataRequestRequest
    {
        public AllChecksDataRequestRequest()
        {
            Owners = new List<OwnerDetails>{};
        }

        public virtual string ApplicationGUID { get; set; }
        public virtual int CSR { get; set; }
        public virtual ApplicationDetails ApplicationDetails { get; set; }
        public virtual ContactDetails MainBusinessRepresentative { get; set; }
        public virtual CompanyDetails CompanyDetail { get; set; }
        public virtual BankDetails BankDetail { get; set; }
        public virtual BusinessProfile BusinessProfile { get; set; }
        public virtual List<OwnerDetails> Owners { get; set; }
        public virtual string NapPartyId { get; set; }
    }

}

C# 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: wp-cddws-test.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>