Autoboard Webservice v5.13.0.0

<back to all web services

ApplicationBoarding

json-app
Requires Authentication
The following routes are available for this service:
POST/ApplicationBoarding

// @DataContract
export 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,
}

// @DataContract
export enum ApplicationBoardingStatus
{
    PENDING = 0,
    IN_PROGRESS = 5,
    FAILED = 9,
    COMPLETED = 10,
}

export class InitiateBoardingResponse
{
    public applicationGuid?: string;
    public csr?: number;
    public applicationQueueGuid?: string;
    public queueStatus?: ApplicationQueueStatus;
    public boardingStatus?: ApplicationBoardingStatus;
    public errorMessages?: string[];

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

export enum SourceSystemType
{
    MARS = 'MARS',
    ASA = 'ASA',
    OLS = 'OLS',
    INASA = 'INASA',
}

export enum CustomerType
{
    New = 0,
    Existing = 1,
    None = -1,
}

export class Partner
{
    public partnerId?: string;
    public partnerName?: string;

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

export enum PricingPackageType
{
    CustomUk = 0,
    MonthlyUk = 1,
    SimplicityUk = 2,
    PaygUk = 3,
    CustomRoi = 4,
    PaygeComUK = 5,
    None = -1,
}

export enum PreferredContactMethodType
{
    Email = 'Email',
    Telephone = 'Telephone',
    Any = 'Any',
}

export class ContactPerson
{
    public title?: string;
    public firstName?: string;
    public middleName?: string;
    public lastName?: string;
    public telephoneNumber?: string;
    public altTelephoneNumber?: string;
    public email?: string;
    public position?: string;
    public preferredContactMethod?: PreferredContactMethodType;
    public preferredContactBestTime?: string;

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

export class AuthorisedSigner extends ContactPerson
{
    public dateOfBirth?: string;
    public countryCode?: string;

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

export class AccessibilityOptions
{
    public audiotapeRequired?: boolean;
    public largePrintRequired?: boolean;
    public uncontractedBrailleGrade1Required?: boolean;
    public uncontractedBrailleGrade2Required?: boolean;
    public nextGenerationTextRequired?: boolean;

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

export class ApplicationDetails
{
    public sourceSystem?: SourceSystemType;
    public sourceSystemIdentifier?: string;
    public customerType?: CustomerType;
    public csr?: string;
    public partner?: Partner;
    public sellerCode?: string;
    public pricingPackage?: PricingPackageType;
    public contactPerson?: AuthorisedSigner;
    public specialInstructions?: string;
    public offerDetails?: string;
    public dateContractAccepted?: string;
    public worldpayBusinessFinanceInterest?: boolean;
    public sar?: boolean;
    public sellerEmail?: string;
    public anticipatedGoLiveDate?: string;
    public accessibilityOptions?: AccessibilityOptions;
    public ultimateParentId?: string;

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

export class Address
{
    public address1?: string;
    public address2?: string;
    public address3?: string;
    public postcode?: string;
    public city?: string;
    public state?: string;
    public countrycode?: string;

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

export class BusinessAddress extends Address
{
    public isCommercial?: boolean;

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

export enum CompanyType
{
    SoleTrader = 'SoleTrader',
    Partnership = 'Partnership',
    LimitedCompany = 'LimitedCompany',
    Trust = 'Trust',
    RegisteredCharity = 'RegisteredCharity',
    PublicLimitedCompany = 'PublicLimitedCompany',
    LimitedByGuarantee = 'LimitedByGuarantee',
    ClubSocietyAssociation = 'ClubSocietyAssociation',
    CommunityInterestCompanyOrIndustrialProvident = 'CommunityInterestCompanyOrIndustrialProvident',
    LimitedLiabilityPartnership = 'LimitedLiabilityPartnership',
    Other = 'Other',
}

export class Financials
{
    public annual?: number;
    public cardPercentage?: number;
    public creditCardPercentage?: number;
    public averageTransactionValue?: number;

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

export class TradeAssociation
{
    public groupName?: string;
    public memberNumber?: string;

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

export class Business
{
    public legalName?: string;
    public legalAddress?: BusinessAddress;
    public websiteAddress?: string;
    public companyType?: CompanyType;
    public companyTypeOther?: string;
    public companyRegistrationNumber?: string;
    public charityNumber?: string;
    public merchantCategoryCode?: string;
    public merchantCategoryDescription?: string;
    public descriptionOfGoodsAndServices?: string;
    public vatNumber?: string;
    public dateStartedTrading?: string;
    public countryOfIncorporation?: string;
    public regionOfIncorporation?: string;
    public financials?: Financials;
    public newToCards?: boolean;
    public tradeAssociation?: TradeAssociation;

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

export class PrincipalAddress extends Address
{
    public startDate?: string;
    public endDate?: string;

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

export enum PositionType
{
    SoleTrader = 0,
    Partner = 1,
    Director = 2,
    CompanySecretary = 3,
    ChiefFinancialOfficer = 4,
    Chairman = 5,
    DesignatedBoardMember = 7,
    Settlor = 8,
    Treasurer = 9,
    Trustee = 10,
    ChiefExecutive = 11,
    AuthorisedPersonWithConsent = 12,
    NonExecutiveDirector = 13,
    ContactPerson = 14,
    Shareholder = 15,
}

export class Principal
{
    public title?: string;
    public firstName?: string;
    public middleName?: string;
    public lastName?: string;
    public dateOfBirth?: string;
    public nationality?: string;
    public homeAddresses?: PrincipalAddress[];
    public ownershipPercentage?: number;
    public position?: PositionType;
    public isFinancialController?: boolean;

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

export class BankAccount
{
    public sortCode?: string;
    public accountNumber?: string;
    public bankName?: string;
    public bankAccountName?: string;

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

export class ClearingDetails
{
    public merchantUrl?: string;
    public telephone?: string;
    public email?: string;

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

export class OutletAllocatedProduct
{
    public id?: number;
    public quantity?: number;

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

export class Outlet
{
    public tradingName?: string;
    public tradingAddress?: BusinessAddress;
    public contactPerson?: ContactPerson;
    public terminalDeliveryAddress?: BusinessAddress;
    public correspondenceAddress?: BusinessAddress;
    public settlementBankAccount?: BankAccount;
    public chargesBankAccount?: BankAccount;
    public directDebitCorrespondenceEmail?: string;
    public clearingDetails?: ClearingDetails;
    public productAllocation?: OutletAllocatedProduct[];

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

export class Deposits
{
    public accepted?: boolean;
    public perOfSalesWhereInitialDepositTaken?: number;
    public sizePercOfTotalValue?: number;
    public avgTimeBeforeDeliveryTaken?: number;
    public avgTimeBeforeDeliveryBalanceTaken?: number;

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

export class WarrantiesAndGuarantees
{
    public levyCharge?: boolean;
    public percCardTurnover?: number;
    public avgLengthInMonths?: number;
    public percGoodsReturned?: number;
    public thirdPartyProviders?: string;

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

export class Prepayments
{
    public fullPaymentAcceptedPriorToSupply?: boolean;
    public percGoodsWherePaymentTakenPriorToDelivery?: number;
    public avgDaysPaymentTakenInAdvance?: number;

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

export class MembershipsSubscriptionAndInsurancePremiums
{
    public levyCharge?: boolean;
    public percCardTurnover?: number;
    public avgLengthInMonths?: number;
    public membershipCost?: number;

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

export class GoodsAndServices
{
    public goodsProvidedByThirdParty?: boolean;
    public deposits?: Deposits;
    public warrantiesAndGuarantees?: WarrantiesAndGuarantees;
    public prepayments?: Prepayments;
    public membershipsSubscriptionAndInsurancePremiums?: MembershipsSubscriptionAndInsurancePremiums;
    public stockHeldAtAnotherAddressLocation?: Address;

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

export class MerchantDetails
{
    public business?: Business;
    public principals?: Principal[];
    public outlets?: Outlet[];
    public goodsAndServices?: GoodsAndServices;

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

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

export class RateChargePair
{
    public percent?: number;
    public cost?: number;

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

export class CardCharge
{
    public cardType?: CardType;
    public purchase?: RateChargePair;
    public refund?: RateChargePair;

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

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

export class PremiumTransactionCharge
{
    public type?: PremiumTransactionChargeType;
    public creditCard?: RateChargePair;
    public debitCard?: RateChargePair;

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

export enum AdditionalTarrifType
{
    NameAndAddressCheck = 'NameAndAddressCheck',
    Auth = 'Auth',
    chargeback = 'chargeback',
    Mmsc = 'Mmsc',
    PaperStatement = 'PaperStatement',
    PciVerbalAssessment = 'PciVerbalAssessment',
    PciIpScan = 'PciIpScan',
    PciNonCompliance = 'PciNonCompliance',
    PciSaferPaymentsPlus = 'PciSaferPaymentsPlus',
    JoiningFee = 'JoiningFee',
    PayMonthlyAcquiringFee = 'PayMonthlyAcquiringFee',
    PciSaferPayments = 'PciSaferPayments',
}

export class AdditionalTarrif
{
    public type?: AdditionalTarrifType;
    public cost?: number;

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

export class Rates
{
    public cardCharges?: CardCharge[];
    public premiumTransactionCharges?: PremiumTransactionCharge[];
    public additionalTarrifs?: AdditionalTarrif[];

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

export class Cnp
{
    public required?: boolean;
    public percentage?: number;

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

export class Amex
{
    public required?: boolean;
    public existingAmexNumber?: string;

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

export class Services
{
    public cnp?: Cnp;
    public amex?: Amex;
    public cashbackRequired?: boolean;
    public worldpayDashboardRequired?: boolean;
    public paperInvoicingRequired?: boolean;

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

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

export class TradingCurrency
{
    public transactionCurrencies?: CurrencyCodeType[];
    public settlementCurrency?: CurrencyCodeType;
    public settlementBankSwift?: string;
    public settlementBankIban?: string;

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

export class Acquiring
{
    public settlementPeriodTPlus?: number;
    public rates?: Rates;
    public services?: Services;
    public tradingCurrencies?: TradingCurrency[];

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

export enum PosProductType
{
    Mobile = 'Mobile',
    Wifi = 'Wifi',
    Bluetooth = 'Bluetooth',
    Fixed = 'Fixed',
    PosMidOnly = 'PosMidOnly',
}

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

export class ProductFee
{
    public type?: ProductFeeType;
    public cost?: number;

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

export enum PosProductOptionType
{
    PSP = 'PSP',
}

export class PosProductOption
{
    public type?: PosProductOptionType;
    public value?: string;

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

export class PosProduct
{
    public id?: number;
    public type?: PosProductType;
    public quantity?: number;
    public relatedFees?: ProductFee[];
    public options?: PosProductOption[];

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

export class PosProducts
{
    public term?: number;
    public renewalLength?: number;
    public products?: PosProduct[];

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

export enum EcomProductType
{
    Gateway = 'Gateway',
    VirtualTerminal = 'VirtualTerminal',
    PayByLink = 'PayByLink',
    EcomMidOnly = 'EcomMidOnly',
}

export enum EcomProductOptionType
{
    PSP = 'PSP',
    FreeTransactions = 'FreeTransactions',
}

export class EcomProductOption
{
    public type?: EcomProductOptionType;
    public value?: string;

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

export class EcomProduct
{
    public id?: number;
    public type?: EcomProductType;
    public quantity?: number;
    public relatedFees?: ProductFee[];
    public options?: EcomProductOption[];

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

export enum EcomOptionType
{
    Paypal = 'Paypal',
    FuturePay = 'FuturePay',
    RMM = 'RMM',
}

export class EcomOption
{
    public type?: EcomOptionType;
    public relatedFees?: ProductFee[];

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

export class EcomProducts
{
    public term?: number;
    public renewalLength?: number;
    public products?: EcomProduct[];
    public options?: EcomOption[];

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

export class IspContact
{
    public title?: string;
    public firstName?: string;
    public lastName?: string;
    public position?: string;
    public emailAddress?: string;

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

export class IntegratedSolutionProvider
{
    public name?: string;
    public address?: Address;
    public telephone?: string;
    public primaryContact?: IspContact;
    public technicalContact?: IspContact;
    public providerType?: string;
    public providerSoftware?: string;

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

export enum WptProductType
{
    VerifoneP400 = 'VerifoneP400',
    IngenicoWL258 = 'IngenicoWL258',
    VerifoneV240 = 'VerifoneV240',
}

export enum WptVariantType
{
    Serial = 'Serial',
    Usb = 'Usb',
    Ethernet = 'Ethernet',
    None = 'None',
}

export class WptProduct
{
    public type?: WptProductType;
    public id?: number;
    public variant?: WptVariantType;
    public quantity?: number;
    public relatedFees?: ProductFee[];

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

export class WptProducts
{
    public term?: number;
    public renewalLength?: number;
    public posInstallationDate?: string;
    public integratedSolutionProvider?: IntegratedSolutionProvider;
    public products?: WptProduct[];

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

export enum IpProductType
{
    PaxA920 = 'PaxA920',
    MiuraM020 = 'MiuraM020',
}

export enum IpVariantType
{
    Sdk = 'Sdk',
    Cloud = 'Cloud',
    None = 'None',
}

export class IpProduct
{
    public id?: number;
    public type?: IpProductType;
    public quantity?: number;
    public relatedFees?: ProductFee[];
    public variant?: IpVariantType;

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

export class IpProducts
{
    public term?: number;
    public renewalLength?: number;
    public integratedSolutionProvider?: IntegratedSolutionProvider;
    public products?: IpProduct[];

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

export class Products
{
    public posProducts?: PosProducts;
    public ecomProducts?: EcomProducts;
    public wptProducts?: WptProducts;
    public ipProducts?: IpProducts;

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

export class Application
{
    public applicationDetails?: ApplicationDetails;
    public merchantDetails?: MerchantDetails;
    public acquiring?: Acquiring;
    public products?: Products;

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

export class ApplicationBoarding
{
    public correlationId?: string;
    public csr?: number;
    public sellerCode?: string;
    public sellerEmail?: string;
    public applicationSource?: number;
    public applicationJson?: Application;

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

TypeScript ApplicationBoarding DTOs

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

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /ApplicationBoarding HTTP/1.1 
Host: abservice-test.worldpay.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ApplicationBoarding xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Autoboarding.Common.Requests">
  <ApplicationJson xmlns:d2p1="http://schemas.datacontract.org/2004/07/BoardingGateway.Common.Requests.Boarding">
    <d2p1:Acquiring xmlns:d3p1="http://schemas.datacontract.org/2004/07/BoardingGateway.Common.Requests.Boarding.Acquiring">
      <d3p1:Rates>
        <d3p1:AdditionalTarrifs i:nil="true" />
        <d3p1:CardCharges i:nil="true" />
        <d3p1:PremiumTransactionCharges i:nil="true" />
      </d3p1:Rates>
      <d3p1:Services xmlns:d4p1="http://schemas.datacontract.org/2004/07/BoardingGateway.Common.Requests.Boarding.Acquiring.Services">
        <d4p1:Amex>
          <d4p1:ExistingAmexNumber>String</d4p1:ExistingAmexNumber>
          <d4p1:Required>false</d4p1:Required>
        </d4p1:Amex>
        <d4p1:CashbackRequired>false</d4p1:CashbackRequired>
        <d4p1:Cnp>
          <d4p1:Percentage>0</d4p1:Percentage>
          <d4p1:Required>false</d4p1:Required>
        </d4p1:Cnp>
        <d4p1:PaperInvoicingRequired>false</d4p1:PaperInvoicingRequired>
        <d4p1:WorldpayDashboardRequired>false</d4p1:WorldpayDashboardRequired>
      </d3p1:Services>
      <d3p1:SettlementPeriodTPlus>0</d3p1:SettlementPeriodTPlus>
      <d3p1:TradingCurrencies i:nil="true" />
    </d2p1:Acquiring>
    <d2p1:ApplicationDetails>
      <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:AnticipatedGoLiveDate>0001-01-01T00:00:00</d2p1:AnticipatedGoLiveDate>
      <d2p1:ContactPerson xmlns:d4p1="http://schemas.datacontract.org/2004/07/BoardingGateway.Common.Requests.Boarding.BusinessDetails">
        <d4p1:AltTelephoneNumber>String</d4p1:AltTelephoneNumber>
        <d4p1:Email>String</d4p1:Email>
        <d4p1:FirstName>String</d4p1:FirstName>
        <d4p1:LastName>String</d4p1:LastName>
        <d4p1:MiddleName>String</d4p1:MiddleName>
        <d4p1:Position>String</d4p1:Position>
        <d4p1:PreferredContactBestTime>String</d4p1:PreferredContactBestTime>
        <d4p1:PreferredContactMethod>Email</d4p1:PreferredContactMethod>
        <d4p1:TelephoneNumber>String</d4p1:TelephoneNumber>
        <d4p1:Title>String</d4p1:Title>
        <d4p1:CountryCode>String</d4p1:CountryCode>
        <d4p1:DateOfBirth>0001-01-01T00:00:00</d4p1:DateOfBirth>
      </d2p1:ContactPerson>
      <d2p1:Csr>String</d2p1:Csr>
      <d2p1:CustomerType>New</d2p1:CustomerType>
      <d2p1:DateContractAccepted>0001-01-01T00:00:00</d2p1:DateContractAccepted>
      <d2p1:OfferDetails>String</d2p1:OfferDetails>
      <d2p1:Partner>
        <d2p1:PartnerId>String</d2p1:PartnerId>
        <d2p1:PartnerName>String</d2p1:PartnerName>
      </d2p1:Partner>
      <d2p1:PricingPackage>CustomUk</d2p1:PricingPackage>
      <d2p1:Sar>false</d2p1:Sar>
      <d2p1:SellerCode>String</d2p1:SellerCode>
      <d2p1:SellerEmail>String</d2p1:SellerEmail>
      <d2p1:SourceSystem>MARS</d2p1:SourceSystem>
      <d2p1:SourceSystemIdentifier>String</d2p1:SourceSystemIdentifier>
      <d2p1:SpecialInstructions>String</d2p1:SpecialInstructions>
      <d2p1:UltimateParentId>String</d2p1:UltimateParentId>
      <d2p1:WorldpayBusinessFinanceInterest>false</d2p1:WorldpayBusinessFinanceInterest>
    </d2p1:ApplicationDetails>
    <d2p1:MerchantDetails xmlns:d3p1="http://schemas.datacontract.org/2004/07/BoardingGateway.Common.Requests.Boarding.BusinessDetails">
      <d3p1:Business>
        <d3p1:CharityNumber>String</d3p1:CharityNumber>
        <d3p1:CompanyRegistrationNumber>String</d3p1:CompanyRegistrationNumber>
        <d3p1:CompanyType>SoleTrader</d3p1:CompanyType>
        <d3p1:CompanyTypeOther>String</d3p1:CompanyTypeOther>
        <d3p1:CountryOfIncorporation>String</d3p1:CountryOfIncorporation>
        <d3p1:DateStartedTrading>0001-01-01T00:00:00</d3p1:DateStartedTrading>
        <d3p1:DescriptionOfGoodsAndServices>String</d3p1:DescriptionOfGoodsAndServices>
        <d3p1:Financials>
          <d3p1:Annual>0</d3p1:Annual>
          <d3p1:AverageTransactionValue>0</d3p1:AverageTransactionValue>
          <d3p1:CardPercentage>0</d3p1:CardPercentage>
          <d3p1:CreditCardPercentage>0</d3p1:CreditCardPercentage>
        </d3p1:Financials>
        <d3p1:LegalAddress>
          <d3p1:Address1>String</d3p1:Address1>
          <d3p1:Address2>String</d3p1:Address2>
          <d3p1:Address3>String</d3p1:Address3>
          <d3p1:City>String</d3p1:City>
          <d3p1:Countrycode>String</d3p1:Countrycode>
          <d3p1:Postcode>String</d3p1:Postcode>
          <d3p1:State>String</d3p1:State>
          <d3p1:IsCommercial>false</d3p1:IsCommercial>
        </d3p1:LegalAddress>
        <d3p1:LegalName>String</d3p1:LegalName>
        <d3p1:MerchantCategoryCode>String</d3p1:MerchantCategoryCode>
        <d3p1:MerchantCategoryDescription>String</d3p1:MerchantCategoryDescription>
        <d3p1:NewToCards>false</d3p1:NewToCards>
        <d3p1:RegionOfIncorporation>String</d3p1:RegionOfIncorporation>
        <d3p1:TradeAssociation>
          <d3p1:GroupName>String</d3p1:GroupName>
          <d3p1:MemberNumber>String</d3p1:MemberNumber>
        </d3p1:TradeAssociation>
        <d3p1:VatNumber>String</d3p1:VatNumber>
        <d3p1:WebsiteAddress>String</d3p1:WebsiteAddress>
      </d3p1:Business>
      <d3p1:GoodsAndServices xmlns:d4p1="http://schemas.datacontract.org/2004/07/BoardingGateway.Common.Requests.Boarding.BusinessDetails.GoodsAndServices">
        <d4p1:Deposits>
          <d4p1:Accepted>false</d4p1:Accepted>
          <d4p1:AvgTimeBeforeDeliveryBalanceTaken>0</d4p1:AvgTimeBeforeDeliveryBalanceTaken>
          <d4p1:AvgTimeBeforeDeliveryTaken>0</d4p1:AvgTimeBeforeDeliveryTaken>
          <d4p1:PerOfSalesWhereInitialDepositTaken>0</d4p1:PerOfSalesWhereInitialDepositTaken>
          <d4p1:SizePercOfTotalValue>0</d4p1:SizePercOfTotalValue>
        </d4p1:Deposits>
        <d4p1:GoodsProvidedByThirdParty>false</d4p1:GoodsProvidedByThirdParty>
        <d4p1:MembershipsSubscriptionAndInsurancePremiums>
          <d4p1:AvgLengthInMonths>0</d4p1:AvgLengthInMonths>
          <d4p1:LevyCharge>false</d4p1:LevyCharge>
          <d4p1:MembershipCost>0</d4p1:MembershipCost>
          <d4p1:PercCardTurnover>0</d4p1:PercCardTurnover>
        </d4p1:MembershipsSubscriptionAndInsurancePremiums>
        <d4p1:Prepayments>
          <d4p1:AvgDaysPaymentTakenInAdvance>0</d4p1:AvgDaysPaymentTakenInAdvance>
          <d4p1:FullPaymentAcceptedPriorToSupply>false</d4p1:FullPaymentAcceptedPriorToSupply>
          <d4p1:PercGoodsWherePaymentTakenPriorToDelivery>0</d4p1:PercGoodsWherePaymentTakenPriorToDelivery>
        </d4p1:Prepayments>
        <d4p1:StockHeldAtAnotherAddressLocation>
          <d3p1:Address1>String</d3p1:Address1>
          <d3p1:Address2>String</d3p1:Address2>
          <d3p1:Address3>String</d3p1:Address3>
          <d3p1:City>String</d3p1:City>
          <d3p1:Countrycode>String</d3p1:Countrycode>
          <d3p1:Postcode>String</d3p1:Postcode>
          <d3p1:State>String</d3p1:State>
        </d4p1:StockHeldAtAnotherAddressLocation>
        <d4p1:WarrantiesAndGuarantees>
          <d4p1:AvgLengthInMonths>0</d4p1:AvgLengthInMonths>
          <d4p1:LevyCharge>false</d4p1:LevyCharge>
          <d4p1:PercCardTurnover>0</d4p1:PercCardTurnover>
          <d4p1:PercGoodsReturned>0</d4p1:PercGoodsReturned>
          <d4p1:ThirdPartyProviders>String</d4p1:ThirdPartyProviders>
        </d4p1:WarrantiesAndGuarantees>
      </d3p1:GoodsAndServices>
      <d3p1:Outlets i:nil="true" />
      <d3p1:Principals i:nil="true" />
    </d2p1:MerchantDetails>
    <d2p1:Products xmlns:d3p1="http://schemas.datacontract.org/2004/07/BoardingGateway.Common.Requests.Boarding.Products">
      <d3p1:EcomProducts xmlns:d4p1="http://schemas.datacontract.org/2004/07/BoardingGateway.Common.Requests.Boarding.Products.EcomProducts">
        <d4p1:Options i:nil="true" />
        <d4p1:Products i:nil="true" />
        <d4p1:RenewalLength>0</d4p1:RenewalLength>
        <d4p1:Term>0</d4p1:Term>
      </d3p1:EcomProducts>
      <d3p1:IpProducts xmlns:d4p1="http://schemas.datacontract.org/2004/07/BoardingGateway.Common.Requests.Boarding.Products.IpProducts">
        <d4p1:IntegratedSolutionProvider xmlns:d5p1="http://schemas.datacontract.org/2004/07/BoardingGateway.Common.Requests.Boarding.Products.WptProducts">
          <d5p1:Address xmlns:d6p1="http://schemas.datacontract.org/2004/07/BoardingGateway.Common.Requests.Boarding.BusinessDetails">
            <d6p1:Address1>String</d6p1:Address1>
            <d6p1:Address2>String</d6p1:Address2>
            <d6p1:Address3>String</d6p1:Address3>
            <d6p1:City>String</d6p1:City>
            <d6p1:Countrycode>String</d6p1:Countrycode>
            <d6p1:Postcode>String</d6p1:Postcode>
            <d6p1:State>String</d6p1:State>
          </d5p1:Address>
          <d5p1:Name>String</d5p1:Name>
          <d5p1:PrimaryContact>
            <d5p1:EmailAddress>String</d5p1:EmailAddress>
            <d5p1:FirstName>String</d5p1:FirstName>
            <d5p1:LastName>String</d5p1:LastName>
            <d5p1:Position>String</d5p1:Position>
            <d5p1:Title>String</d5p1:Title>
          </d5p1:PrimaryContact>
          <d5p1:ProviderSoftware>String</d5p1:ProviderSoftware>
          <d5p1:ProviderType>String</d5p1:ProviderType>
          <d5p1:TechnicalContact>
            <d5p1:EmailAddress>String</d5p1:EmailAddress>
            <d5p1:FirstName>String</d5p1:FirstName>
            <d5p1:LastName>String</d5p1:LastName>
            <d5p1:Position>String</d5p1:Position>
            <d5p1:Title>String</d5p1:Title>
          </d5p1:TechnicalContact>
          <d5p1:Telephone>String</d5p1:Telephone>
        </d4p1:IntegratedSolutionProvider>
        <d4p1:Products i:nil="true" />
        <d4p1:RenewalLength>0</d4p1:RenewalLength>
        <d4p1:Term>0</d4p1:Term>
      </d3p1:IpProducts>
      <d3p1:PosProducts xmlns:d4p1="http://schemas.datacontract.org/2004/07/BoardingGateway.Common.Requests.Boarding.Products.PosProducts">
        <d4p1:Products i:nil="true" />
        <d4p1:RenewalLength>0</d4p1:RenewalLength>
        <d4p1:Term>0</d4p1:Term>
      </d3p1:PosProducts>
      <d3p1:WptProducts xmlns:d4p1="http://schemas.datacontract.org/2004/07/BoardingGateway.Common.Requests.Boarding.Products.WptProducts">
        <d4p1:IntegratedSolutionProvider>
          <d4p1:Address xmlns:d6p1="http://schemas.datacontract.org/2004/07/BoardingGateway.Common.Requests.Boarding.BusinessDetails">
            <d6p1:Address1>String</d6p1:Address1>
            <d6p1:Address2>String</d6p1:Address2>
            <d6p1:Address3>String</d6p1:Address3>
            <d6p1:City>String</d6p1:City>
            <d6p1:Countrycode>String</d6p1:Countrycode>
            <d6p1:Postcode>String</d6p1:Postcode>
            <d6p1:State>String</d6p1:State>
          </d4p1:Address>
          <d4p1:Name>String</d4p1:Name>
          <d4p1:PrimaryContact>
            <d4p1:EmailAddress>String</d4p1:EmailAddress>
            <d4p1:FirstName>String</d4p1:FirstName>
            <d4p1:LastName>String</d4p1:LastName>
            <d4p1:Position>String</d4p1:Position>
            <d4p1:Title>String</d4p1:Title>
          </d4p1:PrimaryContact>
          <d4p1:ProviderSoftware>String</d4p1:ProviderSoftware>
          <d4p1:ProviderType>String</d4p1:ProviderType>
          <d4p1:TechnicalContact>
            <d4p1:EmailAddress>String</d4p1:EmailAddress>
            <d4p1:FirstName>String</d4p1:FirstName>
            <d4p1:LastName>String</d4p1:LastName>
            <d4p1:Position>String</d4p1:Position>
            <d4p1:Title>String</d4p1:Title>
          </d4p1:TechnicalContact>
          <d4p1:Telephone>String</d4p1:Telephone>
        </d4p1:IntegratedSolutionProvider>
        <d4p1:PosInstallationDate>0001-01-01T00:00:00</d4p1:PosInstallationDate>
        <d4p1:Products i:nil="true" />
        <d4p1:RenewalLength>0</d4p1:RenewalLength>
        <d4p1:Term>0</d4p1:Term>
      </d3p1:WptProducts>
    </d2p1:Products>
  </ApplicationJson>
  <ApplicationSource>0</ApplicationSource>
  <CorrelationId>00000000-0000-0000-0000-000000000000</CorrelationId>
  <Csr>0</Csr>
  <SellerCode>String</SellerCode>
  <SellerEmail>String</SellerEmail>
</ApplicationBoarding>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<InitiateBoardingResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Autoboarding.Common.Responses">
  <ApplicationGuid>00000000-0000-0000-0000-000000000000</ApplicationGuid>
  <ApplicationQueueGuid>00000000-0000-0000-0000-000000000000</ApplicationQueueGuid>
  <BoardingStatus>PENDING</BoardingStatus>
  <CSR>0</CSR>
  <ErrorMessages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ErrorMessages>
  <QueueStatus>Queued</QueueStatus>
</InitiateBoardingResponse>