<back to all web services
AllChecksDataRequestRequest
The following routes are available for this service:POST | /allchecks/submit/data | | |
---|
AllChecksDataRequestRequest Parameters:Name | Parameter | Data Type | Required | Description |
---|
ApplicationGUID | body | string | Yes | |
CSR | body | int | No | |
ApplicationDetails | body | ApplicationDetails | Yes | |
MainBusinessRepresentative | body | ContactDetails | Yes | |
CompanyDetail | body | CompanyDetails | Yes | |
BankDetail | body | BankDetails | Yes | |
BusinessProfile | body | BusinessProfile | Yes | |
Owners | body | List<OwnerDetails> | Yes | |
NapPartyId | body | string | No | |
ApplicationDetails Parameters:Name | Parameter | Data Type | Required | Description |
---|
specialInstructions | form | string | No | |
typeAcquiring | form | bool? | No | |
typePOS_F2F | form | bool? | No | |
typePOS_MOTO | form | bool? | No | |
typeOnlinePayments | form | bool? | No | |
typeVirtualTerminal | form | bool? | No | |
sellerCode | form | string | No | |
numOutlets | form | int? | No | |
mccCode | form | string | No | |
offerDescription | form | string | No | |
pricingPackage | form | string | No | |
contractLength | form | int? | No | |
settlementPeriodTPlus | form | string | No | |
ecomPSP | form | string | No | |
posPSP | form | string | No | |
ContactDetails Parameters:Name | Parameter | Data Type | Required | Description |
---|
name | form | ContactNameData | No | |
phone | form | string | No | |
email | form | string | No | |
position | form | string | No | |
altPhone | form | string | No | |
preferredContactMethod | form | string | No | |
preferredContactBestTime | form | string | No | |
ContactNameData Parameters:Name | Parameter | Data Type | Required | Description |
---|
title | form | string | No | |
firstName | form | string | No | |
middleName | form | string | No | |
lastName | form | string | No | |
CompanyDetails Parameters:Name | Parameter | Data Type | Required | Description |
---|
legalName | form | string | No | |
tradingName | form | string | No | |
tradingAddress | form | AddressData | No | |
legalAddress | form | AddressData | No | |
website | form | string | No | |
companyType | form | string | No | |
registrationNumber | form | string | No | |
merchantCategoryPseudoName | form | string | No | |
vatNumber | form | string | No | |
hasStartedTrading | form | bool? | No | |
startedTradingMonth | form | string | No | |
startedTradingYear | form | string | No | |
companyTypeOther | form | string | No | |
isRegisteredCharity | form | bool? | No | |
countryOfIncorporation | form | string | No | |
regionOfIncorporation | form | string | No | |
AddressData Parameters:Name | Parameter | Data Type | Required | Description |
---|
address1 | form | string | No | |
address2 | form | string | No | |
address3 | form | string | No | |
postalCode | form | string | No | |
city | form | string | No | |
state | form | string | No | |
countryCode | form | string | No | |
BankDetails Parameters:Name | Parameter | Data Type | Required | Description |
---|
sortCode | form | string | No | |
accountNumber | form | string | No | |
bankName | form | string | No | |
bankAccountName | form | string | No | |
settlementCurrency | form | string | No | |
swiftCode | form | string | No | |
BusinessProfile Parameters:Name | Parameter | Data Type | Required | Description |
---|
descriptionOfYourGoodsAndServices | form | string | No | |
anticipatedAverageMonthlyTurnover | form | double? | No | |
anticipatedPeakMonthlyTurnover | form | double? | No | |
percentageOfPrepayments | form | double? | No | |
percentageOfDeposits | form | double? | No | |
percentageOfSubscriptions | form | double? | No | |
daysFromOrderConfirmationToDelivery | form | List<DaysToDelivery> | No | |
depositPaymentDetails | form | List<PaymentDetails> | No | |
averageSubscriptionLengthInMonths | form | int? | No | |
averageNumberOfSubscriptionPayments | form | int? | No | |
anticipatedPercentageIncreaseInTurnoverForAYear | form | double? | No | |
ccTurnover | form | double? | No | |
totalCardTurnover | form | double? | No | |
cnpPercentage | form | double? | No | |
totalTurnover | form | double? | No | |
avTransValue | form | double? | No | |
cnpRequired | form | bool | No | |
cashbackRequired | form | bool | No | |
futurePayRequired | form | bool | No | |
newToCards | form | bool? | No | |
DaysToDelivery Parameters:Name | Parameter | Data Type | Required | Description |
---|
percentageOfOrders | form | double? | No | |
numberOfDays | form | int? | No | |
PaymentDetails Parameters:Name | Parameter | Data Type | Required | Description |
---|
percentageOfTotalTurnoverToRelatedBusiness | form | double? | No | |
percentageOfTotalTurnoverTakenAsDeposit | form | double? | No | |
averageDaysBetweenDepositAndFullPayment | form | int? | No | |
averageDaysBetweenFullPaymentAndDelivery | form | int? | No | |
OwnerDetails Parameters:Name | Parameter | Data Type | Required | Description |
---|
dayOfBirth | form | int | No | |
monthOfBirth | form | int | No | |
yearOfBirth | form | int | No | |
ownershipPercentage | form | double? | No | |
homeAddress | form | AddressData | No | |
currentAddressLessThanThreeYears | form | bool | No | |
previousHomeAddress | form | AddressData | No | |
name | form | ContactNameData | No | |
director | form | bool | No | |
nationality | form | string | No | |
position | form | string | No | |
timeAtHomeAddressYears | form | int? | No | |
timeAtHomeAddressMonths | form | int? | No | |
PrimaryPartyID | form | string | No | |
identityVerificationDocuments | form | List<IdentityVerificationDocuments> | No | |
IdentityVerificationDocuments Parameters:Name | Parameter | Data Type | Required | Description |
---|
documentId | form | string | No | |
authenticity | form | string | No | |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
HTTP + XML
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: application/xml
Content-Type: application/xml
Content-Length: length
<AllChecksDataRequestRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CDD_Engine_WS.dto.Requests">
<ApplicationDetails xmlns:d2p1="http://schemas.datacontract.org/2004/07/CDD_Engine_DLL.DataObjects">
<d2p1:contractLength>0</d2p1:contractLength>
<d2p1:csr>String</d2p1:csr>
<d2p1:ecomPSP>String</d2p1:ecomPSP>
<d2p1:mccCode>String</d2p1:mccCode>
<d2p1:numOutlets>0</d2p1:numOutlets>
<d2p1:offerDescription>String</d2p1:offerDescription>
<d2p1:posPSP>String</d2p1:posPSP>
<d2p1:sellerCode>String</d2p1:sellerCode>
<d2p1:settlementPeriodTPlus>String</d2p1:settlementPeriodTPlus>
<d2p1:specialInstructions>String</d2p1:specialInstructions>
<d2p1:typeAcquiring>false</d2p1:typeAcquiring>
<d2p1:typeOnlinePayments>false</d2p1:typeOnlinePayments>
<d2p1:typePOS_F2F>false</d2p1:typePOS_F2F>
<d2p1:typePOS_MOTO>false</d2p1:typePOS_MOTO>
<d2p1:typeVirtualTerminal>false</d2p1:typeVirtualTerminal>
</ApplicationDetails>
<ApplicationGUID>String</ApplicationGUID>
<BankDetail xmlns:d2p1="http://schemas.datacontract.org/2004/07/CDD_Engine_DLL.DataObjects">
<d2p1:accountNumber>String</d2p1:accountNumber>
<d2p1:bankAccountName>String</d2p1:bankAccountName>
<d2p1:bankName>String</d2p1:bankName>
<d2p1:settlementCurrency>String</d2p1:settlementCurrency>
<d2p1:sortCode>String</d2p1:sortCode>
<d2p1:swiftCode>String</d2p1:swiftCode>
</BankDetail>
<BusinessProfile xmlns:d2p1="http://schemas.datacontract.org/2004/07/CDD_Engine_DLL.DataObjects">
<d2p1:anticipatedAverageMonthlyTurnover>0</d2p1:anticipatedAverageMonthlyTurnover>
<d2p1:anticipatedPeakMonthlyTurnover>0</d2p1:anticipatedPeakMonthlyTurnover>
<d2p1:anticipatedPercentageIncreaseInTurnoverForAYear>0</d2p1:anticipatedPercentageIncreaseInTurnoverForAYear>
<d2p1:avTransValue>0</d2p1:avTransValue>
<d2p1:averageNumberOfSubscriptionPayments>0</d2p1:averageNumberOfSubscriptionPayments>
<d2p1:averageSubscriptionLengthInMonths>0</d2p1:averageSubscriptionLengthInMonths>
<d2p1:cashbackRequired>false</d2p1:cashbackRequired>
<d2p1:ccTurnover>0</d2p1:ccTurnover>
<d2p1:cnpPercentage>0</d2p1:cnpPercentage>
<d2p1:cnpRequired>false</d2p1:cnpRequired>
<d2p1:daysFromOrderConfirmationToDelivery>
<d2p1:DaysToDelivery>
<d2p1:numberOfDays>0</d2p1:numberOfDays>
<d2p1:percentageOfOrders>0</d2p1:percentageOfOrders>
</d2p1:DaysToDelivery>
</d2p1:daysFromOrderConfirmationToDelivery>
<d2p1:depositPaymentDetails>
<d2p1:PaymentDetails>
<d2p1:averageDaysBetweenDepositAndFullPayment>0</d2p1:averageDaysBetweenDepositAndFullPayment>
<d2p1:averageDaysBetweenFullPaymentAndDelivery>0</d2p1:averageDaysBetweenFullPaymentAndDelivery>
<d2p1:percentageOfTotalTurnoverTakenAsDeposit>0</d2p1:percentageOfTotalTurnoverTakenAsDeposit>
<d2p1:percentageOfTotalTurnoverToRelatedBusiness>0</d2p1:percentageOfTotalTurnoverToRelatedBusiness>
</d2p1:PaymentDetails>
</d2p1:depositPaymentDetails>
<d2p1:descriptionOfYourGoodsAndServices>String</d2p1:descriptionOfYourGoodsAndServices>
<d2p1:futurePayRequired>false</d2p1:futurePayRequired>
<d2p1:newToCards>false</d2p1:newToCards>
<d2p1:percentageOfDeposits>0</d2p1:percentageOfDeposits>
<d2p1:percentageOfPrepayments>0</d2p1:percentageOfPrepayments>
<d2p1:percentageOfSubscriptions>0</d2p1:percentageOfSubscriptions>
<d2p1:totalCardTurnover>0</d2p1:totalCardTurnover>
<d2p1:totalTurnover>0</d2p1:totalTurnover>
</BusinessProfile>
<CSR>0</CSR>
<CompanyDetail xmlns:d2p1="http://schemas.datacontract.org/2004/07/CDD_Engine_DLL.DataObjects">
<d2p1:companyType>String</d2p1:companyType>
<d2p1:companyTypeOther>String</d2p1:companyTypeOther>
<d2p1:countryOfIncorporation>String</d2p1:countryOfIncorporation>
<d2p1:hasStartedTrading>false</d2p1:hasStartedTrading>
<d2p1:isRegisteredCharity>false</d2p1:isRegisteredCharity>
<d2p1:legalAddress>
<d2p1:address1>String</d2p1:address1>
<d2p1:address2>String</d2p1:address2>
<d2p1:address3>String</d2p1:address3>
<d2p1:city>String</d2p1:city>
<d2p1:countryCode>String</d2p1:countryCode>
<d2p1:postalCode>String</d2p1:postalCode>
<d2p1:state>String</d2p1:state>
</d2p1:legalAddress>
<d2p1:legalName>String</d2p1:legalName>
<d2p1:merchantCategoryPseudoName>String</d2p1:merchantCategoryPseudoName>
<d2p1:regionOfIncorporation>String</d2p1:regionOfIncorporation>
<d2p1:registrationNumber>String</d2p1:registrationNumber>
<d2p1:startedTradingMonth>String</d2p1:startedTradingMonth>
<d2p1:startedTradingYear>String</d2p1:startedTradingYear>
<d2p1:tradingAddress>
<d2p1:address1>String</d2p1:address1>
<d2p1:address2>String</d2p1:address2>
<d2p1:address3>String</d2p1:address3>
<d2p1:city>String</d2p1:city>
<d2p1:countryCode>String</d2p1:countryCode>
<d2p1:postalCode>String</d2p1:postalCode>
<d2p1:state>String</d2p1:state>
</d2p1:tradingAddress>
<d2p1:tradingName>String</d2p1:tradingName>
<d2p1:vatNumber>String</d2p1:vatNumber>
<d2p1:website>String</d2p1:website>
</CompanyDetail>
<MainBusinessRepresentative xmlns:d2p1="http://schemas.datacontract.org/2004/07/CDD_Engine_DLL.DataObjects">
<d2p1:altPhone>String</d2p1:altPhone>
<d2p1:email>String</d2p1:email>
<d2p1:name>
<d2p1:firstName>String</d2p1:firstName>
<d2p1:lastName>String</d2p1:lastName>
<d2p1:middleName>String</d2p1:middleName>
<d2p1:title>String</d2p1:title>
</d2p1:name>
<d2p1:phone>String</d2p1:phone>
<d2p1:position>String</d2p1:position>
<d2p1:preferredContactBestTime>String</d2p1:preferredContactBestTime>
<d2p1:preferredContactMethod>String</d2p1:preferredContactMethod>
</MainBusinessRepresentative>
<NapPartyId>String</NapPartyId>
<Owners xmlns:d2p1="http://schemas.datacontract.org/2004/07/CDD_Engine_DLL.DataObjects">
<d2p1:OwnerDetails>
<d2p1:PrimaryPartyID>String</d2p1:PrimaryPartyID>
<d2p1:currentAddressLessThanThreeYears>false</d2p1:currentAddressLessThanThreeYears>
<d2p1:dayOfBirth>0</d2p1:dayOfBirth>
<d2p1:director>false</d2p1:director>
<d2p1:homeAddress>
<d2p1:address1>String</d2p1:address1>
<d2p1:address2>String</d2p1:address2>
<d2p1:address3>String</d2p1:address3>
<d2p1:city>String</d2p1:city>
<d2p1:countryCode>String</d2p1:countryCode>
<d2p1:postalCode>String</d2p1:postalCode>
<d2p1:state>String</d2p1:state>
</d2p1:homeAddress>
<d2p1:identityVerificationDocuments>
<d2p1:IdentityVerificationDocuments>
<d2p1:authenticity>String</d2p1:authenticity>
<d2p1:documentId>String</d2p1:documentId>
</d2p1:IdentityVerificationDocuments>
</d2p1:identityVerificationDocuments>
<d2p1:monthOfBirth>0</d2p1:monthOfBirth>
<d2p1:name>
<d2p1:firstName>String</d2p1:firstName>
<d2p1:lastName>String</d2p1:lastName>
<d2p1:middleName>String</d2p1:middleName>
<d2p1:title>String</d2p1:title>
</d2p1:name>
<d2p1:nationality>String</d2p1:nationality>
<d2p1:ownershipPercentage>0</d2p1:ownershipPercentage>
<d2p1:position>String</d2p1:position>
<d2p1:previousHomeAddress>
<d2p1:address1>String</d2p1:address1>
<d2p1:address2>String</d2p1:address2>
<d2p1:address3>String</d2p1:address3>
<d2p1:city>String</d2p1:city>
<d2p1:countryCode>String</d2p1:countryCode>
<d2p1:postalCode>String</d2p1:postalCode>
<d2p1:state>String</d2p1:state>
</d2p1:previousHomeAddress>
<d2p1:timeAtHomeAddressMonths>0</d2p1:timeAtHomeAddressMonths>
<d2p1:timeAtHomeAddressYears>0</d2p1:timeAtHomeAddressYears>
<d2p1:yearOfBirth>0</d2p1:yearOfBirth>
</d2p1:OwnerDetails>
</Owners>
</AllChecksDataRequestRequest>