CDD Engine Web Service v2.14.0.0

<back to all web services

AllChecksOrderDataRequest

Requires Authentication
The following routes are available for this service:
POST/allchecks/submit/order
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class AllChecksOrderDataRequest
    {
        public String CorrelationId = null;
        public Order OrderJson = null;
        public String NapPartyId = null;
        public String LEID = null;
        public String OrderId = null;
        public ArrayList<String> PartyIndividuals = null;
        public ArrayList<IdentityVerificationDocuments> IdentityVerificationDocuments = null;
        
        public String getCorrelationId() { return CorrelationId; }
        public AllChecksOrderDataRequest setCorrelationId(String value) { this.CorrelationId = value; return this; }
        public Order getOrderJson() { return OrderJson; }
        public AllChecksOrderDataRequest setOrderJson(Order value) { this.OrderJson = value; return this; }
        public String getNapPartyId() { return NapPartyId; }
        public AllChecksOrderDataRequest setNapPartyId(String value) { this.NapPartyId = value; return this; }
        public String getLeid() { return LEID; }
        public AllChecksOrderDataRequest setLeid(String value) { this.LEID = value; return this; }
        public String getOrderId() { return OrderId; }
        public AllChecksOrderDataRequest setOrderId(String value) { this.OrderId = value; return this; }
        public ArrayList<String> getPartyIndividuals() { return PartyIndividuals; }
        public AllChecksOrderDataRequest setPartyIndividuals(ArrayList<String> value) { this.PartyIndividuals = value; return this; }
        public ArrayList<IdentityVerificationDocuments> getIdentityVerificationDocuments() { return IdentityVerificationDocuments; }
        public AllChecksOrderDataRequest setIdentityVerificationDocuments(ArrayList<IdentityVerificationDocuments> value) { this.IdentityVerificationDocuments = value; return this; }
    }

    public static class Order
    {
        public OrderMeta Meta = null;
        public OrderPayload Payload = null;
        
        public OrderMeta getMeta() { return Meta; }
        public Order setMeta(OrderMeta value) { this.Meta = value; return this; }
        public OrderPayload getPayload() { return Payload; }
        public Order setPayload(OrderPayload value) { this.Payload = value; return this; }
    }

    public static class OrderMeta
    {
        public String SourceSystem = null;
        public String SourceSystemIdentifier = null;
        public String Csr = null;
        public String UltimateParentId = null;
        public String OrderType = null;
        public String CustomerType = null;
        public Partner Partner = null;
        public String SellerCode = null;
        public String SellerEmail = null;
        public String SpecialInstructions = null;
        public AuthorisedSigner Contact = null;
        public String OfferDetails = null;
        public Date DateContractAccepted = null;
        public Boolean WorldpayBusinessFinanceInterest = null;
        public Boolean Sar = null;
        public Boolean HasSupportingFiles = null;
        
        public String getSourceSystem() { return SourceSystem; }
        public OrderMeta setSourceSystem(String value) { this.SourceSystem = value; return this; }
        public String getSourceSystemIdentifier() { return SourceSystemIdentifier; }
        public OrderMeta setSourceSystemIdentifier(String value) { this.SourceSystemIdentifier = value; return this; }
        public String getCsr() { return Csr; }
        public OrderMeta setCsr(String value) { this.Csr = value; return this; }
        public String getUltimateParentId() { return UltimateParentId; }
        public OrderMeta setUltimateParentId(String value) { this.UltimateParentId = value; return this; }
        public String getOrderType() { return OrderType; }
        public OrderMeta setOrderType(String value) { this.OrderType = value; return this; }
        public String getCustomerType() { return CustomerType; }
        public OrderMeta setCustomerType(String value) { this.CustomerType = value; return this; }
        public Partner getPartner() { return Partner; }
        public OrderMeta setPartner(Partner value) { this.Partner = value; return this; }
        public String getSellerCode() { return SellerCode; }
        public OrderMeta setSellerCode(String value) { this.SellerCode = value; return this; }
        public String getSellerEmail() { return SellerEmail; }
        public OrderMeta setSellerEmail(String value) { this.SellerEmail = value; return this; }
        public String getSpecialInstructions() { return SpecialInstructions; }
        public OrderMeta setSpecialInstructions(String value) { this.SpecialInstructions = value; return this; }
        public AuthorisedSigner getContact() { return Contact; }
        public OrderMeta setContact(AuthorisedSigner value) { this.Contact = value; return this; }
        public String getOfferDetails() { return OfferDetails; }
        public OrderMeta setOfferDetails(String value) { this.OfferDetails = value; return this; }
        public Date getDateContractAccepted() { return DateContractAccepted; }
        public OrderMeta setDateContractAccepted(Date value) { this.DateContractAccepted = value; return this; }
        public Boolean isWorldpayBusinessFinanceInterest() { return WorldpayBusinessFinanceInterest; }
        public OrderMeta setWorldpayBusinessFinanceInterest(Boolean value) { this.WorldpayBusinessFinanceInterest = value; return this; }
        public Boolean isSar() { return Sar; }
        public OrderMeta setSar(Boolean value) { this.Sar = value; return this; }
        public Boolean isHasSupportingFiles() { return HasSupportingFiles; }
        public OrderMeta setHasSupportingFiles(Boolean value) { this.HasSupportingFiles = value; return this; }
    }

    public static class Partner
    {
        public String PartnerName = null;
        public String PartnerId = null;
        
        public String getPartnerName() { return PartnerName; }
        public Partner setPartnerName(String value) { this.PartnerName = value; return this; }
        public String getPartnerId() { return PartnerId; }
        public Partner setPartnerId(String value) { this.PartnerId = value; return this; }
    }

    public static class AuthorisedSigner extends Contact
    {
        public Date DateOfBirth = null;
        public String CountryCode = null;
        
        public Date getDateOfBirth() { return DateOfBirth; }
        public AuthorisedSigner setDateOfBirth(Date value) { this.DateOfBirth = value; return this; }
        public String getCountryCode() { return CountryCode; }
        public AuthorisedSigner setCountryCode(String value) { this.CountryCode = value; return this; }
    }

    public static class Contact extends Person
    {
        public UUID IdpGuid = null;
        public String TelephoneNumber = null;
        public String AltTelephoneNumber = null;
        public String Email = null;
        public String Position = null;
        public String PreferredContactMethod = null;
        public String PreferredContactBestTime = null;
        
        public UUID getIdpGuid() { return IdpGuid; }
        public Contact setIdpGuid(UUID value) { this.IdpGuid = value; return this; }
        public String getTelephoneNumber() { return TelephoneNumber; }
        public Contact setTelephoneNumber(String value) { this.TelephoneNumber = value; return this; }
        public String getAltTelephoneNumber() { return AltTelephoneNumber; }
        public Contact setAltTelephoneNumber(String value) { this.AltTelephoneNumber = value; return this; }
        public String getEmail() { return Email; }
        public Contact setEmail(String value) { this.Email = value; return this; }
        public String getPosition() { return Position; }
        public Contact setPosition(String value) { this.Position = value; return this; }
        public String getPreferredContactMethod() { return PreferredContactMethod; }
        public Contact setPreferredContactMethod(String value) { this.PreferredContactMethod = value; return this; }
        public String getPreferredContactBestTime() { return PreferredContactBestTime; }
        public Contact setPreferredContactBestTime(String value) { this.PreferredContactBestTime = value; return this; }
    }

    public static class Person
    {
        public String Title = null;
        public String FirstName = null;
        public String MiddleName = null;
        public String LastName = null;
        
        public String getTitle() { return Title; }
        public Person setTitle(String value) { this.Title = value; return this; }
        public String getFirstName() { return FirstName; }
        public Person setFirstName(String value) { this.FirstName = value; return this; }
        public String getMiddleName() { return MiddleName; }
        public Person setMiddleName(String value) { this.MiddleName = value; return this; }
        public String getLastName() { return LastName; }
        public Person setLastName(String value) { this.LastName = value; return this; }
    }

    public static class OrderPayload
    {
        public String PartyId = null;
        public String ParentPartyId = null;
        public String LegalName = null;
        public String TradingName = null;
        public String PartyName = null;
        public ArrayList<MerchantAddress> Addresses = null;
        public Contact TradingContact = null;
        public InvoiceContact InvoiceContact = null;
        public BankAccount SettlementBankAccount = null;
        public BankAccount ChargesBankAccount = null;
        public String DirectDebitCorrespondenceEmail = null;
        public String WebsiteAddress = null;
        public String CompanyType = null;
        public String CompanyTypeOther = null;
        public String CompanyRegistrationNumber = null;
        public String CharityNumber = null;
        public ArrayList<MerchantCategory> MerchantCategories = null;
        public String VatNumber = null;
        public Date DateStartedTrading = null;
        public Date AnticipatedGoLiveDate = null;
        public String CountryOfIncorporation = null;
        public String RegionOfIncorporation = null;
        public Financials Financials = null;
        public Boolean NewToCards = null;
        public TradeAssociation TradeAssociation = null;
        public ArrayList<Principal> Principals = null;
        public GoodsAndServices GoodsAndServices = null;
        public AccessibilityOptions AccessibilityOptions = null;
        public ClearingDetails ClearingDetails = null;
        public Acquiring Acquiring = null;
        public ArrayList<Subscription> Subscriptions = null;
        public ArrayList<OrderPayload> Children = null;
        
        public String getPartyId() { return PartyId; }
        public OrderPayload setPartyId(String value) { this.PartyId = value; return this; }
        public String getParentPartyId() { return ParentPartyId; }
        public OrderPayload setParentPartyId(String value) { this.ParentPartyId = value; return this; }
        public String getLegalName() { return LegalName; }
        public OrderPayload setLegalName(String value) { this.LegalName = value; return this; }
        public String getTradingName() { return TradingName; }
        public OrderPayload setTradingName(String value) { this.TradingName = value; return this; }
        public String getPartyName() { return PartyName; }
        public OrderPayload setPartyName(String value) { this.PartyName = value; return this; }
        public ArrayList<MerchantAddress> getAddresses() { return Addresses; }
        public OrderPayload setAddresses(ArrayList<MerchantAddress> value) { this.Addresses = value; return this; }
        public Contact getTradingContact() { return TradingContact; }
        public OrderPayload setTradingContact(Contact value) { this.TradingContact = value; return this; }
        public InvoiceContact getInvoiceContact() { return InvoiceContact; }
        public OrderPayload setInvoiceContact(InvoiceContact value) { this.InvoiceContact = value; return this; }
        public BankAccount getSettlementBankAccount() { return SettlementBankAccount; }
        public OrderPayload setSettlementBankAccount(BankAccount value) { this.SettlementBankAccount = value; return this; }
        public BankAccount getChargesBankAccount() { return ChargesBankAccount; }
        public OrderPayload setChargesBankAccount(BankAccount value) { this.ChargesBankAccount = value; return this; }
        public String getDirectDebitCorrespondenceEmail() { return DirectDebitCorrespondenceEmail; }
        public OrderPayload setDirectDebitCorrespondenceEmail(String value) { this.DirectDebitCorrespondenceEmail = value; return this; }
        public String getWebsiteAddress() { return WebsiteAddress; }
        public OrderPayload setWebsiteAddress(String value) { this.WebsiteAddress = value; return this; }
        public String getCompanyType() { return CompanyType; }
        public OrderPayload setCompanyType(String value) { this.CompanyType = value; return this; }
        public String getCompanyTypeOther() { return CompanyTypeOther; }
        public OrderPayload setCompanyTypeOther(String value) { this.CompanyTypeOther = value; return this; }
        public String getCompanyRegistrationNumber() { return CompanyRegistrationNumber; }
        public OrderPayload setCompanyRegistrationNumber(String value) { this.CompanyRegistrationNumber = value; return this; }
        public String getCharityNumber() { return CharityNumber; }
        public OrderPayload setCharityNumber(String value) { this.CharityNumber = value; return this; }
        public ArrayList<MerchantCategory> getMerchantCategories() { return MerchantCategories; }
        public OrderPayload setMerchantCategories(ArrayList<MerchantCategory> value) { this.MerchantCategories = value; return this; }
        public String getVatNumber() { return VatNumber; }
        public OrderPayload setVatNumber(String value) { this.VatNumber = value; return this; }
        public Date getDateStartedTrading() { return DateStartedTrading; }
        public OrderPayload setDateStartedTrading(Date value) { this.DateStartedTrading = value; return this; }
        public Date getAnticipatedGoLiveDate() { return AnticipatedGoLiveDate; }
        public OrderPayload setAnticipatedGoLiveDate(Date value) { this.AnticipatedGoLiveDate = value; return this; }
        public String getCountryOfIncorporation() { return CountryOfIncorporation; }
        public OrderPayload setCountryOfIncorporation(String value) { this.CountryOfIncorporation = value; return this; }
        public String getRegionOfIncorporation() { return RegionOfIncorporation; }
        public OrderPayload setRegionOfIncorporation(String value) { this.RegionOfIncorporation = value; return this; }
        public Financials getFinancials() { return Financials; }
        public OrderPayload setFinancials(Financials value) { this.Financials = value; return this; }
        public Boolean isNewToCards() { return NewToCards; }
        public OrderPayload setNewToCards(Boolean value) { this.NewToCards = value; return this; }
        public TradeAssociation getTradeAssociation() { return TradeAssociation; }
        public OrderPayload setTradeAssociation(TradeAssociation value) { this.TradeAssociation = value; return this; }
        public ArrayList<Principal> getPrincipals() { return Principals; }
        public OrderPayload setPrincipals(ArrayList<Principal> value) { this.Principals = value; return this; }
        public GoodsAndServices getGoodsAndServices() { return GoodsAndServices; }
        public OrderPayload setGoodsAndServices(GoodsAndServices value) { this.GoodsAndServices = value; return this; }
        public AccessibilityOptions getAccessibilityOptions() { return AccessibilityOptions; }
        public OrderPayload setAccessibilityOptions(AccessibilityOptions value) { this.AccessibilityOptions = value; return this; }
        public ClearingDetails getClearingDetails() { return ClearingDetails; }
        public OrderPayload setClearingDetails(ClearingDetails value) { this.ClearingDetails = value; return this; }
        public Acquiring getAcquiring() { return Acquiring; }
        public OrderPayload setAcquiring(Acquiring value) { this.Acquiring = value; return this; }
        public ArrayList<Subscription> getSubscriptions() { return Subscriptions; }
        public OrderPayload setSubscriptions(ArrayList<Subscription> value) { this.Subscriptions = value; return this; }
        public ArrayList<OrderPayload> getChildren() { return Children; }
        public OrderPayload setChildren(ArrayList<OrderPayload> value) { this.Children = value; return this; }
    }

    public static class MerchantAddress extends Address
    {
        public String AddressType = null;
        public Boolean IsCommercial = null;
        
        public String getAddressType() { return AddressType; }
        public MerchantAddress setAddressType(String value) { this.AddressType = value; return this; }
        public Boolean getIsCommercial() { return IsCommercial; }
        public MerchantAddress setIsCommercial(Boolean value) { this.IsCommercial = value; return this; }
    }

    public static class Address
    {
        public String Address1 = null;
        public String Address2 = null;
        public String Address3 = null;
        public String Postcode = null;
        public String City = null;
        public String State = null;
        public String CountryCode = null;
        
        public String getAddress1() { return Address1; }
        public Address setAddress1(String value) { this.Address1 = value; return this; }
        public String getAddress2() { return Address2; }
        public Address setAddress2(String value) { this.Address2 = value; return this; }
        public String getAddress3() { return Address3; }
        public Address setAddress3(String value) { this.Address3 = value; return this; }
        public String getPostcode() { return Postcode; }
        public Address setPostcode(String value) { this.Postcode = value; return this; }
        public String getCity() { return City; }
        public Address setCity(String value) { this.City = value; return this; }
        public String getState() { return State; }
        public Address setState(String value) { this.State = value; return this; }
        public String getCountryCode() { return CountryCode; }
        public Address setCountryCode(String value) { this.CountryCode = value; return this; }
    }

    public static class InvoiceContact extends Person
    {
        public String Email = null;
        public String Position = null;
        
        public String getEmail() { return Email; }
        public InvoiceContact setEmail(String value) { this.Email = value; return this; }
        public String getPosition() { return Position; }
        public InvoiceContact setPosition(String value) { this.Position = value; return this; }
    }

    public static class BankAccount
    {
        public String SortCode = null;
        public String AccountNumber = null;
        public String BankName = null;
        public String BankAccountName = null;
        public String SwiftCode = null;
        public String InternationalBankAccountNumber = null;
        
        public String getSortCode() { return SortCode; }
        public BankAccount setSortCode(String value) { this.SortCode = value; return this; }
        public String getAccountNumber() { return AccountNumber; }
        public BankAccount setAccountNumber(String value) { this.AccountNumber = value; return this; }
        public String getBankName() { return BankName; }
        public BankAccount setBankName(String value) { this.BankName = value; return this; }
        public String getBankAccountName() { return BankAccountName; }
        public BankAccount setBankAccountName(String value) { this.BankAccountName = value; return this; }
        public String getSwiftCode() { return SwiftCode; }
        public BankAccount setSwiftCode(String value) { this.SwiftCode = value; return this; }
        public String getInternationalBankAccountNumber() { return InternationalBankAccountNumber; }
        public BankAccount setInternationalBankAccountNumber(String value) { this.InternationalBankAccountNumber = value; return this; }
    }

    public static class MerchantCategory
    {
        public String MerchantCategoryCode = null;
        public String MerchantCategoryDescription = null;
        public String DescriptionOfGoodsAndServices = null;
        
        public String getMerchantCategoryCode() { return MerchantCategoryCode; }
        public MerchantCategory setMerchantCategoryCode(String value) { this.MerchantCategoryCode = value; return this; }
        public String getMerchantCategoryDescription() { return MerchantCategoryDescription; }
        public MerchantCategory setMerchantCategoryDescription(String value) { this.MerchantCategoryDescription = value; return this; }
        public String getDescriptionOfGoodsAndServices() { return DescriptionOfGoodsAndServices; }
        public MerchantCategory setDescriptionOfGoodsAndServices(String value) { this.DescriptionOfGoodsAndServices = value; return this; }
    }

    public static class Financials
    {
        public BigDecimal Annual = null;
        public BigDecimal CardPercentage = null;
        public BigDecimal CreditCardPercentage = null;
        public BigDecimal AverageTransactionValue = null;
        public BigDecimal CardNotPresentPercentage = null;
        
        public BigDecimal getAnnual() { return Annual; }
        public Financials setAnnual(BigDecimal value) { this.Annual = value; return this; }
        public BigDecimal getCardPercentage() { return CardPercentage; }
        public Financials setCardPercentage(BigDecimal value) { this.CardPercentage = value; return this; }
        public BigDecimal getCreditCardPercentage() { return CreditCardPercentage; }
        public Financials setCreditCardPercentage(BigDecimal value) { this.CreditCardPercentage = value; return this; }
        public BigDecimal getAverageTransactionValue() { return AverageTransactionValue; }
        public Financials setAverageTransactionValue(BigDecimal value) { this.AverageTransactionValue = value; return this; }
        public BigDecimal getCardNotPresentPercentage() { return CardNotPresentPercentage; }
        public Financials setCardNotPresentPercentage(BigDecimal value) { this.CardNotPresentPercentage = value; return this; }
    }

    public static class TradeAssociation
    {
        public String GroupName = null;
        public String MemberNumber = null;
        
        public String getGroupName() { return GroupName; }
        public TradeAssociation setGroupName(String value) { this.GroupName = value; return this; }
        public String getMemberNumber() { return MemberNumber; }
        public TradeAssociation setMemberNumber(String value) { this.MemberNumber = value; return this; }
    }

    public static class Principal
    {
        public String Title = null;
        public String FirstName = null;
        public String MiddleName = null;
        public String LastName = null;
        public Date DateOfBirth = null;
        public String Nationality = null;
        public ArrayList<PrincipalAddress> HomeAddresses = null;
        public BigDecimal OwnershipPercentage = null;
        public PositionType Position = null;
        public Boolean IsFinancialController = null;
        
        public String getTitle() { return Title; }
        public Principal setTitle(String value) { this.Title = value; return this; }
        public String getFirstName() { return FirstName; }
        public Principal setFirstName(String value) { this.FirstName = value; return this; }
        public String getMiddleName() { return MiddleName; }
        public Principal setMiddleName(String value) { this.MiddleName = value; return this; }
        public String getLastName() { return LastName; }
        public Principal setLastName(String value) { this.LastName = value; return this; }
        public Date getDateOfBirth() { return DateOfBirth; }
        public Principal setDateOfBirth(Date value) { this.DateOfBirth = value; return this; }
        public String getNationality() { return Nationality; }
        public Principal setNationality(String value) { this.Nationality = value; return this; }
        public ArrayList<PrincipalAddress> getHomeAddresses() { return HomeAddresses; }
        public Principal setHomeAddresses(ArrayList<PrincipalAddress> value) { this.HomeAddresses = value; return this; }
        public BigDecimal getOwnershipPercentage() { return OwnershipPercentage; }
        public Principal setOwnershipPercentage(BigDecimal value) { this.OwnershipPercentage = value; return this; }
        public PositionType getPosition() { return Position; }
        public Principal setPosition(PositionType value) { this.Position = value; return this; }
        public Boolean getIsFinancialController() { return IsFinancialController; }
        public Principal setIsFinancialController(Boolean value) { this.IsFinancialController = value; return this; }
    }

    public static class PrincipalAddress extends Address
    {
        public Date StartDate = null;
        public Date EndDate = null;
        
        public Date getStartDate() { return StartDate; }
        public PrincipalAddress setStartDate(Date value) { this.StartDate = value; return this; }
        public Date getEndDate() { return EndDate; }
        public PrincipalAddress setEndDate(Date value) { this.EndDate = value; return this; }
    }

    public static class Address
    {
        public String Address1 = null;
        public String Address2 = null;
        public String Address3 = null;
        public String Postcode = null;
        public String City = null;
        public String State = null;
        public String Countrycode = null;
        
        public String getAddress1() { return Address1; }
        public Address setAddress1(String value) { this.Address1 = value; return this; }
        public String getAddress2() { return Address2; }
        public Address setAddress2(String value) { this.Address2 = value; return this; }
        public String getAddress3() { return Address3; }
        public Address setAddress3(String value) { this.Address3 = value; return this; }
        public String getPostcode() { return Postcode; }
        public Address setPostcode(String value) { this.Postcode = value; return this; }
        public String getCity() { return City; }
        public Address setCity(String value) { this.City = value; return this; }
        public String getState() { return State; }
        public Address setState(String value) { this.State = value; return this; }
        public String getCountrycode() { return Countrycode; }
        public Address setCountrycode(String value) { this.Countrycode = value; return this; }
    }

    public static enum PositionType
    {
        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);

        private final int value;
        PositionType(final int intValue) { value = intValue; }
        public int getValue() { return value; }
    }

    public static class GoodsAndServices
    {
        public Boolean GoodsProvidedByThirdParty = null;
        public Deposits Deposits = null;
        public WarrantiesAndGuarantees WarrantiesAndGuarantees = null;
        public Prepayments Prepayments = null;
        public MembershipsSubscriptionAndInsurancePremiums MembershipsSubscriptionAndInsurancePremiums = null;
        public Address StockHeldAtAnotherAddressLocation = null;
        
        public Boolean isGoodsProvidedByThirdParty() { return GoodsProvidedByThirdParty; }
        public GoodsAndServices setGoodsProvidedByThirdParty(Boolean value) { this.GoodsProvidedByThirdParty = value; return this; }
        public Deposits getDeposits() { return Deposits; }
        public GoodsAndServices setDeposits(Deposits value) { this.Deposits = value; return this; }
        public WarrantiesAndGuarantees getWarrantiesAndGuarantees() { return WarrantiesAndGuarantees; }
        public GoodsAndServices setWarrantiesAndGuarantees(WarrantiesAndGuarantees value) { this.WarrantiesAndGuarantees = value; return this; }
        public Prepayments getPrepayments() { return Prepayments; }
        public GoodsAndServices setPrepayments(Prepayments value) { this.Prepayments = value; return this; }
        public MembershipsSubscriptionAndInsurancePremiums getMembershipsSubscriptionAndInsurancePremiums() { return MembershipsSubscriptionAndInsurancePremiums; }
        public GoodsAndServices setMembershipsSubscriptionAndInsurancePremiums(MembershipsSubscriptionAndInsurancePremiums value) { this.MembershipsSubscriptionAndInsurancePremiums = value; return this; }
        public Address getStockHeldAtAnotherAddressLocation() { return StockHeldAtAnotherAddressLocation; }
        public GoodsAndServices setStockHeldAtAnotherAddressLocation(Address value) { this.StockHeldAtAnotherAddressLocation = value; return this; }
    }

    public static class Deposits
    {
        public Integer PerOfSalesWhereInitialDepositTaken = null;
        public Integer SizePerTotalValue = null;
        public Integer AvgTimeBeforeDeliveryDepositTaken = null;
        public Integer AvgTimeBeforeDeliveryBalanceTaken = null;
        
        public Integer getPerOfSalesWhereInitialDepositTaken() { return PerOfSalesWhereInitialDepositTaken; }
        public Deposits setPerOfSalesWhereInitialDepositTaken(Integer value) { this.PerOfSalesWhereInitialDepositTaken = value; return this; }
        public Integer getSizePerTotalValue() { return SizePerTotalValue; }
        public Deposits setSizePerTotalValue(Integer value) { this.SizePerTotalValue = value; return this; }
        public Integer getAvgTimeBeforeDeliveryDepositTaken() { return AvgTimeBeforeDeliveryDepositTaken; }
        public Deposits setAvgTimeBeforeDeliveryDepositTaken(Integer value) { this.AvgTimeBeforeDeliveryDepositTaken = value; return this; }
        public Integer getAvgTimeBeforeDeliveryBalanceTaken() { return AvgTimeBeforeDeliveryBalanceTaken; }
        public Deposits setAvgTimeBeforeDeliveryBalanceTaken(Integer value) { this.AvgTimeBeforeDeliveryBalanceTaken = value; return this; }
    }

    public static class WarrantiesAndGuarantees
    {
        public Integer PercCardTurnover = null;
        public Integer AvgLengthInMonths = null;
        public Integer PercGoodsReturned = null;
        public String ThirdPartyProviders = null;
        
        public Integer getPercCardTurnover() { return PercCardTurnover; }
        public WarrantiesAndGuarantees setPercCardTurnover(Integer value) { this.PercCardTurnover = value; return this; }
        public Integer getAvgLengthInMonths() { return AvgLengthInMonths; }
        public WarrantiesAndGuarantees setAvgLengthInMonths(Integer value) { this.AvgLengthInMonths = value; return this; }
        public Integer getPercGoodsReturned() { return PercGoodsReturned; }
        public WarrantiesAndGuarantees setPercGoodsReturned(Integer value) { this.PercGoodsReturned = value; return this; }
        public String getThirdPartyProviders() { return ThirdPartyProviders; }
        public WarrantiesAndGuarantees setThirdPartyProviders(String value) { this.ThirdPartyProviders = value; return this; }
    }

    public static class Prepayments
    {
        public Integer PercGoodsWherePaymentTakenPriorToDelivery = null;
        public Integer AvgDaysPaymentTakenInAdvance = null;
        
        public Integer getPercGoodsWherePaymentTakenPriorToDelivery() { return PercGoodsWherePaymentTakenPriorToDelivery; }
        public Prepayments setPercGoodsWherePaymentTakenPriorToDelivery(Integer value) { this.PercGoodsWherePaymentTakenPriorToDelivery = value; return this; }
        public Integer getAvgDaysPaymentTakenInAdvance() { return AvgDaysPaymentTakenInAdvance; }
        public Prepayments setAvgDaysPaymentTakenInAdvance(Integer value) { this.AvgDaysPaymentTakenInAdvance = value; return this; }
    }

    public static class MembershipsSubscriptionAndInsurancePremiums
    {
        public Integer PercCardTurnover = null;
        public Integer AvgLengthInMonths = null;
        public BigDecimal MembershipCost = null;
        
        public Integer getPercCardTurnover() { return PercCardTurnover; }
        public MembershipsSubscriptionAndInsurancePremiums setPercCardTurnover(Integer value) { this.PercCardTurnover = value; return this; }
        public Integer getAvgLengthInMonths() { return AvgLengthInMonths; }
        public MembershipsSubscriptionAndInsurancePremiums setAvgLengthInMonths(Integer value) { this.AvgLengthInMonths = value; return this; }
        public BigDecimal getMembershipCost() { return MembershipCost; }
        public MembershipsSubscriptionAndInsurancePremiums setMembershipCost(BigDecimal value) { this.MembershipCost = value; return this; }
    }

    public static class AccessibilityOptions
    {
        public Boolean AudiotapeRequired = null;
        public Boolean LargePrintRequired = null;
        public Boolean UncontractedBrailleGrade1Required = null;
        public Boolean UncontractedBrailleGrade2Required = null;
        public Boolean NextGenerationTextRequired = null;
        
        public Boolean isAudiotapeRequired() { return AudiotapeRequired; }
        public AccessibilityOptions setAudiotapeRequired(Boolean value) { this.AudiotapeRequired = value; return this; }
        public Boolean isLargePrintRequired() { return LargePrintRequired; }
        public AccessibilityOptions setLargePrintRequired(Boolean value) { this.LargePrintRequired = value; return this; }
        public Boolean isUncontractedBrailleGrade1Required() { return UncontractedBrailleGrade1Required; }
        public AccessibilityOptions setUncontractedBrailleGrade1Required(Boolean value) { this.UncontractedBrailleGrade1Required = value; return this; }
        public Boolean isUncontractedBrailleGrade2Required() { return UncontractedBrailleGrade2Required; }
        public AccessibilityOptions setUncontractedBrailleGrade2Required(Boolean value) { this.UncontractedBrailleGrade2Required = value; return this; }
        public Boolean isNextGenerationTextRequired() { return NextGenerationTextRequired; }
        public AccessibilityOptions setNextGenerationTextRequired(Boolean value) { this.NextGenerationTextRequired = value; return this; }
    }

    public static class ClearingDetails
    {
        public String MerchantUrl = null;
        public String Telephone = null;
        public String Email = null;
        
        public String getMerchantUrl() { return MerchantUrl; }
        public ClearingDetails setMerchantUrl(String value) { this.MerchantUrl = value; return this; }
        public String getTelephone() { return Telephone; }
        public ClearingDetails setTelephone(String value) { this.Telephone = value; return this; }
        public String getEmail() { return Email; }
        public ClearingDetails setEmail(String value) { this.Email = value; return this; }
    }

    public static class Acquiring
    {
        public Integer SettlementPeriod = null;
        public String FundingMode = null;
        public Rates Rates = null;
        public ArrayList<TradingCurrency> TradingCurrencies = null;
        
        public Integer getSettlementPeriod() { return SettlementPeriod; }
        public Acquiring setSettlementPeriod(Integer value) { this.SettlementPeriod = value; return this; }
        public String getFundingMode() { return FundingMode; }
        public Acquiring setFundingMode(String value) { this.FundingMode = value; return this; }
        public Rates getRates() { return Rates; }
        public Acquiring setRates(Rates value) { this.Rates = value; return this; }
        public ArrayList<TradingCurrency> getTradingCurrencies() { return TradingCurrencies; }
        public Acquiring setTradingCurrencies(ArrayList<TradingCurrency> value) { this.TradingCurrencies = value; return this; }
    }

    public static class Rates
    {
        public ArrayList<CardCharge> CardCharges = null;
        public ArrayList<PremiumTransactionCharge> PremiumTransactionCharges = null;
        public ArrayList<AdditionalTariff> AdditionalTariffs = null;
        
        public ArrayList<CardCharge> getCardCharges() { return CardCharges; }
        public Rates setCardCharges(ArrayList<CardCharge> value) { this.CardCharges = value; return this; }
        public ArrayList<PremiumTransactionCharge> getPremiumTransactionCharges() { return PremiumTransactionCharges; }
        public Rates setPremiumTransactionCharges(ArrayList<PremiumTransactionCharge> value) { this.PremiumTransactionCharges = value; return this; }
        public ArrayList<AdditionalTariff> getAdditionalTariffs() { return AdditionalTariffs; }
        public Rates setAdditionalTariffs(ArrayList<AdditionalTariff> value) { this.AdditionalTariffs = value; return this; }
    }

    public static class CardCharge
    {
        public CardType CardType = null;
        public RateChargePair Purchase = null;
        public RateChargePair Refund = null;
        
        public CardType getCardType() { return CardType; }
        public CardCharge setCardType(CardType value) { this.CardType = value; return this; }
        public RateChargePair getPurchase() { return Purchase; }
        public CardCharge setPurchase(RateChargePair value) { this.Purchase = value; return this; }
        public RateChargePair getRefund() { return Refund; }
        public CardCharge setRefund(RateChargePair value) { this.Refund = value; return this; }
    }

    public static enum CardType
    {
        VisaDebit,
        VisaCredit,
        VisaCommercial,
        MastercardDebit,
        MastercardCredit,
        MastercardCommercial,
        MastercardWorldSignia,
        JcbCredit,
        JcbDebit,
        JcbCommercial,
        DinersDiscoverCredit,
        DinersDiscoverDebit,
        DinersDiscoverCommercial,
        Amex,
        ChinaUnionPayCredit,
        ChinaUnionPayDebit,
        ChinaUnionPayCommercial,
        VisaBusinessDebit,
        MastercardBusiness;
    }

    public static class RateChargePair
    {
        public BigDecimal Percent = null;
        public BigDecimal Cost = null;
        
        public BigDecimal getPercent() { return Percent; }
        public RateChargePair setPercent(BigDecimal value) { this.Percent = value; return this; }
        public BigDecimal getCost() { return Cost; }
        public RateChargePair setCost(BigDecimal value) { this.Cost = value; return this; }
    }

    public static class PremiumTransactionCharge
    {
        public PremiumTransactionChargeType Type = null;
        public RateChargePair CreditCard = null;
        public RateChargePair DebitCard = null;
        
        public PremiumTransactionChargeType getType() { return Type; }
        public PremiumTransactionCharge setType(PremiumTransactionChargeType value) { this.Type = value; return this; }
        public RateChargePair getCreditCard() { return CreditCard; }
        public PremiumTransactionCharge setCreditCard(RateChargePair value) { this.CreditCard = value; return this; }
        public RateChargePair getDebitCard() { return DebitCard; }
        public PremiumTransactionCharge setDebitCard(RateChargePair value) { this.DebitCard = value; return this; }
    }

    public static enum PremiumTransactionChargeType
    {
        Magstripe,
        CnpMoto,
        Paper,
        PanKeyEntry,
        SecureEcom,
        NonSecureEcom,
        InterRegional,
        IntraRegional,
        NonAuth;
    }

    public static class AdditionalTariff
    {
        public String Type = null;
        public BigDecimal Cost = null;
        
        public String getType() { return Type; }
        public AdditionalTariff setType(String value) { this.Type = value; return this; }
        public BigDecimal getCost() { return Cost; }
        public AdditionalTariff setCost(BigDecimal value) { this.Cost = value; return this; }
    }

    public static class TradingCurrency
    {
        public ArrayList<CurrencyCodeType> TransactionCurrencies = null;
        public CurrencyCodeType SettlementCurrency = null;
        public String SettlementBankSwift = null;
        public String SettlementBankIban = null;
        
        public ArrayList<CurrencyCodeType> getTransactionCurrencies() { return TransactionCurrencies; }
        public TradingCurrency setTransactionCurrencies(ArrayList<CurrencyCodeType> value) { this.TransactionCurrencies = value; return this; }
        public CurrencyCodeType getSettlementCurrency() { return SettlementCurrency; }
        public TradingCurrency setSettlementCurrency(CurrencyCodeType value) { this.SettlementCurrency = value; return this; }
        public String getSettlementBankSwift() { return SettlementBankSwift; }
        public TradingCurrency setSettlementBankSwift(String value) { this.SettlementBankSwift = value; return this; }
        public String getSettlementBankIban() { return SettlementBankIban; }
        public TradingCurrency setSettlementBankIban(String value) { this.SettlementBankIban = value; return this; }
    }

    public static enum CurrencyCodeType
    {
        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;
    }

    public static class Subscription
    {
        public String Proposition = null;
        public String PricingPackage = null;
        public Integer Term = null;
        public Integer RenewalLength = null;
        public Acquiring Acquiring = null;
        public ArrayList<Product> Products = null;
        
        public String getProposition() { return Proposition; }
        public Subscription setProposition(String value) { this.Proposition = value; return this; }
        public String getPricingPackage() { return PricingPackage; }
        public Subscription setPricingPackage(String value) { this.PricingPackage = value; return this; }
        public Integer getTerm() { return Term; }
        public Subscription setTerm(Integer value) { this.Term = value; return this; }
        public Integer getRenewalLength() { return RenewalLength; }
        public Subscription setRenewalLength(Integer value) { this.RenewalLength = value; return this; }
        public Acquiring getAcquiring() { return Acquiring; }
        public Subscription setAcquiring(Acquiring value) { this.Acquiring = value; return this; }
        public ArrayList<Product> getProducts() { return Products; }
        public Subscription setProducts(ArrayList<Product> value) { this.Products = value; return this; }
    }

    public static class Product
    {
        public String Name = null;
        public String Type = null;
        public String Variant = null;
        public Integer Quantity = null;
        public ArrayList<ProductFee> RelatedFees = null;
        public ArrayList<ProductOption> Options = null;
        
        public String getName() { return Name; }
        public Product setName(String value) { this.Name = value; return this; }
        public String getType() { return Type; }
        public Product setType(String value) { this.Type = value; return this; }
        public String getVariant() { return Variant; }
        public Product setVariant(String value) { this.Variant = value; return this; }
        public Integer getQuantity() { return Quantity; }
        public Product setQuantity(Integer value) { this.Quantity = value; return this; }
        public ArrayList<ProductFee> getRelatedFees() { return RelatedFees; }
        public Product setRelatedFees(ArrayList<ProductFee> value) { this.RelatedFees = value; return this; }
        public ArrayList<ProductOption> getOptions() { return Options; }
        public Product setOptions(ArrayList<ProductOption> value) { this.Options = value; return this; }
    }

    public static class ProductFee
    {
        public ProductFeeType Type = null;
        public BigDecimal Cost = null;
        
        public ProductFeeType getType() { return Type; }
        public ProductFee setType(ProductFeeType value) { this.Type = value; return this; }
        public BigDecimal getCost() { return Cost; }
        public ProductFee setCost(BigDecimal value) { this.Cost = value; return this; }
    }

    public static enum ProductFeeType
    {
        HireCost,
        TransactionCost,
        ServiceFee,
        ManagedServiceSetup,
        ManagedServiceMonthly;
    }

    public static class ProductOption
    {
        public String Type = null;
        public String Value = null;
        
        public String getType() { return Type; }
        public ProductOption setType(String value) { this.Type = value; return this; }
        public String getValue() { return Value; }
        public ProductOption setValue(String value) { this.Value = value; return this; }
    }

    public static class IdentityVerificationDocuments
    {
        public String documentId = null;
        public String authenticity = null;
        
        public String getDocumentId() { return documentId; }
        public IdentityVerificationDocuments setDocumentId(String value) { this.documentId = value; return this; }
        public String getAuthenticity() { return authenticity; }
        public IdentityVerificationDocuments setAuthenticity(String value) { this.authenticity = value; return this; }
    }

    public static class StandardOrderResponse
    {
        public Integer Status = null;
        public String CorrelationId = null;
        public String Message = null;
        
        public Integer getStatus() { return Status; }
        public StandardOrderResponse setStatus(Integer value) { this.Status = value; return this; }
        public String getCorrelationId() { return CorrelationId; }
        public StandardOrderResponse setCorrelationId(String value) { this.CorrelationId = value; return this; }
        public String getMessage() { return Message; }
        public StandardOrderResponse setMessage(String value) { this.Message = value; return this; }
    }

}

Java AllChecksOrderDataRequest 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/order HTTP/1.1 
Host: wp-cddws-test.worldpay.com 
Accept: text/jsv
Content-Type: text/jsv
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: 0001-01-01,
				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: 0001-01-01,
			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: 0001-01-01,
			AnticipatedGoLiveDate: 0001-01-01,
			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/jsv
Content-Length: length

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