POST | /allchecks/submit/order |
---|
import java.math.*
import java.util.*
import net.servicestack.client.*
open class AllChecksOrderDataRequest
{
var CorrelationId:String? = null
var OrderJson:Order? = null
var NapPartyId:String? = null
var LEID:String? = null
var OrderId:String? = null
var PartyIndividuals:ArrayList<String> = ArrayList<String>()
var IdentityVerificationDocuments:ArrayList<IdentityVerificationDocuments> = ArrayList<IdentityVerificationDocuments>()
}
open class Order
{
var Meta:OrderMeta? = null
var Payload:OrderPayload? = null
}
open class OrderMeta
{
var SourceSystem:String? = null
var SourceSystemIdentifier:String? = null
var Csr:String? = null
var UltimateParentId:String? = null
var OrderType:String? = null
var CustomerType:String? = null
var Partner:Partner? = null
var SellerCode:String? = null
var SellerEmail:String? = null
var SpecialInstructions:String? = null
var Contact:AuthorisedSigner? = null
var OfferDetails:String? = null
var DateContractAccepted:Date? = null
var WorldpayBusinessFinanceInterest:Boolean? = null
var Sar:Boolean? = null
var HasSupportingFiles:Boolean? = null
}
open class Partner
{
var PartnerName:String? = null
var PartnerId:String? = null
}
open class AuthorisedSigner : Contact()
{
var DateOfBirth:Date? = null
var CountryCode:String? = null
}
open class Contact : Person()
{
var IdpGuid:UUID? = null
var TelephoneNumber:String? = null
var AltTelephoneNumber:String? = null
var Email:String? = null
var Position:String? = null
var PreferredContactMethod:String? = null
var PreferredContactBestTime:String? = null
}
open class Person
{
var Title:String? = null
var FirstName:String? = null
var MiddleName:String? = null
var LastName:String? = null
}
open class OrderPayload
{
var PartyId:String? = null
var ParentPartyId:String? = null
var LegalName:String? = null
var TradingName:String? = null
var PartyName:String? = null
var Addresses:ArrayList<MerchantAddress> = ArrayList<MerchantAddress>()
var TradingContact:Contact? = null
var InvoiceContact:InvoiceContact? = null
var SettlementBankAccount:BankAccount? = null
var ChargesBankAccount:BankAccount? = null
var DirectDebitCorrespondenceEmail:String? = null
var WebsiteAddress:String? = null
var CompanyType:String? = null
var CompanyTypeOther:String? = null
var CompanyRegistrationNumber:String? = null
var CharityNumber:String? = null
var MerchantCategories:ArrayList<MerchantCategory> = ArrayList<MerchantCategory>()
var VatNumber:String? = null
var DateStartedTrading:Date? = null
var AnticipatedGoLiveDate:Date? = null
var CountryOfIncorporation:String? = null
var RegionOfIncorporation:String? = null
var Financials:Financials? = null
var NewToCards:Boolean? = null
var TradeAssociation:TradeAssociation? = null
var Principals:ArrayList<Principal> = ArrayList<Principal>()
var GoodsAndServices:GoodsAndServices? = null
var AccessibilityOptions:AccessibilityOptions? = null
var ClearingDetails:ClearingDetails? = null
var Acquiring:Acquiring? = null
var Subscriptions:ArrayList<Subscription> = ArrayList<Subscription>()
var Children:ArrayList<OrderPayload> = ArrayList<OrderPayload>()
}
open class MerchantAddress : Address()
{
var AddressType:String? = null
var IsCommercial:Boolean? = null
}
open class Address
{
var Address1:String? = null
var Address2:String? = null
var Address3:String? = null
var Postcode:String? = null
var City:String? = null
var State:String? = null
var CountryCode:String? = null
}
open class InvoiceContact : Person()
{
var Email:String? = null
var Position:String? = null
}
open class BankAccount
{
var SortCode:String? = null
var AccountNumber:String? = null
var BankName:String? = null
var BankAccountName:String? = null
var SwiftCode:String? = null
var InternationalBankAccountNumber:String? = null
}
open class MerchantCategory
{
var MerchantCategoryCode:String? = null
var MerchantCategoryDescription:String? = null
var DescriptionOfGoodsAndServices:String? = null
}
open class Financials
{
var Annual:BigDecimal? = null
var CardPercentage:BigDecimal? = null
var CreditCardPercentage:BigDecimal? = null
var AverageTransactionValue:BigDecimal? = null
var CardNotPresentPercentage:BigDecimal? = null
}
open class TradeAssociation
{
var GroupName:String? = null
var MemberNumber:String? = null
}
open class Principal
{
var Title:String? = null
var FirstName:String? = null
var MiddleName:String? = null
var LastName:String? = null
var DateOfBirth:Date? = null
var Nationality:String? = null
var HomeAddresses:ArrayList<PrincipalAddress> = ArrayList<PrincipalAddress>()
var OwnershipPercentage:BigDecimal? = null
var Position:PositionType? = null
var IsFinancialController:Boolean? = null
}
open class PrincipalAddress : Address()
{
var StartDate:Date? = null
var EndDate:Date? = null
}
open class Address
{
var Address1:String? = null
var Address2:String? = null
var Address3:String? = null
var Postcode:String? = null
var City:String? = null
var State:String? = null
var Countrycode:String? = null
}
enum class PositionType(val value:Int)
{
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),
}
open class GoodsAndServices
{
var GoodsProvidedByThirdParty:Boolean? = null
var Deposits:Deposits? = null
var WarrantiesAndGuarantees:WarrantiesAndGuarantees? = null
var Prepayments:Prepayments? = null
var MembershipsSubscriptionAndInsurancePremiums:MembershipsSubscriptionAndInsurancePremiums? = null
var StockHeldAtAnotherAddressLocation:Address? = null
}
open class Deposits
{
var PerOfSalesWhereInitialDepositTaken:Int? = null
var SizePerTotalValue:Int? = null
var AvgTimeBeforeDeliveryDepositTaken:Int? = null
var AvgTimeBeforeDeliveryBalanceTaken:Int? = null
}
open class WarrantiesAndGuarantees
{
var PercCardTurnover:Int? = null
var AvgLengthInMonths:Int? = null
var PercGoodsReturned:Int? = null
var ThirdPartyProviders:String? = null
}
open class Prepayments
{
var PercGoodsWherePaymentTakenPriorToDelivery:Int? = null
var AvgDaysPaymentTakenInAdvance:Int? = null
}
open class MembershipsSubscriptionAndInsurancePremiums
{
var PercCardTurnover:Int? = null
var AvgLengthInMonths:Int? = null
var MembershipCost:BigDecimal? = null
}
open class AccessibilityOptions
{
var AudiotapeRequired:Boolean? = null
var LargePrintRequired:Boolean? = null
var UncontractedBrailleGrade1Required:Boolean? = null
var UncontractedBrailleGrade2Required:Boolean? = null
var NextGenerationTextRequired:Boolean? = null
}
open class ClearingDetails
{
var MerchantUrl:String? = null
var Telephone:String? = null
var Email:String? = null
}
open class Acquiring
{
var SettlementPeriod:Int? = null
var FundingMode:String? = null
var Rates:Rates? = null
var TradingCurrencies:ArrayList<TradingCurrency> = ArrayList<TradingCurrency>()
}
open class Rates
{
var CardCharges:ArrayList<CardCharge> = ArrayList<CardCharge>()
var PremiumTransactionCharges:ArrayList<PremiumTransactionCharge> = ArrayList<PremiumTransactionCharge>()
var AdditionalTariffs:ArrayList<AdditionalTariff> = ArrayList<AdditionalTariff>()
}
open class CardCharge
{
var CardType:CardType? = null
var Purchase:RateChargePair? = null
var Refund:RateChargePair? = null
}
enum class CardType
{
VisaDebit,
VisaCredit,
VisaCommercial,
MastercardDebit,
MastercardCredit,
MastercardCommercial,
MastercardWorldSignia,
JcbCredit,
JcbDebit,
JcbCommercial,
DinersDiscoverCredit,
DinersDiscoverDebit,
DinersDiscoverCommercial,
Amex,
ChinaUnionPayCredit,
ChinaUnionPayDebit,
ChinaUnionPayCommercial,
VisaBusinessDebit,
MastercardBusiness,
}
open class RateChargePair
{
var Percent:BigDecimal? = null
var Cost:BigDecimal? = null
}
open class PremiumTransactionCharge
{
var Type:PremiumTransactionChargeType? = null
var CreditCard:RateChargePair? = null
var DebitCard:RateChargePair? = null
}
enum class PremiumTransactionChargeType
{
Magstripe,
CnpMoto,
Paper,
PanKeyEntry,
SecureEcom,
NonSecureEcom,
InterRegional,
IntraRegional,
NonAuth,
}
open class AdditionalTariff
{
var Type:String? = null
var Cost:BigDecimal? = null
}
open class TradingCurrency
{
var TransactionCurrencies:ArrayList<CurrencyCodeType> = ArrayList<CurrencyCodeType>()
var SettlementCurrency:CurrencyCodeType? = null
var SettlementBankSwift:String? = null
var SettlementBankIban:String? = null
}
enum class 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,
}
open class Subscription
{
var Proposition:String? = null
var PricingPackage:String? = null
var Term:Int? = null
var RenewalLength:Int? = null
var Acquiring:Acquiring? = null
var Products:ArrayList<Product> = ArrayList<Product>()
}
open class Product
{
var Name:String? = null
var Type:String? = null
var Variant:String? = null
var Quantity:Int? = null
var RelatedFees:ArrayList<ProductFee> = ArrayList<ProductFee>()
var Options:ArrayList<ProductOption> = ArrayList<ProductOption>()
}
open class ProductFee
{
var Type:ProductFeeType? = null
var Cost:BigDecimal? = null
}
enum class ProductFeeType
{
HireCost,
TransactionCost,
ServiceFee,
ManagedServiceSetup,
ManagedServiceMonthly,
}
open class ProductOption
{
var Type:String? = null
var Value:String? = null
}
open class IdentityVerificationDocuments
{
var documentId:String? = null
var authenticity:String? = null
}
open class StandardOrderResponse
{
var Status:Int? = null
var CorrelationId:String? = null
var Message:String? = null
}
Kotlin AllChecksOrderDataRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<AllChecksOrderDataRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CDD_Engine_WS.Services">
<CorrelationId>String</CorrelationId>
<IdentityVerificationDocuments xmlns:d2p1="http://schemas.datacontract.org/2004/07/CDD_Engine_DLL.DataObjects">
<d2p1:IdentityVerificationDocuments>
<d2p1:authenticity>String</d2p1:authenticity>
<d2p1:documentId>String</d2p1:documentId>
</d2p1:IdentityVerificationDocuments>
</IdentityVerificationDocuments>
<LEID>String</LEID>
<NapPartyId>String</NapPartyId>
<OrderId>String</OrderId>
<OrderJson xmlns:d2p1="http://schemas.datacontract.org/2004/07/BoardingGateway.Common.Requests.Orders">
<d2p1:Meta>
<d2p1:Contact>
<d2p1:FirstName>String</d2p1:FirstName>
<d2p1:LastName>String</d2p1:LastName>
<d2p1:MiddleName>String</d2p1:MiddleName>
<d2p1:Title>String</d2p1:Title>
<d2p1:AltTelephoneNumber>String</d2p1:AltTelephoneNumber>
<d2p1:Email>String</d2p1:Email>
<d2p1:IdpGuid>00000000-0000-0000-0000-000000000000</d2p1:IdpGuid>
<d2p1:Position>String</d2p1:Position>
<d2p1:PreferredContactBestTime>String</d2p1:PreferredContactBestTime>
<d2p1:PreferredContactMethod>String</d2p1:PreferredContactMethod>
<d2p1:TelephoneNumber>String</d2p1:TelephoneNumber>
<d2p1:CountryCode>String</d2p1:CountryCode>
<d2p1:DateOfBirth>0001-01-01T00:00:00</d2p1:DateOfBirth>
</d2p1:Contact>
<d2p1:Csr>String</d2p1:Csr>
<d2p1:CustomerType>String</d2p1:CustomerType>
<d2p1:DateContractAccepted>0001-01-01T00:00:00</d2p1:DateContractAccepted>
<d2p1:HasSupportingFiles>false</d2p1:HasSupportingFiles>
<d2p1:OfferDetails>String</d2p1:OfferDetails>
<d2p1:OrderType>String</d2p1:OrderType>
<d2p1:Partner>
<d2p1:PartnerId>String</d2p1:PartnerId>
<d2p1:PartnerName>String</d2p1:PartnerName>
</d2p1:Partner>
<d2p1:Sar>false</d2p1:Sar>
<d2p1:SellerCode>String</d2p1:SellerCode>
<d2p1:SellerEmail>String</d2p1:SellerEmail>
<d2p1:SourceSystem>String</d2p1:SourceSystem>
<d2p1:SourceSystemIdentifier>String</d2p1:SourceSystemIdentifier>
<d2p1:SpecialInstructions>String</d2p1:SpecialInstructions>
<d2p1:UltimateParentId>String</d2p1:UltimateParentId>
<d2p1:WorldpayBusinessFinanceInterest>false</d2p1:WorldpayBusinessFinanceInterest>
</d2p1:Meta>
<d2p1:Payload>
<d2p1:AccessibilityOptions>
<d2p1:AudiotapeRequired>false</d2p1:AudiotapeRequired>
<d2p1:LargePrintRequired>false</d2p1:LargePrintRequired>
<d2p1:NextGenerationTextRequired>false</d2p1:NextGenerationTextRequired>
<d2p1:UncontractedBrailleGrade1Required>false</d2p1:UncontractedBrailleGrade1Required>
<d2p1:UncontractedBrailleGrade2Required>false</d2p1:UncontractedBrailleGrade2Required>
</d2p1:AccessibilityOptions>
<d2p1:Acquiring>
<d2p1:FundingMode>String</d2p1:FundingMode>
<d2p1:Rates>
<d2p1:AdditionalTariffs i:nil="true" />
<d2p1:CardCharges i:nil="true" />
<d2p1:PremiumTransactionCharges i:nil="true" />
</d2p1:Rates>
<d2p1:SettlementPeriod>0</d2p1:SettlementPeriod>
<d2p1:TradingCurrencies i:nil="true" />
</d2p1:Acquiring>
<d2p1:Addresses i:nil="true" />
<d2p1:AnticipatedGoLiveDate>0001-01-01T00:00:00</d2p1:AnticipatedGoLiveDate>
<d2p1:ChargesBankAccount>
<d2p1:AccountNumber>String</d2p1:AccountNumber>
<d2p1:BankAccountName>String</d2p1:BankAccountName>
<d2p1:BankName>String</d2p1:BankName>
<d2p1:InternationalBankAccountNumber>String</d2p1:InternationalBankAccountNumber>
<d2p1:SortCode>String</d2p1:SortCode>
<d2p1:SwiftCode>String</d2p1:SwiftCode>
</d2p1:ChargesBankAccount>
<d2p1:CharityNumber>String</d2p1:CharityNumber>
<d2p1:Children i:nil="true" />
<d2p1:ClearingDetails>
<d2p1:Email>String</d2p1:Email>
<d2p1:MerchantUrl>String</d2p1:MerchantUrl>
<d2p1:Telephone>String</d2p1:Telephone>
</d2p1:ClearingDetails>
<d2p1:CompanyRegistrationNumber>String</d2p1:CompanyRegistrationNumber>
<d2p1:CompanyType>String</d2p1:CompanyType>
<d2p1:CompanyTypeOther>String</d2p1:CompanyTypeOther>
<d2p1:CountryOfIncorporation>String</d2p1:CountryOfIncorporation>
<d2p1:DateStartedTrading>0001-01-01T00:00:00</d2p1:DateStartedTrading>
<d2p1:DirectDebitCorrespondenceEmail>String</d2p1:DirectDebitCorrespondenceEmail>
<d2p1:Financials>
<d2p1:Annual>0</d2p1:Annual>
<d2p1:AverageTransactionValue>0</d2p1:AverageTransactionValue>
<d2p1:CardNotPresentPercentage>0</d2p1:CardNotPresentPercentage>
<d2p1:CardPercentage>0</d2p1:CardPercentage>
<d2p1:CreditCardPercentage>0</d2p1:CreditCardPercentage>
</d2p1:Financials>
<d2p1:GoodsAndServices>
<d2p1:Deposits>
<d2p1:AvgTimeBeforeDeliveryBalanceTaken>0</d2p1:AvgTimeBeforeDeliveryBalanceTaken>
<d2p1:AvgTimeBeforeDeliveryDepositTaken>0</d2p1:AvgTimeBeforeDeliveryDepositTaken>
<d2p1:PerOfSalesWhereInitialDepositTaken>0</d2p1:PerOfSalesWhereInitialDepositTaken>
<d2p1:SizePerTotalValue>0</d2p1:SizePerTotalValue>
</d2p1:Deposits>
<d2p1:GoodsProvidedByThirdParty>false</d2p1:GoodsProvidedByThirdParty>
<d2p1:MembershipsSubscriptionAndInsurancePremiums>
<d2p1:AvgLengthInMonths>0</d2p1:AvgLengthInMonths>
<d2p1:MembershipCost>0</d2p1:MembershipCost>
<d2p1:PercCardTurnover>0</d2p1:PercCardTurnover>
</d2p1:MembershipsSubscriptionAndInsurancePremiums>
<d2p1:Prepayments>
<d2p1:AvgDaysPaymentTakenInAdvance>0</d2p1:AvgDaysPaymentTakenInAdvance>
<d2p1:PercGoodsWherePaymentTakenPriorToDelivery>0</d2p1:PercGoodsWherePaymentTakenPriorToDelivery>
</d2p1:Prepayments>
<d2p1:StockHeldAtAnotherAddressLocation>
<d2p1:Address1>String</d2p1:Address1>
<d2p1:Address2>String</d2p1:Address2>
<d2p1:Address3>String</d2p1:Address3>
<d2p1:City>String</d2p1:City>
<d2p1:CountryCode>String</d2p1:CountryCode>
<d2p1:Postcode>String</d2p1:Postcode>
<d2p1:State>String</d2p1:State>
</d2p1:StockHeldAtAnotherAddressLocation>
<d2p1:WarrantiesAndGuarantees>
<d2p1:AvgLengthInMonths>0</d2p1:AvgLengthInMonths>
<d2p1:PercCardTurnover>0</d2p1:PercCardTurnover>
<d2p1:PercGoodsReturned>0</d2p1:PercGoodsReturned>
<d2p1:ThirdPartyProviders>String</d2p1:ThirdPartyProviders>
</d2p1:WarrantiesAndGuarantees>
</d2p1:GoodsAndServices>
<d2p1:InvoiceContact>
<d2p1:FirstName>String</d2p1:FirstName>
<d2p1:LastName>String</d2p1:LastName>
<d2p1:MiddleName>String</d2p1:MiddleName>
<d2p1:Title>String</d2p1:Title>
<d2p1:Email>String</d2p1:Email>
<d2p1:Position>String</d2p1:Position>
</d2p1:InvoiceContact>
<d2p1:LegalName>String</d2p1:LegalName>
<d2p1:MerchantCategories i:nil="true" />
<d2p1:NewToCards>false</d2p1:NewToCards>
<d2p1:ParentPartyId>String</d2p1:ParentPartyId>
<d2p1:PartyId>String</d2p1:PartyId>
<d2p1:PartyName>String</d2p1:PartyName>
<d2p1:Principals i:nil="true" />
<d2p1:RegionOfIncorporation>String</d2p1:RegionOfIncorporation>
<d2p1:SettlementBankAccount>
<d2p1:AccountNumber>String</d2p1:AccountNumber>
<d2p1:BankAccountName>String</d2p1:BankAccountName>
<d2p1:BankName>String</d2p1:BankName>
<d2p1:InternationalBankAccountNumber>String</d2p1:InternationalBankAccountNumber>
<d2p1:SortCode>String</d2p1:SortCode>
<d2p1:SwiftCode>String</d2p1:SwiftCode>
</d2p1:SettlementBankAccount>
<d2p1:Subscriptions i:nil="true" />
<d2p1:TradeAssociation>
<d2p1:GroupName>String</d2p1:GroupName>
<d2p1:MemberNumber>String</d2p1:MemberNumber>
</d2p1:TradeAssociation>
<d2p1:TradingContact>
<d2p1:FirstName>String</d2p1:FirstName>
<d2p1:LastName>String</d2p1:LastName>
<d2p1:MiddleName>String</d2p1:MiddleName>
<d2p1:Title>String</d2p1:Title>
<d2p1:AltTelephoneNumber>String</d2p1:AltTelephoneNumber>
<d2p1:Email>String</d2p1:Email>
<d2p1:IdpGuid>00000000-0000-0000-0000-000000000000</d2p1:IdpGuid>
<d2p1:Position>String</d2p1:Position>
<d2p1:PreferredContactBestTime>String</d2p1:PreferredContactBestTime>
<d2p1:PreferredContactMethod>String</d2p1:PreferredContactMethod>
<d2p1:TelephoneNumber>String</d2p1:TelephoneNumber>
</d2p1:TradingContact>
<d2p1:TradingName>String</d2p1:TradingName>
<d2p1:VatNumber>String</d2p1:VatNumber>
<d2p1:WebsiteAddress>String</d2p1:WebsiteAddress>
</d2p1:Payload>
</OrderJson>
<PartyIndividuals xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</PartyIndividuals>
</AllChecksOrderDataRequest>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <StandardOrderResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CddEngine.WebApi.dto.Responses"> <CorrelationId>String</CorrelationId> <Message>String</Message> <Status>0</Status> </StandardOrderResponse>