| POST | /allchecks/submit/order |
|---|
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CDD_Engine_WS.Services
Imports BoardingGateway.Common.Requests.Orders
Imports BoardingGateway.Common.Requests.Boarding.BusinessDetails
Imports BoardingGateway.Common.Requests.Boarding.Acquiring
Imports BoardingGateway.Common.Requests.Boarding.Products
Imports CDD_Engine_DLL.DataObjects
Imports CddEngine.WebApi.dto.Responses
Namespace Global
Namespace BoardingGateway.Common.Requests.Boarding.Acquiring
Public Partial Class CardCharge
Public Overridable Property CardType As CardType
Public Overridable Property Purchase As RateChargePair
Public Overridable Property Refund As RateChargePair
End Class
Public Enum CardType
VisaDebit
VisaCredit
VisaCommercial
MastercardDebit
MastercardCredit
MastercardCommercial
MastercardWorldSignia
JcbCredit
JcbDebit
JcbCommercial
DinersDiscoverCredit
DinersDiscoverDebit
DinersDiscoverCommercial
Amex
ChinaUnionPayCredit
ChinaUnionPayDebit
ChinaUnionPayCommercial
VisaBusinessDebit
MastercardBusiness
End Enum
Public 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
End Enum
Public Partial Class PremiumTransactionCharge
Public Overridable Property Type As PremiumTransactionChargeType
Public Overridable Property CreditCard As RateChargePair
Public Overridable Property DebitCard As RateChargePair
End Class
Public Enum PremiumTransactionChargeType
Magstripe
CnpMoto
Paper
PanKeyEntry
SecureEcom
NonSecureEcom
InterRegional
IntraRegional
NonAuth
End Enum
Public Partial Class RateChargePair
Public Overridable Property Percent As Nullable(Of Decimal)
Public Overridable Property Cost As Nullable(Of Decimal)
End Class
Public Partial Class TradingCurrency
Public Overridable Property TransactionCurrencies As IEnumerable(Of CurrencyCodeType)
Public Overridable Property SettlementCurrency As CurrencyCodeType
Public Overridable Property SettlementBankSwift As String
Public Overridable Property SettlementBankIban As String
End Class
End Namespace
Namespace BoardingGateway.Common.Requests.Boarding.BusinessDetails
Public Partial Class Address
Public Overridable Property Address1 As String
Public Overridable Property Address2 As String
Public Overridable Property Address3 As String
Public Overridable Property Postcode As String
Public Overridable Property City As String
Public Overridable Property State As String
Public Overridable Property Countrycode As String
End Class
Public 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
End Enum
Public Partial Class Principal
Public Overridable Property Title As String
Public Overridable Property FirstName As String
Public Overridable Property MiddleName As String
Public Overridable Property LastName As String
Public Overridable Property DateOfBirth As Date
Public Overridable Property Nationality As String
Public Overridable Property HomeAddresses As IEnumerable(Of PrincipalAddress)
Public Overridable Property OwnershipPercentage As Decimal
Public Overridable Property Position As PositionType
Public Overridable Property IsFinancialController As Nullable(Of Boolean)
End Class
Public Partial Class PrincipalAddress
Inherits Address
Public Overridable Property StartDate As Date
Public Overridable Property EndDate As Nullable(Of Date)
End Class
End Namespace
Namespace BoardingGateway.Common.Requests.Boarding.Products
Public Partial Class ProductFee
Public Overridable Property Type As ProductFeeType
Public Overridable Property Cost As Decimal
End Class
Public Enum ProductFeeType
HireCost
TransactionCost
ServiceFee
ManagedServiceSetup
ManagedServiceMonthly
End Enum
End Namespace
Namespace BoardingGateway.Common.Requests.Orders
Public Partial Class AccessibilityOptions
Public Overridable Property AudiotapeRequired As Nullable(Of Boolean)
Public Overridable Property LargePrintRequired As Nullable(Of Boolean)
Public Overridable Property UncontractedBrailleGrade1Required As Nullable(Of Boolean)
Public Overridable Property UncontractedBrailleGrade2Required As Nullable(Of Boolean)
Public Overridable Property NextGenerationTextRequired As Nullable(Of Boolean)
End Class
Public Partial Class Acquiring
Public Overridable Property SettlementPeriod As Integer
Public Overridable Property FundingMode As String
Public Overridable Property Rates As Rates
Public Overridable Property TradingCurrencies As IEnumerable(Of TradingCurrency)
End Class
Public Partial Class AdditionalTariff
Public Overridable Property Type As String
Public Overridable Property Cost As Decimal
End Class
Public Partial Class Address
Public Overridable Property Address1 As String
Public Overridable Property Address2 As String
Public Overridable Property Address3 As String
Public Overridable Property Postcode 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 AuthorisedSigner
Inherits Contact
Public Overridable Property DateOfBirth As Nullable(Of Date)
Public Overridable Property CountryCode As String
End Class
Public Partial Class BankAccount
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 SwiftCode As String
Public Overridable Property InternationalBankAccountNumber As String
End Class
Public Partial Class ClearingDetails
Public Overridable Property MerchantUrl As String
Public Overridable Property Telephone As String
Public Overridable Property Email As String
End Class
Public Partial Class Contact
Inherits Person
Public Overridable Property IdpGuid As Nullable(Of Guid)
Public Overridable Property TelephoneNumber As String
Public Overridable Property AltTelephoneNumber As String
Public Overridable Property Email As String
Public Overridable Property Position As String
Public Overridable Property PreferredContactMethod As String
Public Overridable Property PreferredContactBestTime As String
End Class
Public Partial Class Deposits
Public Overridable Property PerOfSalesWhereInitialDepositTaken As Integer
Public Overridable Property SizePerTotalValue As Integer
Public Overridable Property AvgTimeBeforeDeliveryDepositTaken As Integer
Public Overridable Property AvgTimeBeforeDeliveryBalanceTaken As Integer
End Class
Public Partial Class Financials
Public Overridable Property Annual As Decimal
Public Overridable Property CardPercentage As Decimal
Public Overridable Property CreditCardPercentage As Decimal
Public Overridable Property AverageTransactionValue As Decimal
Public Overridable Property CardNotPresentPercentage As Nullable(Of Decimal)
End Class
Public Partial Class GoodsAndServices
Public Overridable Property GoodsProvidedByThirdParty As Nullable(Of Boolean)
Public Overridable Property Deposits As Deposits
Public Overridable Property WarrantiesAndGuarantees As WarrantiesAndGuarantees
Public Overridable Property Prepayments As Prepayments
Public Overridable Property MembershipsSubscriptionAndInsurancePremiums As MembershipsSubscriptionAndInsurancePremiums
Public Overridable Property StockHeldAtAnotherAddressLocation As Address
End Class
Public Partial Class InvoiceContact
Inherits Person
Public Overridable Property Email As String
Public Overridable Property Position As String
End Class
Public Partial Class MembershipsSubscriptionAndInsurancePremiums
Public Overridable Property PercCardTurnover As Integer
Public Overridable Property AvgLengthInMonths As Integer
Public Overridable Property MembershipCost As Decimal
End Class
Public Partial Class MerchantAddress
Inherits Address
Public Overridable Property AddressType As String
Public Overridable Property IsCommercial As Boolean
End Class
Public Partial Class MerchantCategory
Public Overridable Property MerchantCategoryCode As String
Public Overridable Property MerchantCategoryDescription As String
Public Overridable Property DescriptionOfGoodsAndServices As String
End Class
Public Partial Class Order
Public Overridable Property Meta As OrderMeta
Public Overridable Property Payload As OrderPayload
End Class
Public Partial Class OrderMeta
Public Overridable Property SourceSystem As String
Public Overridable Property SourceSystemIdentifier As String
Public Overridable Property Csr As String
Public Overridable Property UltimateParentId As String
Public Overridable Property OrderType As String
Public Overridable Property CustomerType As String
Public Overridable Property Partner As Partner
Public Overridable Property SellerCode As String
Public Overridable Property SellerEmail As String
Public Overridable Property SpecialInstructions As String
Public Overridable Property Contact As AuthorisedSigner
Public Overridable Property OfferDetails As String
Public Overridable Property DateContractAccepted As Date
Public Overridable Property WorldpayBusinessFinanceInterest As Nullable(Of Boolean)
Public Overridable Property Sar As Nullable(Of Boolean)
Public Overridable Property HasSupportingFiles As Boolean
End Class
Public Partial Class OrderPayload
Public Overridable Property PartyId As String
Public Overridable Property ParentPartyId As String
Public Overridable Property LegalName As String
Public Overridable Property TradingName As String
Public Overridable Property PartyName As String
Public Overridable Property Addresses As IEnumerable(Of MerchantAddress)
Public Overridable Property TradingContact As Contact
Public Overridable Property InvoiceContact As InvoiceContact
Public Overridable Property SettlementBankAccount As BankAccount
Public Overridable Property ChargesBankAccount As BankAccount
Public Overridable Property DirectDebitCorrespondenceEmail As String
Public Overridable Property WebsiteAddress As String
Public Overridable Property CompanyType As String
Public Overridable Property CompanyTypeOther As String
Public Overridable Property CompanyRegistrationNumber As String
Public Overridable Property CharityNumber As String
Public Overridable Property MerchantCategories As IEnumerable(Of MerchantCategory)
Public Overridable Property VatNumber As String
Public Overridable Property DateStartedTrading As Nullable(Of Date)
Public Overridable Property AnticipatedGoLiveDate As Nullable(Of Date)
Public Overridable Property CountryOfIncorporation As String
Public Overridable Property RegionOfIncorporation As String
Public Overridable Property Financials As Financials
Public Overridable Property NewToCards As Nullable(Of Boolean)
Public Overridable Property TradeAssociation As TradeAssociation
Public Overridable Property Principals As IEnumerable(Of Principal)
Public Overridable Property GoodsAndServices As GoodsAndServices
Public Overridable Property AccessibilityOptions As AccessibilityOptions
Public Overridable Property ClearingDetails As ClearingDetails
Public Overridable Property Acquiring As Acquiring
Public Overridable Property Subscriptions As IEnumerable(Of Subscription)
Public Overridable Property Children As IEnumerable(Of OrderPayload)
End Class
Public Partial Class Partner
Public Overridable Property PartnerName As String
Public Overridable Property PartnerId As String
End Class
Public Partial Class Person
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 Prepayments
Public Overridable Property PercGoodsWherePaymentTakenPriorToDelivery As Integer
Public Overridable Property AvgDaysPaymentTakenInAdvance As Integer
End Class
Public Partial Class Product
Public Overridable Property Name As String
Public Overridable Property Type As String
Public Overridable Property Variant As String
Public Overridable Property Quantity As Nullable(Of Integer)
Public Overridable Property RelatedFees As IEnumerable(Of ProductFee)
Public Overridable Property Options As IEnumerable(Of ProductOption)
End Class
Public Partial Class ProductOption
Public Overridable Property Type As String
Public Overridable Property Value As String
End Class
Public Partial Class Rates
Public Overridable Property CardCharges As IEnumerable(Of CardCharge)
Public Overridable Property PremiumTransactionCharges As IEnumerable(Of PremiumTransactionCharge)
Public Overridable Property AdditionalTariffs As IEnumerable(Of AdditionalTariff)
End Class
Public Partial Class Subscription
Public Overridable Property Proposition As String
Public Overridable Property PricingPackage As String
Public Overridable Property Term As Nullable(Of Integer)
Public Overridable Property RenewalLength As Nullable(Of Integer)
Public Overridable Property Acquiring As Acquiring
Public Overridable Property Products As IEnumerable(Of Product)
End Class
Public Partial Class TradeAssociation
Public Overridable Property GroupName As String
Public Overridable Property MemberNumber As String
End Class
Public Partial Class WarrantiesAndGuarantees
Public Overridable Property PercCardTurnover As Integer
Public Overridable Property AvgLengthInMonths As Integer
Public Overridable Property PercGoodsReturned As Integer
Public Overridable Property ThirdPartyProviders As String
End Class
End Namespace
Namespace CDD_Engine_DLL.DataObjects
Public Partial Class IdentityVerificationDocuments
Public Overridable Property documentId As String
Public Overridable Property authenticity As String
End Class
End Namespace
Namespace CDD_Engine_WS.Services
Public Partial Class AllChecksOrderDataRequest
Public Sub New()
PartyIndividuals = New List(Of String)
IdentityVerificationDocuments = New List(Of IdentityVerificationDocuments)
End Sub
Public Overridable Property CorrelationId As String
Public Overridable Property OrderJson As Order
Public Overridable Property NapPartyId As String
Public Overridable Property LEID As String
Public Overridable Property OrderId As String
Public Overridable Property PartyIndividuals As List(Of String)
Public Overridable Property IdentityVerificationDocuments As List(Of IdentityVerificationDocuments)
End Class
End Namespace
Namespace CddEngine.WebApi.dto.Responses
Public Partial Class StandardOrderResponse
Public Overridable Property Status As Integer
Public Overridable Property CorrelationId As String
Public Overridable Property Message As String
End Class
End Namespace
End Namespace
VB.NET AllChecksOrderDataRequest 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/order HTTP/1.1
Host: wp-cddws-test.worldpay.com
Accept: text/csv
Content-Type: text/csv
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: text/csv
Content-Length: length
{"Status":0,"CorrelationId":"String","Message":"String"}