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
AllChecksDataRequestRequest Parameters:
NameParameterData TypeRequiredDescription
ApplicationGUIDbodystringYes
CSRbodyintNo
ApplicationDetailsbodyApplicationDetailsYes
MainBusinessRepresentativebodyContactDetailsYes
CompanyDetailbodyCompanyDetailsYes
BankDetailbodyBankDetailsYes
BusinessProfilebodyBusinessProfileYes
OwnersbodyList<OwnerDetails>Yes
NapPartyIdbodystringNo
ApplicationDetails Parameters:
NameParameterData TypeRequiredDescription
specialInstructionsformstringNo
typeAcquiringformbool?No
typePOS_F2Fformbool?No
typePOS_MOTOformbool?No
typeOnlinePaymentsformbool?No
typeVirtualTerminalformbool?No
sellerCodeformstringNo
numOutletsformint?No
mccCodeformstringNo
offerDescriptionformstringNo
pricingPackageformstringNo
contractLengthformint?No
settlementPeriodTPlusformstringNo
ecomPSPformstringNo
posPSPformstringNo
ContactDetails Parameters:
NameParameterData TypeRequiredDescription
nameformContactNameDataNo
phoneformstringNo
emailformstringNo
positionformstringNo
altPhoneformstringNo
preferredContactMethodformstringNo
preferredContactBestTimeformstringNo
ContactNameData Parameters:
NameParameterData TypeRequiredDescription
titleformstringNo
firstNameformstringNo
middleNameformstringNo
lastNameformstringNo
CompanyDetails Parameters:
NameParameterData TypeRequiredDescription
legalNameformstringNo
tradingNameformstringNo
tradingAddressformAddressDataNo
legalAddressformAddressDataNo
websiteformstringNo
companyTypeformstringNo
registrationNumberformstringNo
merchantCategoryPseudoNameformstringNo
vatNumberformstringNo
hasStartedTradingformbool?No
startedTradingMonthformstringNo
startedTradingYearformstringNo
companyTypeOtherformstringNo
isRegisteredCharityformbool?No
countryOfIncorporationformstringNo
regionOfIncorporationformstringNo
AddressData Parameters:
NameParameterData TypeRequiredDescription
address1formstringNo
address2formstringNo
address3formstringNo
postalCodeformstringNo
cityformstringNo
stateformstringNo
countryCodeformstringNo
BankDetails Parameters:
NameParameterData TypeRequiredDescription
sortCodeformstringNo
accountNumberformstringNo
bankNameformstringNo
bankAccountNameformstringNo
settlementCurrencyformstringNo
swiftCodeformstringNo
BusinessProfile Parameters:
NameParameterData TypeRequiredDescription
descriptionOfYourGoodsAndServicesformstringNo
anticipatedAverageMonthlyTurnoverformdouble?No
anticipatedPeakMonthlyTurnoverformdouble?No
percentageOfPrepaymentsformdouble?No
percentageOfDepositsformdouble?No
percentageOfSubscriptionsformdouble?No
daysFromOrderConfirmationToDeliveryformList<DaysToDelivery>No
depositPaymentDetailsformList<PaymentDetails>No
averageSubscriptionLengthInMonthsformint?No
averageNumberOfSubscriptionPaymentsformint?No
anticipatedPercentageIncreaseInTurnoverForAYearformdouble?No
ccTurnoverformdouble?No
totalCardTurnoverformdouble?No
cnpPercentageformdouble?No
totalTurnoverformdouble?No
avTransValueformdouble?No
cnpRequiredformboolNo
cashbackRequiredformboolNo
futurePayRequiredformboolNo
newToCardsformbool?No
DaysToDelivery Parameters:
NameParameterData TypeRequiredDescription
percentageOfOrdersformdouble?No
numberOfDaysformint?No
PaymentDetails Parameters:
NameParameterData TypeRequiredDescription
percentageOfTotalTurnoverToRelatedBusinessformdouble?No
percentageOfTotalTurnoverTakenAsDepositformdouble?No
averageDaysBetweenDepositAndFullPaymentformint?No
averageDaysBetweenFullPaymentAndDeliveryformint?No
OwnerDetails Parameters:
NameParameterData TypeRequiredDescription
dayOfBirthformintNo
monthOfBirthformintNo
yearOfBirthformintNo
ownershipPercentageformdouble?No
homeAddressformAddressDataNo
currentAddressLessThanThreeYearsformboolNo
previousHomeAddressformAddressDataNo
nameformContactNameDataNo
directorformboolNo
nationalityformstringNo
positionformstringNo
timeAtHomeAddressYearsformint?No
timeAtHomeAddressMonthsformint?No
PrimaryPartyIDformstringNo
identityVerificationDocumentsformList<IdentityVerificationDocuments>No
IdentityVerificationDocuments Parameters:
NameParameterData TypeRequiredDescription
documentIdformstringNo
authenticityformstringNo

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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
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
}