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
import java.math.*
import java.util.*
import net.servicestack.client.*


open class AllChecksDataRequestRequest
{
    var ApplicationGUID:String? = null
    var CSR:Int? = null
    var ApplicationDetails:ApplicationDetails? = null
    var MainBusinessRepresentative:ContactDetails? = null
    var CompanyDetail:CompanyDetails? = null
    var BankDetail:BankDetails? = null
    var BusinessProfile:BusinessProfile? = null
    var Owners:ArrayList<OwnerDetails> = ArrayList<OwnerDetails>()
    var NapPartyId:String? = null
}

open class ApplicationDetails
{
    var specialInstructions:String? = null
    var typeAcquiring:Boolean? = null
    var typePOS_F2F:Boolean? = null
    var typePOS_MOTO:Boolean? = null
    var typeOnlinePayments:Boolean? = null
    var typeVirtualTerminal:Boolean? = null
    var sellerCode:String? = null
    var numOutlets:Int? = null
    var mccCode:String? = null
    var offerDescription:String? = null
    var pricingPackage:String? = null
    var contractLength:Int? = null
    var settlementPeriodTPlus:String? = null
    var ecomPSP:String? = null
    var posPSP:String? = null
}

open class ContactDetails
{
    var name:ContactNameData? = null
    var phone:String? = null
    var email:String? = null
    var position:String? = null
    var altPhone:String? = null
    var preferredContactMethod:String? = null
    var preferredContactBestTime:String? = null
}

open class ContactNameData
{
    var title:String? = null
    var firstName:String? = null
    var middleName:String? = null
    var lastName:String? = null
}

open class CompanyDetails
{
    var legalName:String? = null
    var tradingName:String? = null
    var tradingAddress:AddressData? = null
    var legalAddress:AddressData? = null
    var website:String? = null
    var companyType:String? = null
    var registrationNumber:String? = null
    var merchantCategoryPseudoName:String? = null
    var vatNumber:String? = null
    var hasStartedTrading:Boolean? = null
    var startedTradingMonth:String? = null
    var startedTradingYear:String? = null
    var companyTypeOther:String? = null
    var isRegisteredCharity:Boolean? = null
    var countryOfIncorporation:String? = null
    var regionOfIncorporation:String? = null
}

open class AddressData
{
    var address1:String? = null
    var address2:String? = null
    var address3:String? = null
    var postalCode:String? = null
    var city:String? = null
    var state:String? = null
    var countryCode:String? = null
}

open class BankDetails
{
    var sortCode:String? = null
    var accountNumber:String? = null
    var bankName:String? = null
    var bankAccountName:String? = null
    var settlementCurrency:String? = null
    var swiftCode:String? = null
}

open class BusinessProfile
{
    var descriptionOfYourGoodsAndServices:String? = null
    var anticipatedAverageMonthlyTurnover:Double? = null
    var anticipatedPeakMonthlyTurnover:Double? = null
    var percentageOfPrepayments:Double? = null
    var percentageOfDeposits:Double? = null
    var percentageOfSubscriptions:Double? = null
    var daysFromOrderConfirmationToDelivery:ArrayList<DaysToDelivery> = ArrayList<DaysToDelivery>()
    var depositPaymentDetails:ArrayList<PaymentDetails> = ArrayList<PaymentDetails>()
    var averageSubscriptionLengthInMonths:Int? = null
    var averageNumberOfSubscriptionPayments:Int? = null
    var anticipatedPercentageIncreaseInTurnoverForAYear:Double? = null
    var ccTurnover:Double? = null
    var totalCardTurnover:Double? = null
    var cnpPercentage:Double? = null
    var totalTurnover:Double? = null
    var avTransValue:Double? = null
    var cnpRequired:Boolean? = null
    var cashbackRequired:Boolean? = null
    var futurePayRequired:Boolean? = null
    var newToCards:Boolean? = null
}

open class DaysToDelivery
{
    var percentageOfOrders:Double? = null
    var numberOfDays:Int? = null
}

open class PaymentDetails
{
    var percentageOfTotalTurnoverToRelatedBusiness:Double? = null
    var percentageOfTotalTurnoverTakenAsDeposit:Double? = null
    var averageDaysBetweenDepositAndFullPayment:Int? = null
    var averageDaysBetweenFullPaymentAndDelivery:Int? = null
}

open class OwnerDetails
{
    var dayOfBirth:Int? = null
    var monthOfBirth:Int? = null
    var yearOfBirth:Int? = null
    var ownershipPercentage:Double? = null
    var homeAddress:AddressData? = null
    var currentAddressLessThanThreeYears:Boolean? = null
    var previousHomeAddress:AddressData? = null
    var name:ContactNameData? = null
    var director:Boolean? = null
    var nationality:String? = null
    var position:String? = null
    var timeAtHomeAddressYears:Int? = null
    var timeAtHomeAddressMonths:Int? = null
    var PrimaryPartyID:String? = null
    var identityVerificationDocuments:ArrayList<IdentityVerificationDocuments> = ArrayList<IdentityVerificationDocuments>()
}

open class IdentityVerificationDocuments
{
    var documentId:String? = null
    var authenticity:String? = null
}

Kotlin AllChecksDataRequestRequest DTOs

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: wpcdd-featuretest-ws.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
}