| POST | /OrderBoarding |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
public static class OrderBoardingRequest
{
@ApiMember(IsRequired=true)
public UUID correlationId = null;
@ApiMember(IsRequired=true)
public Order orderJson = null;
public UUID onboardingRequestId = null;
public UUID localEnterpriseId = null;
public String audience = null;
public UUID getCorrelationId() { return correlationId; }
public OrderBoardingRequest setCorrelationId(UUID value) { this.correlationId = value; return this; }
public Order getOrderJson() { return orderJson; }
public OrderBoardingRequest setOrderJson(Order value) { this.orderJson = value; return this; }
public UUID getOnboardingRequestId() { return onboardingRequestId; }
public OrderBoardingRequest setOnboardingRequestId(UUID value) { this.onboardingRequestId = value; return this; }
public UUID getLocalEnterpriseId() { return localEnterpriseId; }
public OrderBoardingRequest setLocalEnterpriseId(UUID value) { this.localEnterpriseId = value; return this; }
public String getAudience() { return audience; }
public OrderBoardingRequest setAudience(String value) { this.audience = 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 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 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 InitiateBoardingResponse
{
public UUID applicationGuid = null;
public Integer csr = null;
public UUID applicationQueueGuid = null;
public ApplicationQueueStatus queueStatus = null;
public ApplicationBoardingStatus boardingStatus = null;
public ArrayList<String> errorMessages = null;
public UUID getApplicationGuid() { return applicationGuid; }
public InitiateBoardingResponse setApplicationGuid(UUID value) { this.applicationGuid = value; return this; }
public Integer getCsr() { return csr; }
public InitiateBoardingResponse setCsr(Integer value) { this.csr = value; return this; }
public UUID getApplicationQueueGuid() { return applicationQueueGuid; }
public InitiateBoardingResponse setApplicationQueueGuid(UUID value) { this.applicationQueueGuid = value; return this; }
public ApplicationQueueStatus getQueueStatus() { return queueStatus; }
public InitiateBoardingResponse setQueueStatus(ApplicationQueueStatus value) { this.queueStatus = value; return this; }
public ApplicationBoardingStatus getBoardingStatus() { return boardingStatus; }
public InitiateBoardingResponse setBoardingStatus(ApplicationBoardingStatus value) { this.boardingStatus = value; return this; }
public ArrayList<String> getErrorMessages() { return errorMessages; }
public InitiateBoardingResponse setErrorMessages(ArrayList<String> value) { this.errorMessages = value; return this; }
}
@DataContract
public static enum ApplicationQueueStatus
{
Queued(0),
StandardisedXML(20),
ReadyToDistribute(40),
AwaitingDistributeResponse(60),
ReadyToAutoboard(80),
ThrottleCheckPassed(100),
EligibilityCheckPassed(300),
SentToAutoboardService(400),
AutoboardingSuspended(450),
SuccessfullyBoarded(500),
QueueError(1000),
ThrottleCheckError(1100),
XmlStandardisationError(1200),
EligibilityCheckError(1300),
AutoboardingError(1400),
IneligibleThrottleLimit(2100),
IneligibleApplication(2300);
private final int value;
ApplicationQueueStatus(final int intValue) { value = intValue; }
public int getValue() { return value; }
}
@DataContract
public static enum ApplicationBoardingStatus
{
Pending(0),
InProgress(5),
Failed(9),
Completed(10);
private final int value;
ApplicationBoardingStatus(final int intValue) { value = intValue; }
public int getValue() { return value; }
}
}
Java OrderBoardingRequest 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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /OrderBoarding HTTP/1.1
Host: abservice-test.worldpay.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"correlationId":"00000000000000000000000000000000","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","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":{}}}},"onboardingRequestId":"00000000000000000000000000000000","localEnterpriseId":"00000000000000000000000000000000","audience":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"applicationGuid":"00000000000000000000000000000000","csr":0,"applicationQueueGuid":"00000000000000000000000000000000","queueStatus":"Queued","boardingStatus":"PENDING","errorMessages":["String"]}