CDD Engine Web Service v2.14.0.0

<back to all web services

AllChecksOrderDataRequest

export class StandardOrderResponse
{
    public Status?: number;
    public CorrelationId?: string;
    public Message?: string;

    public constructor(init?: Partial<StandardOrderResponse>) { (Object as any).assign(this, init); }
}

export class Partner
{
    public PartnerName?: string;
    public PartnerId?: string;

    public constructor(init?: Partial<Partner>) { (Object as any).assign(this, init); }
}

export class Person
{
    public Title?: string;
    public FirstName?: string;
    public MiddleName?: string;
    public LastName?: string;

    public constructor(init?: Partial<Person>) { (Object as any).assign(this, init); }
}

export class Contact extends Person
{
    public IdpGuid?: string;
    public TelephoneNumber?: string;
    public AltTelephoneNumber?: string;
    public Email?: string;
    public Position?: string;
    public PreferredContactMethod?: string;
    public PreferredContactBestTime?: string;

    public constructor(init?: Partial<Contact>) { super(init); (Object as any).assign(this, init); }
}

export class AuthorisedSigner extends Contact
{
    public DateOfBirth?: string;
    public CountryCode?: string;

    public constructor(init?: Partial<AuthorisedSigner>) { super(init); (Object as any).assign(this, init); }
}

export class OrderMeta
{
    public SourceSystem?: string;
    public SourceSystemIdentifier?: string;
    public Csr?: string;
    public UltimateParentId?: string;
    public OrderType?: string;
    public CustomerType?: string;
    public Partner?: Partner;
    public SellerCode?: string;
    public SellerEmail?: string;
    public SpecialInstructions?: string;
    public Contact?: AuthorisedSigner;
    public OfferDetails?: string;
    public DateContractAccepted?: string;
    public WorldpayBusinessFinanceInterest?: boolean;
    public Sar?: boolean;
    public HasSupportingFiles?: boolean;

    public constructor(init?: Partial<OrderMeta>) { (Object as any).assign(this, init); }
}

export class Address
{
    public Address1?: string;
    public Address2?: string;
    public Address3?: string;
    public Postcode?: string;
    public City?: string;
    public State?: string;
    public Countrycode?: string;

    public constructor(init?: Partial<Address>) { (Object as any).assign(this, init); }
}

export class MerchantAddress extends Address
{
    public AddressType?: string;
    public IsCommercial?: boolean;

    public constructor(init?: Partial<MerchantAddress>) { super(init); (Object as any).assign(this, init); }
}

export class InvoiceContact extends Person
{
    public Email?: string;
    public Position?: string;

    public constructor(init?: Partial<InvoiceContact>) { super(init); (Object as any).assign(this, init); }
}

export class BankAccount
{
    public SortCode?: string;
    public AccountNumber?: string;
    public BankName?: string;
    public BankAccountName?: string;
    public SwiftCode?: string;
    public InternationalBankAccountNumber?: string;

    public constructor(init?: Partial<BankAccount>) { (Object as any).assign(this, init); }
}

export class MerchantCategory
{
    public MerchantCategoryCode?: string;
    public MerchantCategoryDescription?: string;
    public DescriptionOfGoodsAndServices?: string;

    public constructor(init?: Partial<MerchantCategory>) { (Object as any).assign(this, init); }
}

export class Financials
{
    public Annual?: number;
    public CardPercentage?: number;
    public CreditCardPercentage?: number;
    public AverageTransactionValue?: number;
    public CardNotPresentPercentage?: number;

    public constructor(init?: Partial<Financials>) { (Object as any).assign(this, init); }
}

export class TradeAssociation
{
    public GroupName?: string;
    public MemberNumber?: string;

    public constructor(init?: Partial<TradeAssociation>) { (Object as any).assign(this, init); }
}

export class PrincipalAddress extends Address
{
    public StartDate?: string;
    public EndDate?: string;

    public constructor(init?: Partial<PrincipalAddress>) { super(init); (Object as any).assign(this, init); }
}

export 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,
}

export class Principal
{
    public Title?: string;
    public FirstName?: string;
    public MiddleName?: string;
    public LastName?: string;
    public DateOfBirth?: string;
    public Nationality?: string;
    public HomeAddresses?: PrincipalAddress[];
    public OwnershipPercentage?: number;
    public Position?: PositionType;
    public IsFinancialController?: boolean;

    public constructor(init?: Partial<Principal>) { (Object as any).assign(this, init); }
}

export class Deposits
{
    public PerOfSalesWhereInitialDepositTaken?: number;
    public SizePerTotalValue?: number;
    public AvgTimeBeforeDeliveryDepositTaken?: number;
    public AvgTimeBeforeDeliveryBalanceTaken?: number;

    public constructor(init?: Partial<Deposits>) { (Object as any).assign(this, init); }
}

export class WarrantiesAndGuarantees
{
    public PercCardTurnover?: number;
    public AvgLengthInMonths?: number;
    public PercGoodsReturned?: number;
    public ThirdPartyProviders?: string;

    public constructor(init?: Partial<WarrantiesAndGuarantees>) { (Object as any).assign(this, init); }
}

export class Prepayments
{
    public PercGoodsWherePaymentTakenPriorToDelivery?: number;
    public AvgDaysPaymentTakenInAdvance?: number;

    public constructor(init?: Partial<Prepayments>) { (Object as any).assign(this, init); }
}

export class MembershipsSubscriptionAndInsurancePremiums
{
    public PercCardTurnover?: number;
    public AvgLengthInMonths?: number;
    public MembershipCost?: number;

    public constructor(init?: Partial<MembershipsSubscriptionAndInsurancePremiums>) { (Object as any).assign(this, init); }
}

export class GoodsAndServices
{
    public GoodsProvidedByThirdParty?: boolean;
    public Deposits?: Deposits;
    public WarrantiesAndGuarantees?: WarrantiesAndGuarantees;
    public Prepayments?: Prepayments;
    public MembershipsSubscriptionAndInsurancePremiums?: MembershipsSubscriptionAndInsurancePremiums;
    public StockHeldAtAnotherAddressLocation?: Address;

    public constructor(init?: Partial<GoodsAndServices>) { (Object as any).assign(this, init); }
}

export class AccessibilityOptions
{
    public AudiotapeRequired?: boolean;
    public LargePrintRequired?: boolean;
    public UncontractedBrailleGrade1Required?: boolean;
    public UncontractedBrailleGrade2Required?: boolean;
    public NextGenerationTextRequired?: boolean;

    public constructor(init?: Partial<AccessibilityOptions>) { (Object as any).assign(this, init); }
}

export class ClearingDetails
{
    public MerchantUrl?: string;
    public Telephone?: string;
    public Email?: string;

    public constructor(init?: Partial<ClearingDetails>) { (Object as any).assign(this, init); }
}

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

export class RateChargePair
{
    public Percent?: number;
    public Cost?: number;

    public constructor(init?: Partial<RateChargePair>) { (Object as any).assign(this, init); }
}

export class CardCharge
{
    public CardType?: CardType;
    public Purchase?: RateChargePair;
    public Refund?: RateChargePair;

    public constructor(init?: Partial<CardCharge>) { (Object as any).assign(this, init); }
}

export enum PremiumTransactionChargeType
{
    Magstripe = 'Magstripe',
    CnpMoto = 'CnpMoto',
    Paper = 'Paper',
    PanKeyEntry = 'PanKeyEntry',
    SecureEcom = 'SecureEcom',
    NonSecureEcom = 'NonSecureEcom',
    InterRegional = 'InterRegional',
    IntraRegional = 'IntraRegional',
    NonAuth = 'NonAuth',
}

export class PremiumTransactionCharge
{
    public Type?: PremiumTransactionChargeType;
    public CreditCard?: RateChargePair;
    public DebitCard?: RateChargePair;

    public constructor(init?: Partial<PremiumTransactionCharge>) { (Object as any).assign(this, init); }
}

export class AdditionalTariff
{
    public Type?: string;
    public Cost?: number;

    public constructor(init?: Partial<AdditionalTariff>) { (Object as any).assign(this, init); }
}

export class Rates
{
    public CardCharges?: CardCharge[];
    public PremiumTransactionCharges?: PremiumTransactionCharge[];
    public AdditionalTariffs?: AdditionalTariff[];

    public constructor(init?: Partial<Rates>) { (Object as any).assign(this, init); }
}

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

export class TradingCurrency
{
    public TransactionCurrencies?: CurrencyCodeType[];
    public SettlementCurrency?: CurrencyCodeType;
    public SettlementBankSwift?: string;
    public SettlementBankIban?: string;

    public constructor(init?: Partial<TradingCurrency>) { (Object as any).assign(this, init); }
}

export class Acquiring
{
    public SettlementPeriod?: number;
    public FundingMode?: string;
    public Rates?: Rates;
    public TradingCurrencies?: TradingCurrency[];

    public constructor(init?: Partial<Acquiring>) { (Object as any).assign(this, init); }
}

export enum ProductFeeType
{
    HireCost = 'HireCost',
    TransactionCost = 'TransactionCost',
    ServiceFee = 'ServiceFee',
    ManagedServiceSetup = 'ManagedServiceSetup',
    ManagedServiceMonthly = 'ManagedServiceMonthly',
}

export class ProductFee
{
    public Type?: ProductFeeType;
    public Cost?: number;

    public constructor(init?: Partial<ProductFee>) { (Object as any).assign(this, init); }
}

export class ProductOption
{
    public Type?: string;
    public Value?: string;

    public constructor(init?: Partial<ProductOption>) { (Object as any).assign(this, init); }
}

export class Product
{
    public Name?: string;
    public Type?: string;
    public Variant?: string;
    public Quantity?: number;
    public RelatedFees?: ProductFee[];
    public Options?: ProductOption[];

    public constructor(init?: Partial<Product>) { (Object as any).assign(this, init); }
}

export class Subscription
{
    public Proposition?: string;
    public PricingPackage?: string;
    public Term?: number;
    public RenewalLength?: number;
    public Acquiring?: Acquiring;
    public Products?: Product[];

    public constructor(init?: Partial<Subscription>) { (Object as any).assign(this, init); }
}

export class OrderPayload
{
    public PartyId?: string;
    public ParentPartyId?: string;
    public LegalName?: string;
    public TradingName?: string;
    public PartyName?: string;
    public Addresses?: MerchantAddress[];
    public TradingContact?: Contact;
    public InvoiceContact?: InvoiceContact;
    public SettlementBankAccount?: BankAccount;
    public ChargesBankAccount?: BankAccount;
    public DirectDebitCorrespondenceEmail?: string;
    public WebsiteAddress?: string;
    public CompanyType?: string;
    public CompanyTypeOther?: string;
    public CompanyRegistrationNumber?: string;
    public CharityNumber?: string;
    public MerchantCategories?: MerchantCategory[];
    public VatNumber?: string;
    public DateStartedTrading?: string;
    public AnticipatedGoLiveDate?: string;
    public CountryOfIncorporation?: string;
    public RegionOfIncorporation?: string;
    public Financials?: Financials;
    public NewToCards?: boolean;
    public TradeAssociation?: TradeAssociation;
    public Principals?: Principal[];
    public GoodsAndServices?: GoodsAndServices;
    public AccessibilityOptions?: AccessibilityOptions;
    public ClearingDetails?: ClearingDetails;
    public Acquiring?: Acquiring;
    public Subscriptions?: Subscription[];
    public Children?: OrderPayload[];

    public constructor(init?: Partial<OrderPayload>) { (Object as any).assign(this, init); }
}

export class Order
{
    public Meta?: OrderMeta;
    public Payload?: OrderPayload;

    public constructor(init?: Partial<Order>) { (Object as any).assign(this, init); }
}

export class IdentityVerificationDocuments
{
    public documentId?: string;
    public authenticity?: string;

    public constructor(init?: Partial<IdentityVerificationDocuments>) { (Object as any).assign(this, init); }
}

export class AllChecksOrderDataRequest
{
    public CorrelationId?: string;
    public OrderJson: Order;
    public NapPartyId?: string;
    public LEID?: string;
    public OrderId?: string;
    public PartyIndividuals?: string[];
    public IdentityVerificationDocuments?: IdentityVerificationDocuments[];

    public constructor(init?: Partial<AllChecksOrderDataRequest>) { (Object as any).assign(this, init); }
}

export class Address
{
    public Address1?: string;
    public Address2?: string;
    public Address3?: string;
    public Postcode?: string;
    public City?: string;
    public State?: string;
    public CountryCode?: string;

    public constructor(init?: Partial<Address>) { (Object as any).assign(this, init); }
}

TypeScript AllChecksOrderDataRequest DTOs

POST /allchecks/submit/order HTTP/1.1 
Host: wpcdd-featuretest-ws.worldpay.com 
Accept: application/json
Content-Type: application/json
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: application/json
Content-Length: length

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