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 .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"ApplicationGUID":"String","CSR":0,"ApplicationDetails":{"specialInstructions":"String","typeAcquiring":false,"typePOS_F2F":false,"typePOS_MOTO":false,"typeOnlinePayments":false,"typeVirtualTerminal":false,"sellerCode":"String","numOutlets":0,"mccCode":"String","offerDescription":"String","pricingPackage":"Unknown","contractLength":0,"settlementPeriodTPlus":"String","ecomPSP":"String","posPSP":"String"},"MainBusinessRepresentative":{"name":{"title":"String","firstName":"String","middleName":"String","lastName":"String"},"phone":"String","email":"String","position":"String","altPhone":"String","preferredContactMethod":"String","preferredContactBestTime":"String"},"CompanyDetail":{"legalName":"String","tradingName":"String","tradingAddress":{"address1":"String","address2":"String","address3":"String","postalCode":"String","city":"String","state":"String","countryCode":"String"},"legalAddress":{"address1":"String","address2":"String","address3":"String","postalCode":"String","city":"String","state":"String","countryCode":"String"},"website":"String","companyType":"String","registrationNumber":"String","merchantCategoryPseudoName":"String","vatNumber":"String","hasStartedTrading":false,"startedTradingMonth":"String","startedTradingYear":"String","companyTypeOther":"String","isRegisteredCharity":false,"countryOfIncorporation":"String","regionOfIncorporation":"String"},"BankDetail":{"sortCode":"String","accountNumber":"String","bankName":"String","bankAccountName":"String","settlementCurrency":"String","swiftCode":"String"},"BusinessProfile":{"descriptionOfYourGoodsAndServices":"String","anticipatedAverageMonthlyTurnover":0,"anticipatedPeakMonthlyTurnover":0,"percentageOfPrepayments":0,"percentageOfDeposits":0,"percentageOfSubscriptions":0,"daysFromOrderConfirmationToDelivery":[{"percentageOfOrders":0,"numberOfDays":0}],"depositPaymentDetails":[{"percentageOfTotalTurnoverToRelatedBusiness":0,"percentageOfTotalTurnoverTakenAsDeposit":0,"averageDaysBetweenDepositAndFullPayment":0,"averageDaysBetweenFullPaymentAndDelivery":0}],"averageSubscriptionLengthInMonths":0,"averageNumberOfSubscriptionPayments":0,"anticipatedPercentageIncreaseInTurnoverForAYear":0,"ccTurnover":0,"totalCardTurnover":0,"cnpPercentage":0,"totalTurnover":0,"avTransValue":0,"cnpRequired":false,"cashbackRequired":false,"futurePayRequired":false,"newToCards":false},"Owners":[{"dayOfBirth":0,"monthOfBirth":0,"yearOfBirth":0,"ownershipPercentage":0,"homeAddress":{"address1":"String","address2":"String","address3":"String","postalCode":"String","city":"String","state":"String","countryCode":"String"},"currentAddressLessThanThreeYears":false,"previousHomeAddress":{"address1":"String","address2":"String","address3":"String","postalCode":"String","city":"String","state":"String","countryCode":"String"},"name":{"title":"String","firstName":"String","middleName":"String","lastName":"String"},"director":false,"nationality":"String","position":"String","timeAtHomeAddressYears":0,"timeAtHomeAddressMonths":0,"PrimaryPartyID":"String","identityVerificationDocuments":[{"documentId":"String","authenticity":"String"}]}],"NapPartyId":"String"}