| 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 .csv suffix or ?format=csv
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/csv
Content-Type: text/csv
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"}