CDD Engine Web Service v2.14.0.0

<back to all web services

AllChecksDataRequestRequest

Requires Authentication
The following routes are available for this service:
POST/allchecks/submit/data
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CDD_Engine_WS.dto.Requests
Imports CDD_Engine_DLL.DataObjects

Namespace Global

    Namespace CDD_Engine_DLL.DataObjects

        Public Partial Class AddressData
            Public Overridable Property address1 As String
            Public Overridable Property address2 As String
            Public Overridable Property address3 As String
            Public Overridable Property postalCode As String
            Public Overridable Property city As String
            Public Overridable Property state As String
            Public Overridable Property countryCode As String
        End Class

        Public Partial Class ApplicationDetails
            Public Overridable Property specialInstructions As String
            Public Overridable Property typeAcquiring As Nullable(Of Boolean)
            Public Overridable Property typePOS_F2F As Nullable(Of Boolean)
            Public Overridable Property typePOS_MOTO As Nullable(Of Boolean)
            Public Overridable Property typeOnlinePayments As Nullable(Of Boolean)
            Public Overridable Property typeVirtualTerminal As Nullable(Of Boolean)
            Public Overridable Property sellerCode As String
            Public Overridable Property numOutlets As Nullable(Of Integer)
            Public Overridable Property mccCode As String
            Public Overridable Property offerDescription As String
            Public Overridable Property pricingPackage As String
            Public Overridable Property contractLength As Nullable(Of Integer)
            Public Overridable Property settlementPeriodTPlus As String
            Public Overridable Property ecomPSP As String
            Public Overridable Property posPSP As String
        End Class

        Public Partial Class BankDetails
            Public Overridable Property sortCode As String
            Public Overridable Property accountNumber As String
            Public Overridable Property bankName As String
            Public Overridable Property bankAccountName As String
            Public Overridable Property settlementCurrency As String
            Public Overridable Property swiftCode As String
        End Class

        Public Partial Class BusinessProfile
            Public Sub New()
                daysFromOrderConfirmationToDelivery = New List(Of DaysToDelivery)
                depositPaymentDetails = New List(Of PaymentDetails)
            End Sub

            Public Overridable Property descriptionOfYourGoodsAndServices As String
            Public Overridable Property anticipatedAverageMonthlyTurnover As Nullable(Of Double)
            Public Overridable Property anticipatedPeakMonthlyTurnover As Nullable(Of Double)
            Public Overridable Property percentageOfPrepayments As Nullable(Of Double)
            Public Overridable Property percentageOfDeposits As Nullable(Of Double)
            Public Overridable Property percentageOfSubscriptions As Nullable(Of Double)
            Public Overridable Property daysFromOrderConfirmationToDelivery As List(Of DaysToDelivery)
            Public Overridable Property depositPaymentDetails As List(Of PaymentDetails)
            Public Overridable Property averageSubscriptionLengthInMonths As Nullable(Of Integer)
            Public Overridable Property averageNumberOfSubscriptionPayments As Nullable(Of Integer)
            Public Overridable Property anticipatedPercentageIncreaseInTurnoverForAYear As Nullable(Of Double)
            Public Overridable Property ccTurnover As Nullable(Of Double)
            Public Overridable Property totalCardTurnover As Nullable(Of Double)
            Public Overridable Property cnpPercentage As Nullable(Of Double)
            Public Overridable Property totalTurnover As Nullable(Of Double)
            Public Overridable Property avTransValue As Nullable(Of Double)
            Public Overridable Property cnpRequired As Boolean
            Public Overridable Property cashbackRequired As Boolean
            Public Overridable Property futurePayRequired As Boolean
            Public Overridable Property newToCards As Nullable(Of Boolean)
        End Class

        Public Partial Class CompanyDetails
            Public Overridable Property legalName As String
            Public Overridable Property tradingName As String
            Public Overridable Property tradingAddress As AddressData
            Public Overridable Property legalAddress As AddressData
            Public Overridable Property website As String
            Public Overridable Property companyType As String
            Public Overridable Property registrationNumber As String
            Public Overridable Property merchantCategoryPseudoName As String
            Public Overridable Property vatNumber As String
            Public Overridable Property hasStartedTrading As Nullable(Of Boolean)
            Public Overridable Property startedTradingMonth As String
            Public Overridable Property startedTradingYear As String
            Public Overridable Property companyTypeOther As String
            Public Overridable Property isRegisteredCharity As Nullable(Of Boolean)
            Public Overridable Property countryOfIncorporation As String
            Public Overridable Property regionOfIncorporation As String
        End Class

        Public Partial Class ContactDetails
            Public Overridable Property name As ContactNameData
            Public Overridable Property phone As String
            Public Overridable Property email As String
            Public Overridable Property position As String
            Public Overridable Property altPhone As String
            Public Overridable Property preferredContactMethod As String
            Public Overridable Property preferredContactBestTime As String
        End Class

        Public Partial Class ContactNameData
            Public Overridable Property title As String
            Public Overridable Property firstName As String
            Public Overridable Property middleName As String
            Public Overridable Property lastName As String
        End Class

        Public Partial Class DaysToDelivery
            Public Overridable Property percentageOfOrders As Nullable(Of Double)
            Public Overridable Property numberOfDays As Nullable(Of Integer)
        End Class

        Public Partial Class IdentityVerificationDocuments
            Public Overridable Property documentId As String
            Public Overridable Property authenticity As String
        End Class

        Public Partial Class OwnerDetails
            Public Sub New()
                identityVerificationDocuments = New List(Of IdentityVerificationDocuments)
            End Sub

            Public Overridable Property dayOfBirth As Integer
            Public Overridable Property monthOfBirth As Integer
            Public Overridable Property yearOfBirth As Integer
            Public Overridable Property ownershipPercentage As Nullable(Of Double)
            Public Overridable Property homeAddress As AddressData
            Public Overridable Property currentAddressLessThanThreeYears As Boolean
            Public Overridable Property previousHomeAddress As AddressData
            Public Overridable Property name As ContactNameData
            Public Overridable Property director As Boolean
            Public Overridable Property nationality As String
            Public Overridable Property position As String
            Public Overridable Property timeAtHomeAddressYears As Nullable(Of Integer)
            Public Overridable Property timeAtHomeAddressMonths As Nullable(Of Integer)
            Public Overridable Property PrimaryPartyID As String
            Public Overridable Property identityVerificationDocuments As List(Of IdentityVerificationDocuments)
        End Class

        Public Partial Class PaymentDetails
            Public Overridable Property percentageOfTotalTurnoverToRelatedBusiness As Nullable(Of Double)
            Public Overridable Property percentageOfTotalTurnoverTakenAsDeposit As Nullable(Of Double)
            Public Overridable Property averageDaysBetweenDepositAndFullPayment As Nullable(Of Integer)
            Public Overridable Property averageDaysBetweenFullPaymentAndDelivery As Nullable(Of Integer)
        End Class
    End Namespace

    Namespace CDD_Engine_WS.dto.Requests

        Public Partial Class AllChecksDataRequestRequest
            Public Sub New()
                Owners = New List(Of OwnerDetails)
            End Sub

            Public Overridable Property ApplicationGUID As String
            Public Overridable Property CSR As Integer
            Public Overridable Property ApplicationDetails As ApplicationDetails
            Public Overridable Property MainBusinessRepresentative As ContactDetails
            Public Overridable Property CompanyDetail As CompanyDetails
            Public Overridable Property BankDetail As BankDetails
            Public Overridable Property BusinessProfile As BusinessProfile
            Public Overridable Property Owners As List(Of OwnerDetails)
            Public Overridable Property NapPartyId As String
        End Class
    End Namespace
End Namespace

VB.NET AllChecksDataRequestRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: wpcdd-featuretest-ws.worldpay.com 
Accept: application/json
Content-Type: application/json
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"}