CDD Engine Web Service v2.14.0.0

AllChecksOrderDataRequest

The following routes are available for this service:
POST	/allchecks/submit/order

**AllChecksOrderDataRequest** Parameters:
Name	Parameter	Data Type	Required
CorrelationId	body	string	Yes
OrderJson	body	Order	Yes
NapPartyId	body	string	No
LEID	body	string	No
OrderId	body	string	No
PartyIndividuals	body	List<string>	No
IdentityVerificationDocuments	body	List<IdentityVerificationDocuments>	No

**Order** Parameters:
Name	Parameter	Data Type	Required	Description
Meta	form	OrderMeta	No
Payload	form	OrderPayload	No

**OrderMeta** Parameters:
Name	Parameter	Data Type	Required
SourceSystem	form	string	No
SourceSystemIdentifier	form	string	No
Csr	form	string	No
UltimateParentId	form	string	No
OrderType	form	string	No
CustomerType	form	string	No
Partner	form	Partner	No
SellerCode	form	string	No
SellerEmail	form	string	No
SpecialInstructions	form	string	No
Contact	form	AuthorisedSigner	No
OfferDetails	form	string	No
DateContractAccepted	form	DateTime	No
WorldpayBusinessFinanceInterest	form	bool?	No
Sar	form	bool?	No
HasSupportingFiles	form	bool	No

**Partner** Parameters:
Name	Parameter	Data Type	Required	Description
PartnerName	form	string	No
PartnerId	form	string	No

**AuthorisedSigner** Parameters:
Name	Parameter	Data Type	Required	Description
DateOfBirth	form	DateTime?	No
CountryCode	form	string	No

**Contact** Parameters:
Name	Parameter	Data Type	Required
IdpGuid	form	Guid?	No
TelephoneNumber	form	string	No
AltTelephoneNumber	form	string	No
Email	form	string	No
Position	form	string	No
PreferredContactMethod	form	string	No
PreferredContactBestTime	form	string	No

**Person** Parameters:
Name	Parameter	Data Type	Required
Title	form	string	No
FirstName	form	string	No
MiddleName	form	string	No
LastName	form	string	No

**OrderPayload** Parameters:
Name	Parameter	Data Type	Required
PartyId	form	string	No
ParentPartyId	form	string	No
LegalName	form	string	No
TradingName	form	string	No
PartyName	form	string	No
Addresses	form	IEnumerable<MerchantAddress>	No
TradingContact	form	Contact	No
InvoiceContact	form	InvoiceContact	No
SettlementBankAccount	form	BankAccount	No
ChargesBankAccount	form	BankAccount	No
DirectDebitCorrespondenceEmail	form	string	No
WebsiteAddress	form	string	No
CompanyType	form	string	No
CompanyTypeOther	form	string	No
CompanyRegistrationNumber	form	string	No
CharityNumber	form	string	No
MerchantCategories	form	IEnumerable<MerchantCategory>	No
VatNumber	form	string	No
DateStartedTrading	form	DateTime?	No
AnticipatedGoLiveDate	form	DateTime?	No
CountryOfIncorporation	form	string	No
RegionOfIncorporation	form	string	No
Financials	form	Financials	No
NewToCards	form	bool?	No
TradeAssociation	form	TradeAssociation	No
Principals	form	IEnumerable<Principal>	No
GoodsAndServices	form	GoodsAndServices	No
AccessibilityOptions	form	AccessibilityOptions	No
ClearingDetails	form	ClearingDetails	No
Acquiring	form	Acquiring	No
Subscriptions	form	IEnumerable<Subscription>	No
Children	form	IEnumerable<OrderPayload>	No

**MerchantAddress** Parameters:
Name	Parameter	Data Type	Required	Description
AddressType	form	string	No
IsCommercial	form	bool	No

**Address** Parameters:
Name	Parameter	Data Type	Required
Address1	form	string	No
Address2	form	string	No
Address3	form	string	No
Postcode	form	string	No
City	form	string	No
State	form	string	No
CountryCode	form	string	No

**InvoiceContact** Parameters:
Name	Parameter	Data Type	Required	Description
Email	form	string	No
Position	form	string	No

**BankAccount** Parameters:
Name	Parameter	Data Type	Required
SortCode	form	string	No
AccountNumber	form	string	No
BankName	form	string	No
BankAccountName	form	string	No
SwiftCode	form	string	No
InternationalBankAccountNumber	form	string	No

**MerchantCategory** Parameters:
Name	Parameter	Data Type	Required
MerchantCategoryCode	form	string	No
MerchantCategoryDescription	form	string	No
DescriptionOfGoodsAndServices	form	string	No

**Financials** Parameters:
Name	Parameter	Data Type	Required
Annual	form	decimal	No
CardPercentage	form	decimal	No
CreditCardPercentage	form	decimal	No
AverageTransactionValue	form	decimal	No
CardNotPresentPercentage	form	decimal?	No

**TradeAssociation** Parameters:
Name	Parameter	Data Type	Required	Description
GroupName	form	string	No
MemberNumber	form	string	No

**Principal** Parameters:
Name	Parameter	Data Type	Required
Title	form	string	No
FirstName	form	string	No
MiddleName	form	string	No
LastName	form	string	No
DateOfBirth	form	DateTime	No
Nationality	form	string	No
HomeAddresses	form	IEnumerable<PrincipalAddress>	No
OwnershipPercentage	form	decimal	No
Position	form	PositionType	No
IsFinancialController	form	bool?	No

**PrincipalAddress** Parameters:
Name	Parameter	Data Type	Required	Description
StartDate	form	DateTime	No
EndDate	form	DateTime?	No

**Address** Parameters:
Name	Parameter	Data Type	Required
Address1	form	string	No
Address2	form	string	No
Address3	form	string	No
Postcode	form	string	No
City	form	string	No
State	form	string	No
Countrycode	form	string	No

**PositionType** Enum:
Name	Value
SoleTrader	0
Partner	1
Director	2
CompanySecretary	3
ChiefFinancialOfficer	4
Chairman	5
DesignatedBoardMember	7
Settlor	8
Treasurer	9
Trustee	10
ChiefExecutive	11
AuthorisedPersonWithConsent	12
NonExecutiveDirector	13
ContactPerson	14
Shareholder	15

**GoodsAndServices** Parameters:
Name	Parameter	Data Type	Required
GoodsProvidedByThirdParty	form	bool?	No
Deposits	form	Deposits	No
WarrantiesAndGuarantees	form	WarrantiesAndGuarantees	No
Prepayments	form	Prepayments	No
MembershipsSubscriptionAndInsurancePremiums	form	MembershipsSubscriptionAndInsurancePremiums	No
StockHeldAtAnotherAddressLocation	form	Address	No

**Deposits** Parameters:
Name	Parameter	Data Type	Required
PerOfSalesWhereInitialDepositTaken	form	int	No
SizePerTotalValue	form	int	No
AvgTimeBeforeDeliveryDepositTaken	form	int	No
AvgTimeBeforeDeliveryBalanceTaken	form	int	No

**WarrantiesAndGuarantees** Parameters:
Name	Parameter	Data Type	Required
PercCardTurnover	form	int	No
AvgLengthInMonths	form	int	No
PercGoodsReturned	form	int	No
ThirdPartyProviders	form	string	No

**Prepayments** Parameters:
Name	Parameter	Data Type	Required	Description
PercGoodsWherePaymentTakenPriorToDelivery	form	int	No
AvgDaysPaymentTakenInAdvance	form	int	No

**MembershipsSubscriptionAndInsurancePremiums** Parameters:
Name	Parameter	Data Type	Required
PercCardTurnover	form	int	No
AvgLengthInMonths	form	int	No
MembershipCost	form	decimal	No

**AccessibilityOptions** Parameters:
Name	Parameter	Data Type	Required
AudiotapeRequired	form	bool?	No
LargePrintRequired	form	bool?	No
UncontractedBrailleGrade1Required	form	bool?	No
UncontractedBrailleGrade2Required	form	bool?	No
NextGenerationTextRequired	form	bool?	No

**ClearingDetails** Parameters:
Name	Parameter	Data Type	Required
MerchantUrl	form	string	No
Telephone	form	string	No
Email	form	string	No

**Acquiring** Parameters:
Name	Parameter	Data Type	Required
SettlementPeriod	form	int	No
FundingMode	form	string	No
Rates	form	Rates	No
TradingCurrencies	form	IEnumerable<TradingCurrency>	No

**Rates** Parameters:
Name	Parameter	Data Type	Required
CardCharges	form	IEnumerable<CardCharge>	No
PremiumTransactionCharges	form	IEnumerable<PremiumTransactionCharge>	No
AdditionalTariffs	form	IEnumerable<AdditionalTariff>	No

**CardCharge** Parameters:
Name	Parameter	Data Type	Required
CardType	form	CardType	No
Purchase	form	RateChargePair	No
Refund	form	RateChargePair	No

**CardType** Enum:
VisaDebit
VisaCredit
VisaCommercial
MastercardDebit
MastercardCredit
MastercardCommercial
MastercardWorldSignia
JcbCredit
JcbDebit
JcbCommercial
DinersDiscoverCredit
DinersDiscoverDebit
DinersDiscoverCommercial
Amex
ChinaUnionPayCredit
ChinaUnionPayDebit
ChinaUnionPayCommercial
VisaBusinessDebit
MastercardBusiness

**RateChargePair** Parameters:
Name	Parameter	Data Type	Required	Description
Percent	form	decimal?	No
Cost	form	decimal?	No

**PremiumTransactionCharge** Parameters:
Name	Parameter	Data Type	Required
Type	form	PremiumTransactionChargeType	No
CreditCard	form	RateChargePair	No
DebitCard	form	RateChargePair	No

**PremiumTransactionChargeType** Enum:
Magstripe
CnpMoto
Paper
PanKeyEntry
SecureEcom
NonSecureEcom
InterRegional
IntraRegional
NonAuth

**AdditionalTariff** Parameters:
Name	Parameter	Data Type	Required	Description
Type	form	string	No
Cost	form	decimal	No

**TradingCurrency** Parameters:
Name	Parameter	Data Type	Required
TransactionCurrencies	form	IEnumerable<CurrencyCodeType>	No
SettlementCurrency	form	CurrencyCodeType	No
SettlementBankSwift	form	string	No
SettlementBankIban	form	string	No

**CurrencyCodeType** Enum:
GBP
EUR
USD
AED
AFN
ALL
AMD
ANG
AOA
ARS
AUD
AWG
AZN
BAM
BBD
BDT
BGN
BHD
BIF
BMD
BND
BOB
BRL
BSD
BTN
BWP
BYR
BZD
CAD
CDF
CHF
CLP
CNY
COP
COU
CRC
CUC
CUP
CVE
CZK
DJF
DKK
DOP
DZD
EEK
EGP
ERN
ETB
FJD
FKP
GEL
GHS
GIP
GMD
GNF
GTQ
GYD
HKD
HNL
HRK
HTG
HUF
IDR
ILS
INR
IQD
IRR
ISK
JMD
JOD
JPY
KES
KGS
KHR
KMF
KPW
KRW
KWD
KYD
KZT
LAK
LBP
LKR
LRD
LSL
LTL
LVL
LYD
MAD
MDL
MGA
MKD
MMK
MNT
MOP
MRO
MUR
MVR
MWK
MXN
MYR
MZN
NAD
NGN
NIO
NOK
NPR
NZD
OMR
PAB
PEN
PGK
PHP
PKR
PLN
PYG
QAR
RON
RSD
RUB
RWF
SAR
SBD
SCR
SDG
SEK
SGD
SHP
SLL
SOS
SRD
STD
SYP
SZL
THB
TJS
TMT
TND
TOP
TRY
TTD
TWD
TZS
UAH
UGX
UYU
UZS
VEF
VND
VUV
WST
YER
ZAR
ZMK
ZWL

**Subscription** Parameters:
Name	Parameter	Data Type	Required
Proposition	form	string	No
PricingPackage	form	string	No
Term	form	int?	No
RenewalLength	form	int?	No
Acquiring	form	Acquiring	No
Products	form	IEnumerable<Product>	No

**Product** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
Type	form	string	No
Variant	form	string	No
Quantity	form	int?	No
RelatedFees	form	IEnumerable<ProductFee>	No
Options	form	IEnumerable<ProductOption>	No

**ProductFee** Parameters:
Name	Parameter	Data Type	Required	Description
Type	form	ProductFeeType	No
Cost	form	decimal	No

**ProductFeeType** Enum:
HireCost
TransactionCost
ServiceFee
ManagedServiceSetup
ManagedServiceMonthly

**ProductOption** Parameters:
Name	Parameter	Data Type	Required	Description
Type	form	string	No
Value	form	string	No

**IdentityVerificationDocuments** Parameters:
Name	Parameter	Data Type	Required	Description
documentId	form	string	No
authenticity	form	string	No

**StandardOrderResponse** Parameters:
Name	Parameter	Data Type	Required
Status	form	int	No
CorrelationId	form	string	No
Message	form	string	No

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/order HTTP/1.1 
Host: wpcdd-featuretest-ws.worldpay.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"CorrelationId":"String","OrderJson":{"Meta":{"SourceSystem":"String","SourceSystemIdentifier":"String","Csr":"String","UltimateParentId":"String","OrderType":"String","CustomerType":"String","Partner":{"PartnerName":"String","PartnerId":"String"},"SellerCode":"String","SellerEmail":"String","SpecialInstructions":"String","Contact":{"DateOfBirth":"\/Date(-62135596800000-0000)\/","CountryCode":"String","IdpGuid":"00000000000000000000000000000000","TelephoneNumber":"String","AltTelephoneNumber":"String","Email":"String","Position":"String","PreferredContactMethod":"String","PreferredContactBestTime":"String","Title":"String","FirstName":"String","MiddleName":"String","LastName":"String"},"OfferDetails":"String","DateContractAccepted":"\/Date(-62135596800000-0000)\/","WorldpayBusinessFinanceInterest":false,"Sar":false,"HasSupportingFiles":false},"Payload":{"PartyId":"String","ParentPartyId":"String","LegalName":"String","TradingName":"String","PartyName":"String","TradingContact":{"IdpGuid":"00000000000000000000000000000000","TelephoneNumber":"String","AltTelephoneNumber":"String","Email":"String","Position":"String","PreferredContactMethod":"String","PreferredContactBestTime":"String","Title":"String","FirstName":"String","MiddleName":"String","LastName":"String"},"InvoiceContact":{"Email":"String","Position":"String","Title":"String","FirstName":"String","MiddleName":"String","LastName":"String"},"SettlementBankAccount":{"SortCode":"String","AccountNumber":"String","BankName":"String","BankAccountName":"String","SwiftCode":"String","InternationalBankAccountNumber":"String"},"ChargesBankAccount":{"SortCode":"String","AccountNumber":"String","BankName":"String","BankAccountName":"String","SwiftCode":"String","InternationalBankAccountNumber":"String"},"DirectDebitCorrespondenceEmail":"String","WebsiteAddress":"String","CompanyType":"String","CompanyTypeOther":"String","CompanyRegistrationNumber":"String","CharityNumber":"String","VatNumber":"String","DateStartedTrading":"\/Date(-62135596800000-0000)\/","AnticipatedGoLiveDate":"\/Date(-62135596800000-0000)\/","CountryOfIncorporation":"String","RegionOfIncorporation":"String","Financials":{"Annual":0,"CardPercentage":0,"CreditCardPercentage":0,"AverageTransactionValue":0,"CardNotPresentPercentage":0},"NewToCards":false,"TradeAssociation":{"GroupName":"String","MemberNumber":"String"},"GoodsAndServices":{"GoodsProvidedByThirdParty":false,"Deposits":{"PerOfSalesWhereInitialDepositTaken":0,"SizePerTotalValue":0,"AvgTimeBeforeDeliveryDepositTaken":0,"AvgTimeBeforeDeliveryBalanceTaken":0},"WarrantiesAndGuarantees":{"PercCardTurnover":0,"AvgLengthInMonths":0,"PercGoodsReturned":0,"ThirdPartyProviders":"String"},"Prepayments":{"PercGoodsWherePaymentTakenPriorToDelivery":0,"AvgDaysPaymentTakenInAdvance":0},"MembershipsSubscriptionAndInsurancePremiums":{"PercCardTurnover":0,"AvgLengthInMonths":0,"MembershipCost":0},"StockHeldAtAnotherAddressLocation":{"Address1":"String","Address2":"String","Address3":"String","Postcode":"String","City":"String","State":"String","CountryCode":"String"}},"AccessibilityOptions":{"AudiotapeRequired":false,"LargePrintRequired":false,"UncontractedBrailleGrade1Required":false,"UncontractedBrailleGrade2Required":false,"NextGenerationTextRequired":false},"ClearingDetails":{"MerchantUrl":"String","Telephone":"String","Email":"String"},"Acquiring":{"SettlementPeriod":0,"FundingMode":"String","Rates":{}}}},"NapPartyId":"String","LEID":"String","OrderId":"String","PartyIndividuals":["String"],"IdentityVerificationDocuments":[{"documentId":"String","authenticity":"String"}]}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Status":0,"CorrelationId":"String","Message":"String"}

GBP
EUR
USD
AED
AFN
ALL
AMD
ANG
AOA
ARS
AUD
AWG
AZN
BAM
BBD
BDT
BGN
BHD
BIF
BMD
BND
BOB
BRL
BSD
BTN
BWP
BYR
BZD
CAD
CDF
CHF
CLP
CNY
COP
COU
CRC
CUC
CUP
CVE
CZK
DJF
DKK
DOP
DZD
EEK
EGP
ERN
ETB
FJD
FKP
GEL
GHS
GIP
GMD
GNF
GTQ
GYD
HKD
HNL
HRK
HTG
HUF
IDR
ILS
INR
IQD
IRR
ISK
JMD
JOD
JPY
KES
KGS
KHR
KMF
KPW
KRW
KWD
KYD
KZT
LAK
LBP
LKR
LRD
LSL
LTL
LVL
LYD
MAD
MDL
MGA
MKD
MMK
MNT
MOP
MRO
MUR
MVR
MWK
MXN
MYR
MZN
NAD
NGN
NIO
NOK
NPR
NZD
OMR
PAB
PEN
PGK
PHP
PKR
PLN
PYG
QAR
RON
RSD
RUB
RWF
SAR
SBD
SCR
SDG
SEK
SGD
SHP
SLL
SOS
SRD
STD
SYP
SZL
THB
TJS
TMT
TND
TOP
TRY
TTD
TWD
TZS
UAH
UGX
UYU
UZS
VEF
VND
VUV
WST
YER
ZAR
ZMK
ZWL

GBP
EUR
USD
AED
AFN
ALL
AMD
ANG
AOA
ARS
AUD
AWG
AZN
BAM
BBD
BDT
BGN
BHD
BIF
BMD
BND
BOB
BRL
BSD
BTN
BWP
BYR
BZD
CAD
CDF
CHF
CLP
CNY
COP
COU
CRC
CUC
CUP
CVE
CZK
DJF
DKK
DOP
DZD
EEK
EGP
ERN
ETB
FJD
FKP
GEL
GHS
GIP
GMD
GNF
GTQ
GYD
HKD
HNL
HRK
HTG
HUF
IDR
ILS
INR
IQD
IRR
ISK
JMD
JOD
JPY
KES
KGS
KHR
KMF
KPW
KRW
KWD
KYD
KZT
LAK
LBP
LKR
LRD
LSL
LTL
LVL
LYD
MAD
MDL
MGA
MKD
MMK
MNT
MOP
MRO
MUR
MVR
MWK
MXN
MYR
MZN
NAD
NGN
NIO
NOK
NPR
NZD
OMR
PAB
PEN
PGK
PHP
PKR
PLN
PYG
QAR
RON
RSD
RUB
RWF
SAR
SBD
SCR
SDG
SEK
SGD
SHP
SLL
SOS
SRD
STD
SYP
SZL
THB
TJS
TMT
TND
TOP
TRY
TTD
TWD
TZS
UAH
UGX
UYU
UZS
VEF
VND
VUV
WST
YER
ZAR
ZMK
ZWL

GBP
EUR
USD
AED
AFN
ALL
AMD
ANG
AOA
ARS
AUD
AWG
AZN
BAM
BBD
BDT
BGN
BHD
BIF
BMD
BND
BOB
BRL
BSD
BTN
BWP
BYR
BZD
CAD
CDF
CHF
CLP
CNY
COP
COU
CRC
CUC
CUP
CVE
CZK
DJF
DKK
DOP
DZD
EEK
EGP
ERN
ETB
FJD
FKP
GEL
GHS
GIP
GMD
GNF
GTQ
GYD
HKD
HNL
HRK
HTG
HUF
IDR
ILS
INR
IQD
IRR
ISK
JMD
JOD
JPY
KES
KGS
KHR
KMF
KPW
KRW
KWD
KYD
KZT
LAK
LBP
LKR
LRD
LSL
LTL
LVL
LYD
MAD
MDL
MGA
MKD
MMK
MNT
MOP
MRO
MUR
MVR
MWK
MXN
MYR
MZN
NAD
NGN
NIO
NOK
NPR
NZD
OMR
PAB
PEN
PGK
PHP
PKR
PLN
PYG
QAR
RON
RSD
RUB
RWF
SAR
SBD
SCR
SDG
SEK
SGD
SHP
SLL
SOS
SRD
STD
SYP
SZL
THB
TJS
TMT
TND
TOP
TRY
TTD
TWD
TZS
UAH
UGX
UYU
UZS
VEF
VND
VUV
WST
YER
ZAR
ZMK
ZWL