| POST | /allchecks/submit/data |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ApplicationDetails:
special_instructions: Optional[str] = None
type_acquiring: Optional[bool] = None
type_p_o_s__f2_f: Optional[bool] = None
type_p_o_s__m_o_t_o: Optional[bool] = None
type_online_payments: Optional[bool] = None
type_virtual_terminal: Optional[bool] = None
seller_code: Optional[str] = None
num_outlets: Optional[int] = None
mcc_code: Optional[str] = None
offer_description: Optional[str] = None
pricing_package: Optional[str] = None
contract_length: Optional[int] = None
settlement_period_t_plus: Optional[str] = None
ecom_p_s_p: Optional[str] = None
pos_p_s_p: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContactNameData:
title: Optional[str] = None
first_name: Optional[str] = None
middle_name: Optional[str] = None
last_name: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContactDetails:
name: Optional[ContactNameData] = None
phone: Optional[str] = None
email: Optional[str] = None
position: Optional[str] = None
alt_phone: Optional[str] = None
preferred_contact_method: Optional[str] = None
preferred_contact_best_time: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AddressData:
address1: Optional[str] = None
address2: Optional[str] = None
address3: Optional[str] = None
postal_code: Optional[str] = None
city: Optional[str] = None
state: Optional[str] = None
country_code: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CompanyDetails:
legal_name: Optional[str] = None
trading_name: Optional[str] = None
trading_address: Optional[AddressData] = None
legal_address: Optional[AddressData] = None
website: Optional[str] = None
company_type: Optional[str] = None
registration_number: Optional[str] = None
merchant_category_pseudo_name: Optional[str] = None
vat_number: Optional[str] = None
has_started_trading: Optional[bool] = None
started_trading_month: Optional[str] = None
started_trading_year: Optional[str] = None
company_type_other: Optional[str] = None
is_registered_charity: Optional[bool] = None
country_of_incorporation: Optional[str] = None
region_of_incorporation: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BankDetails:
sort_code: Optional[str] = None
account_number: Optional[str] = None
bank_name: Optional[str] = None
bank_account_name: Optional[str] = None
settlement_currency: Optional[str] = None
swift_code: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DaysToDelivery:
percentage_of_orders: Optional[float] = None
number_of_days: Optional[int] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PaymentDetails:
percentage_of_total_turnover_to_related_business: Optional[float] = None
percentage_of_total_turnover_taken_as_deposit: Optional[float] = None
average_days_between_deposit_and_full_payment: Optional[int] = None
average_days_between_full_payment_and_delivery: Optional[int] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BusinessProfile:
description_of_your_goods_and_services: Optional[str] = None
anticipated_average_monthly_turnover: Optional[float] = None
anticipated_peak_monthly_turnover: Optional[float] = None
percentage_of_prepayments: Optional[float] = None
percentage_of_deposits: Optional[float] = None
percentage_of_subscriptions: Optional[float] = None
days_from_order_confirmation_to_delivery: Optional[List[DaysToDelivery]] = None
deposit_payment_details: Optional[List[PaymentDetails]] = None
average_subscription_length_in_months: Optional[int] = None
average_number_of_subscription_payments: Optional[int] = None
anticipated_percentage_increase_in_turnover_for_a_year: Optional[float] = None
cc_turnover: Optional[float] = None
total_card_turnover: Optional[float] = None
cnp_percentage: Optional[float] = None
total_turnover: Optional[float] = None
av_trans_value: Optional[float] = None
cnp_required: Optional[bool] = None
cashback_required: Optional[bool] = None
future_pay_required: Optional[bool] = None
new_to_cards: Optional[bool] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class IdentityVerificationDocuments:
document_id: Optional[str] = None
authenticity: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OwnerDetails:
day_of_birth: Optional[int] = None
month_of_birth: Optional[int] = None
year_of_birth: Optional[int] = None
ownership_percentage: Optional[float] = None
home_address: Optional[AddressData] = None
current_address_less_than_three_years: Optional[bool] = None
previous_home_address: Optional[AddressData] = None
name: Optional[ContactNameData] = None
director: Optional[bool] = None
nationality: Optional[str] = None
position: Optional[str] = None
time_at_home_address_years: Optional[int] = None
time_at_home_address_months: Optional[int] = None
primary_party_i_d: Optional[str] = None
identity_verification_documents: Optional[List[IdentityVerificationDocuments]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AllChecksDataRequestRequest:
application_g_u_i_d: Optional[str] = None
csr: Optional[int] = None
application_details: Optional[ApplicationDetails] = None
main_business_representative: Optional[ContactDetails] = None
company_detail: Optional[CompanyDetails] = None
bank_detail: Optional[BankDetails] = None
business_profile: Optional[BusinessProfile] = None
owners: Optional[List[OwnerDetails]] = None
nap_party_id: Optional[str] = None
Python AllChecksDataRequestRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>