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

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 .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"}