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
namespace CDD_Engine_DLL.DataObjects

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ApplicationDetails() = 
        member val specialInstructions:String = null with get,set
        member val typeAcquiring:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val typePOS_F2F:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val typePOS_MOTO:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val typeOnlinePayments:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val typeVirtualTerminal:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val sellerCode:String = null with get,set
        member val numOutlets:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val mccCode:String = null with get,set
        member val offerDescription:String = null with get,set
        member val pricingPackage:String = null with get,set
        member val contractLength:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val settlementPeriodTPlus:String = null with get,set
        member val ecomPSP:String = null with get,set
        member val posPSP:String = null with get,set

    [<AllowNullLiteral>]
    type ContactNameData() = 
        member val title:String = null with get,set
        member val firstName:String = null with get,set
        member val middleName:String = null with get,set
        member val lastName:String = null with get,set

    [<AllowNullLiteral>]
    type ContactDetails() = 
        member val name:ContactNameData = null with get,set
        member val phone:String = null with get,set
        member val email:String = null with get,set
        member val position:String = null with get,set
        member val altPhone:String = null with get,set
        member val preferredContactMethod:String = null with get,set
        member val preferredContactBestTime:String = null with get,set

    [<AllowNullLiteral>]
    type AddressData() = 
        member val address1:String = null with get,set
        member val address2:String = null with get,set
        member val address3:String = null with get,set
        member val postalCode:String = null with get,set
        member val city:String = null with get,set
        member val state:String = null with get,set
        member val countryCode:String = null with get,set

    [<AllowNullLiteral>]
    type CompanyDetails() = 
        member val legalName:String = null with get,set
        member val tradingName:String = null with get,set
        member val tradingAddress:AddressData = null with get,set
        member val legalAddress:AddressData = null with get,set
        member val website:String = null with get,set
        member val companyType:String = null with get,set
        member val registrationNumber:String = null with get,set
        member val merchantCategoryPseudoName:String = null with get,set
        member val vatNumber:String = null with get,set
        member val hasStartedTrading:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val startedTradingMonth:String = null with get,set
        member val startedTradingYear:String = null with get,set
        member val companyTypeOther:String = null with get,set
        member val isRegisteredCharity:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val countryOfIncorporation:String = null with get,set
        member val regionOfIncorporation:String = null with get,set

    [<AllowNullLiteral>]
    type BankDetails() = 
        member val sortCode:String = null with get,set
        member val accountNumber:String = null with get,set
        member val bankName:String = null with get,set
        member val bankAccountName:String = null with get,set
        member val settlementCurrency:String = null with get,set
        member val swiftCode:String = null with get,set

    [<AllowNullLiteral>]
    type DaysToDelivery() = 
        member val percentageOfOrders:Nullable<Double> = new Nullable<Double>() with get,set
        member val numberOfDays:Nullable<Int32> = new Nullable<Int32>() with get,set

    [<AllowNullLiteral>]
    type PaymentDetails() = 
        member val percentageOfTotalTurnoverToRelatedBusiness:Nullable<Double> = new Nullable<Double>() with get,set
        member val percentageOfTotalTurnoverTakenAsDeposit:Nullable<Double> = new Nullable<Double>() with get,set
        member val averageDaysBetweenDepositAndFullPayment:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val averageDaysBetweenFullPaymentAndDelivery:Nullable<Int32> = new Nullable<Int32>() with get,set

    [<AllowNullLiteral>]
    type BusinessProfile() = 
        member val descriptionOfYourGoodsAndServices:String = null with get,set
        member val anticipatedAverageMonthlyTurnover:Nullable<Double> = new Nullable<Double>() with get,set
        member val anticipatedPeakMonthlyTurnover:Nullable<Double> = new Nullable<Double>() with get,set
        member val percentageOfPrepayments:Nullable<Double> = new Nullable<Double>() with get,set
        member val percentageOfDeposits:Nullable<Double> = new Nullable<Double>() with get,set
        member val percentageOfSubscriptions:Nullable<Double> = new Nullable<Double>() with get,set
        member val daysFromOrderConfirmationToDelivery:ResizeArray<DaysToDelivery> = new ResizeArray<DaysToDelivery>() with get,set
        member val depositPaymentDetails:ResizeArray<PaymentDetails> = new ResizeArray<PaymentDetails>() with get,set
        member val averageSubscriptionLengthInMonths:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val averageNumberOfSubscriptionPayments:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val anticipatedPercentageIncreaseInTurnoverForAYear:Nullable<Double> = new Nullable<Double>() with get,set
        member val ccTurnover:Nullable<Double> = new Nullable<Double>() with get,set
        member val totalCardTurnover:Nullable<Double> = new Nullable<Double>() with get,set
        member val cnpPercentage:Nullable<Double> = new Nullable<Double>() with get,set
        member val totalTurnover:Nullable<Double> = new Nullable<Double>() with get,set
        member val avTransValue:Nullable<Double> = new Nullable<Double>() with get,set
        member val cnpRequired:Boolean = new Boolean() with get,set
        member val cashbackRequired:Boolean = new Boolean() with get,set
        member val futurePayRequired:Boolean = new Boolean() with get,set
        member val newToCards:Nullable<Boolean> = new Nullable<Boolean>() with get,set

    [<AllowNullLiteral>]
    type IdentityVerificationDocuments() = 
        member val documentId:String = null with get,set
        member val authenticity:String = null with get,set

    [<AllowNullLiteral>]
    type OwnerDetails() = 
        member val dayOfBirth:Int32 = new Int32() with get,set
        member val monthOfBirth:Int32 = new Int32() with get,set
        member val yearOfBirth:Int32 = new Int32() with get,set
        member val ownershipPercentage:Nullable<Double> = new Nullable<Double>() with get,set
        member val homeAddress:AddressData = null with get,set
        member val currentAddressLessThanThreeYears:Boolean = new Boolean() with get,set
        member val previousHomeAddress:AddressData = null with get,set
        member val name:ContactNameData = null with get,set
        member val director:Boolean = new Boolean() with get,set
        member val nationality:String = null with get,set
        member val position:String = null with get,set
        member val timeAtHomeAddressYears:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val timeAtHomeAddressMonths:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val PrimaryPartyID:String = null with get,set
        member val identityVerificationDocuments:ResizeArray<IdentityVerificationDocuments> = new ResizeArray<IdentityVerificationDocuments>() with get,set

    [<AllowNullLiteral>]
    type AllChecksDataRequestRequest() = 
        member val ApplicationGUID:String = null with get,set
        member val CSR:Int32 = new Int32() with get,set
        member val ApplicationDetails:ApplicationDetails = null with get,set
        member val MainBusinessRepresentative:ContactDetails = null with get,set
        member val CompanyDetail:CompanyDetails = null with get,set
        member val BankDetail:BankDetails = null with get,set
        member val BusinessProfile:BusinessProfile = null with get,set
        member val Owners:ResizeArray<OwnerDetails> = new ResizeArray<OwnerDetails>() with get,set
        member val NapPartyId:String = null with get,set

F# 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: 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
}