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
ApplicationBoarding Parameters:
NameParameterData TypeRequiredDescription
CorrelationIdbodyGuidNo
CsrbodyintNo
SellerCodebodystringNo
SellerEmailbodystringNo
ApplicationSourcebodyintNo
ApplicationJsonbodyApplicationNo
Application Parameters:
NameParameterData TypeRequiredDescription
ApplicationDetailsformApplicationDetailsNo
MerchantDetailsformMerchantDetailsNo
AcquiringformAcquiringNo
ProductsformProductsNo
ApplicationDetails Parameters:
NameParameterData TypeRequiredDescription
SourceSystemformSourceSystemTypeNo
SourceSystemIdentifierformstringNo
CustomerTypeformCustomerTypeNo
CsrformstringNo
PartnerformPartnerNo
SellerCodeformstringNo
PricingPackageformPricingPackageTypeNo
ContactPersonformAuthorisedSignerNo
SpecialInstructionsformstringNo
OfferDetailsformstringNo
DateContractAcceptedformDateTimeNo
WorldpayBusinessFinanceInterestformbool?No
Sarformbool?No
SellerEmailformstringNo
AnticipatedGoLiveDateformDateTime?No
AccessibilityOptionsformAccessibilityOptionsNo
UltimateParentIdformstringNo
SourceSystemType Enum:
MARS
ASA
OLS
INASA
CustomerType Enum:
NameValue
New0
Existing1
None-1
Partner Parameters:
NameParameterData TypeRequiredDescription
PartnerIdformstringNo
PartnerNameformstringNo
PricingPackageType Enum:
NameValue
CustomUk0
MonthlyUk1
SimplicityUk2
PaygUk3
CustomRoi4
PaygeComUK5
None-1
AuthorisedSigner Parameters:
NameParameterData TypeRequiredDescription
DateOfBirthformDateTime?No
CountryCodeformstringNo
ContactPerson Parameters:
NameParameterData TypeRequiredDescription
TitleformstringNo
FirstNameformstringNo
MiddleNameformstringNo
LastNameformstringNo
TelephoneNumberformstringNo
AltTelephoneNumberformstringNo
EmailformstringNo
PositionformstringNo
PreferredContactMethodformPreferredContactMethodTypeNo
PreferredContactBestTimeformstringNo
PreferredContactMethodType Enum:
Email
Telephone
Any
AccessibilityOptions Parameters:
NameParameterData TypeRequiredDescription
AudiotapeRequiredformbool?No
LargePrintRequiredformbool?No
UncontractedBrailleGrade1Requiredformbool?No
UncontractedBrailleGrade2Requiredformbool?No
NextGenerationTextRequiredformbool?No
MerchantDetails Parameters:
NameParameterData TypeRequiredDescription
BusinessformBusinessNo
PrincipalsformIEnumerable<Principal>No
OutletsformIEnumerable<Outlet>No
GoodsAndServicesformGoodsAndServicesNo
Business Parameters:
NameParameterData TypeRequiredDescription
LegalNameformstringNo
LegalAddressformBusinessAddressNo
WebsiteAddressformstringNo
CompanyTypeformCompanyTypeNo
CompanyTypeOtherformstringNo
CompanyRegistrationNumberformstringNo
CharityNumberformstringNo
MerchantCategoryCodeformstringNo
MerchantCategoryDescriptionformstringNo
DescriptionOfGoodsAndServicesformstringNo
VatNumberformstringNo
DateStartedTradingformDateTime?No
CountryOfIncorporationformstringNo
RegionOfIncorporationformstringNo
FinancialsformFinancialsNo
NewToCardsformboolNo
TradeAssociationformTradeAssociationNo
BusinessAddress Parameters:
NameParameterData TypeRequiredDescription
IsCommercialformbool?No
Address Parameters:
NameParameterData TypeRequiredDescription
Address1formstringNo
Address2formstringNo
Address3formstringNo
PostcodeformstringNo
CityformstringNo
StateformstringNo
CountrycodeformstringNo
CompanyType Enum:
SoleTrader
Partnership
LimitedCompany
Trust
RegisteredCharity
PublicLimitedCompany
LimitedByGuarantee
ClubSocietyAssociation
CommunityInterestCompanyOrIndustrialProvident
LimitedLiabilityPartnership
Other
Financials Parameters:
NameParameterData TypeRequiredDescription
AnnualformdecimalNo
CardPercentageformdecimalNo
CreditCardPercentageformdecimalNo
AverageTransactionValueformdecimalNo
TradeAssociation Parameters:
NameParameterData TypeRequiredDescription
GroupNameformstringNo
MemberNumberformstringNo
Principal Parameters:
NameParameterData TypeRequiredDescription
TitleformstringNo
FirstNameformstringNo
MiddleNameformstringNo
LastNameformstringNo
DateOfBirthformDateTimeNo
NationalityformstringNo
HomeAddressesformIEnumerable<PrincipalAddress>No
OwnershipPercentageformdecimalNo
PositionformPositionTypeNo
IsFinancialControllerformbool?No
PrincipalAddress Parameters:
NameParameterData TypeRequiredDescription
StartDateformDateTimeNo
EndDateformDateTime?No
PositionType Enum:
NameValue
SoleTrader0
Partner1
Director2
CompanySecretary3
ChiefFinancialOfficer4
Chairman5
DesignatedBoardMember7
Settlor8
Treasurer9
Trustee10
ChiefExecutive11
AuthorisedPersonWithConsent12
NonExecutiveDirector13
ContactPerson14
Shareholder15
Outlet Parameters:
NameParameterData TypeRequiredDescription
TradingNameformstringNo
TradingAddressformBusinessAddressNo
ContactPersonformContactPersonNo
TerminalDeliveryAddressformBusinessAddressNo
CorrespondenceAddressformBusinessAddressNo
SettlementBankAccountformBankAccountNo
ChargesBankAccountformBankAccountNo
DirectDebitCorrespondenceEmailformstringNo
ClearingDetailsformClearingDetailsNo
ProductAllocationformIEnumerable<OutletAllocatedProduct>No
BankAccount Parameters:
NameParameterData TypeRequiredDescription
SortCodeformstringNo
AccountNumberformstringNo
BankNameformstringNo
BankAccountNameformstringNo
ClearingDetails Parameters:
NameParameterData TypeRequiredDescription
MerchantUrlformstringNo
TelephoneformstringNo
EmailformstringNo
OutletAllocatedProduct Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
QuantityformintNo
GoodsAndServices Parameters:
NameParameterData TypeRequiredDescription
GoodsProvidedByThirdPartyformbool?No
DepositsformDepositsNo
WarrantiesAndGuaranteesformWarrantiesAndGuaranteesNo
PrepaymentsformPrepaymentsNo
MembershipsSubscriptionAndInsurancePremiumsformMembershipsSubscriptionAndInsurancePremiumsNo
StockHeldAtAnotherAddressLocationformAddressNo
Deposits Parameters:
NameParameterData TypeRequiredDescription
Acceptedformbool?No
PerOfSalesWhereInitialDepositTakenformint?No
SizePercOfTotalValueformint?No
AvgTimeBeforeDeliveryTakenformint?No
AvgTimeBeforeDeliveryBalanceTakenformint?No
WarrantiesAndGuarantees Parameters:
NameParameterData TypeRequiredDescription
LevyChargeformbool?No
PercCardTurnoverformint?No
AvgLengthInMonthsformint?No
PercGoodsReturnedformint?No
ThirdPartyProvidersformstringNo
Prepayments Parameters:
NameParameterData TypeRequiredDescription
FullPaymentAcceptedPriorToSupplyformbool?No
PercGoodsWherePaymentTakenPriorToDeliveryformint?No
AvgDaysPaymentTakenInAdvanceformint?No
MembershipsSubscriptionAndInsurancePremiums Parameters:
NameParameterData TypeRequiredDescription
LevyChargeformbool?No
PercCardTurnoverformint?No
AvgLengthInMonthsformint?No
MembershipCostformdecimal?No
Acquiring Parameters:
NameParameterData TypeRequiredDescription
SettlementPeriodTPlusformintNo
RatesformRatesNo
ServicesformServicesNo
TradingCurrenciesformIEnumerable<TradingCurrency>No
Rates Parameters:
NameParameterData TypeRequiredDescription
CardChargesformIEnumerable<CardCharge>No
PremiumTransactionChargesformIEnumerable<PremiumTransactionCharge>No
AdditionalTarrifsformIEnumerable<AdditionalTarrif>No
CardCharge Parameters:
NameParameterData TypeRequiredDescription
CardTypeformCardTypeNo
PurchaseformRateChargePairNo
RefundformRateChargePairNo
CardType Enum:
VisaDebit
VisaCredit
VisaCommercial
MastercardDebit
MastercardCredit
MastercardCommercial
MastercardWorldSignia
JcbCredit
JcbDebit
JcbCommercial
DinersDiscoverCredit
DinersDiscoverDebit
DinersDiscoverCommercial
Amex
ChinaUnionPayCredit
ChinaUnionPayDebit
ChinaUnionPayCommercial
VisaBusinessDebit
MastercardBusiness
RateChargePair Parameters:
NameParameterData TypeRequiredDescription
Percentformdecimal?No
Costformdecimal?No
PremiumTransactionCharge Parameters:
NameParameterData TypeRequiredDescription
TypeformPremiumTransactionChargeTypeNo
CreditCardformRateChargePairNo
DebitCardformRateChargePairNo
PremiumTransactionChargeType Enum:
Magstripe
CnpMoto
Paper
PanKeyEntry
SecureEcom
NonSecureEcom
InterRegional
IntraRegional
NonAuth
AdditionalTarrif Parameters:
NameParameterData TypeRequiredDescription
TypeformAdditionalTarrifTypeNo
CostformdecimalNo
AdditionalTarrifType Enum:
NameAndAddressCheck
Auth
chargeback
Mmsc
PaperStatement
PciVerbalAssessment
PciIpScan
PciNonCompliance
PciSaferPaymentsPlus
JoiningFee
PayMonthlyAcquiringFee
PciSaferPayments
Services Parameters:
NameParameterData TypeRequiredDescription
CnpformCnpNo
AmexformAmexNo
CashbackRequiredformboolNo
WorldpayDashboardRequiredformboolNo
PaperInvoicingRequiredformboolNo
Cnp Parameters:
NameParameterData TypeRequiredDescription
RequiredformboolNo
PercentageformdecimalNo
Amex Parameters:
NameParameterData TypeRequiredDescription
RequiredformboolNo
ExistingAmexNumberformstringNo
TradingCurrency Parameters:
NameParameterData TypeRequiredDescription
TransactionCurrenciesformIEnumerable<CurrencyCodeType>No
SettlementCurrencyformCurrencyCodeTypeNo
SettlementBankSwiftformstringNo
SettlementBankIbanformstringNo
CurrencyCodeType Enum:
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
Products Parameters:
NameParameterData TypeRequiredDescription
PosProductsformPosProductsNo
EcomProductsformEcomProductsNo
WptProductsformWptProductsNo
IpProductsformIpProductsNo
PosProducts Parameters:
NameParameterData TypeRequiredDescription
Termformint?No
RenewalLengthformint?No
ProductsformIEnumerable<PosProduct>No
PosProduct Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
TypeformPosProductTypeNo
QuantityformintNo
RelatedFeesformIEnumerable<ProductFee>No
OptionsformIEnumerable<PosProductOption>No
PosProductType Enum:
Mobile
Wifi
Bluetooth
Fixed
PosMidOnly
ProductFee Parameters:
NameParameterData TypeRequiredDescription
TypeformProductFeeTypeNo
CostformdecimalNo
ProductFeeType Enum:
HireCost
TransactionCost
ServiceFee
ManagedServiceSetup
ManagedServiceMonthly
PosProductOption Parameters:
NameParameterData TypeRequiredDescription
TypeformPosProductOptionTypeNo
ValueformstringNo
PosProductOptionType Enum:
PSP
EcomProducts Parameters:
NameParameterData TypeRequiredDescription
Termformint?No
RenewalLengthformint?No
ProductsformIEnumerable<EcomProduct>No
OptionsformIEnumerable<EcomOption>No
EcomProduct Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
TypeformEcomProductTypeNo
QuantityformintNo
RelatedFeesformIEnumerable<ProductFee>No
OptionsformIEnumerable<EcomProductOption>No
EcomProductType Enum:
Gateway
VirtualTerminal
PayByLink
EcomMidOnly
EcomProductOption Parameters:
NameParameterData TypeRequiredDescription
TypeformEcomProductOptionTypeNo
ValueformstringNo
EcomProductOptionType Enum:
PSP
FreeTransactions
EcomOption Parameters:
NameParameterData TypeRequiredDescription
TypeformEcomOptionTypeNo
RelatedFeesformIEnumerable<ProductFee>No
EcomOptionType Enum:
Paypal
FuturePay
RMM
WptProducts Parameters:
NameParameterData TypeRequiredDescription
Termformint?No
RenewalLengthformint?No
PosInstallationDateformDateTimeNo
IntegratedSolutionProviderformIntegratedSolutionProviderNo
ProductsformIEnumerable<WptProduct>No
IntegratedSolutionProvider Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
AddressformAddressNo
TelephoneformstringNo
PrimaryContactformIspContactNo
TechnicalContactformIspContactNo
ProviderTypeformstringNo
ProviderSoftwareformstringNo
IspContact Parameters:
NameParameterData TypeRequiredDescription
TitleformstringNo
FirstNameformstringNo
LastNameformstringNo
PositionformstringNo
EmailAddressformstringNo
WptProduct Parameters:
NameParameterData TypeRequiredDescription
TypeformWptProductTypeNo
IdformintNo
VariantformWptVariantType?No
QuantityformintNo
RelatedFeesformIEnumerable<ProductFee>No
WptProductType Enum:
VerifoneP400
IngenicoWL258
VerifoneV240
WptVariantType Enum:
Serial
Usb
Ethernet
None
IpProducts Parameters:
NameParameterData TypeRequiredDescription
Termformint?No
RenewalLengthformint?No
IntegratedSolutionProviderformIntegratedSolutionProviderNo
ProductsformIEnumerable<IpProduct>No
IpProduct Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
TypeformIpProductTypeNo
QuantityformintNo
RelatedFeesformIEnumerable<ProductFee>No
VariantformIpVariantType?No
IpProductType Enum:
PaxA920
MiuraM020
IpVariantType Enum:
Sdk
Cloud
None
InitiateBoardingResponse Parameters:
NameParameterData TypeRequiredDescription
ApplicationGuidformGuidNo
CSRformintNo
ApplicationQueueGuidformGuid?No
QueueStatusformApplicationQueueStatusNo
BoardingStatusformApplicationBoardingStatus?No
ErrorMessagesformList<string>No
ApplicationQueueStatus Enum:
NameValue
Queued0
StandardisedXML20
ReadyToDistribute40
AwaitingDistributeResponse60
ReadyToAutoboard80
ThrottleCheckPassed100
EligibilityCheckPassed300
SentToAutoboardService400
AutoboardingSuspended450
SuccessfullyBoarded500
QueueError1000
ThrottleCheckError1100
XMLStandardisationError1200
EligibilityCheckError1300
AutoboardingError1400
IneligibleThrottleLimit2100
IneligibleApplication2300
ApplicationBoardingStatus Enum:
NameValue
PENDING0
IN_PROGRESS5
FAILED9
COMPLETED10

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

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

HTTP + JSON

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

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

{"correlationId":"00000000000000000000000000000000","csr":0,"sellerCode":"String","sellerEmail":"String","applicationSource":0,"applicationJson":{"applicationDetails":{"sourceSystem":"MARS","sourceSystemIdentifier":"String","customerType":"New","csr":"String","partner":{"partnerId":"String","partnerName":"String"},"sellerCode":"String","pricingPackage":"CustomUk","contactPerson":{"dateOfBirth":"\/Date(-62135596800000-0000)\/","countryCode":"String","title":"String","firstName":"String","middleName":"String","lastName":"String","telephoneNumber":"String","altTelephoneNumber":"String","email":"String","position":"String","preferredContactMethod":"Email","preferredContactBestTime":"String"},"specialInstructions":"String","offerDetails":"String","dateContractAccepted":"\/Date(-62135596800000-0000)\/","worldpayBusinessFinanceInterest":false,"sar":false,"sellerEmail":"String","anticipatedGoLiveDate":"\/Date(-62135596800000-0000)\/","accessibilityOptions":{"audiotapeRequired":false,"largePrintRequired":false,"uncontractedBrailleGrade1Required":false,"uncontractedBrailleGrade2Required":false,"nextGenerationTextRequired":false},"ultimateParentId":"String"},"merchantDetails":{"business":{"legalName":"String","legalAddress":{"isCommercial":false,"address1":"String","address2":"String","address3":"String","postcode":"String","city":"String","state":"String","countrycode":"String"},"websiteAddress":"String","companyType":"SoleTrader","companyTypeOther":"String","companyRegistrationNumber":"String","charityNumber":"String","merchantCategoryCode":"String","merchantCategoryDescription":"String","descriptionOfGoodsAndServices":"String","vatNumber":"String","dateStartedTrading":"\/Date(-62135596800000-0000)\/","countryOfIncorporation":"String","regionOfIncorporation":"String","financials":{"annual":0,"cardPercentage":0,"creditCardPercentage":0,"averageTransactionValue":0},"newToCards":false,"tradeAssociation":{"groupName":"String","memberNumber":"String"}},"goodsAndServices":{"goodsProvidedByThirdParty":false,"deposits":{"accepted":false,"perOfSalesWhereInitialDepositTaken":0,"sizePercOfTotalValue":0,"avgTimeBeforeDeliveryTaken":0,"avgTimeBeforeDeliveryBalanceTaken":0},"warrantiesAndGuarantees":{"levyCharge":false,"percCardTurnover":0,"avgLengthInMonths":0,"percGoodsReturned":0,"thirdPartyProviders":"String"},"prepayments":{"fullPaymentAcceptedPriorToSupply":false,"percGoodsWherePaymentTakenPriorToDelivery":0,"avgDaysPaymentTakenInAdvance":0},"membershipsSubscriptionAndInsurancePremiums":{"levyCharge":false,"percCardTurnover":0,"avgLengthInMonths":0,"membershipCost":0},"stockHeldAtAnotherAddressLocation":{"address1":"String","address2":"String","address3":"String","postcode":"String","city":"String","state":"String","countrycode":"String"}}},"acquiring":{"settlementPeriodTPlus":0,"rates":{},"services":{"cnp":{"required":false,"percentage":0},"amex":{"required":false,"existingAmexNumber":"String"},"cashbackRequired":false,"worldpayDashboardRequired":false,"paperInvoicingRequired":false}},"products":{"posProducts":{"term":0,"renewalLength":0},"ecomProducts":{"term":0,"renewalLength":0},"wptProducts":{"term":0,"renewalLength":0,"posInstallationDate":"\/Date(-62135596800000-0000)\/","integratedSolutionProvider":{"name":"String","address":{"address1":"String","address2":"String","address3":"String","postcode":"String","city":"String","state":"String","countrycode":"String"},"telephone":"String","primaryContact":{"title":"String","firstName":"String","lastName":"String","position":"String","emailAddress":"String"},"technicalContact":{"title":"String","firstName":"String","lastName":"String","position":"String","emailAddress":"String"},"providerType":"String","providerSoftware":"String"}},"ipProducts":{"term":0,"renewalLength":0,"integratedSolutionProvider":{"name":"String","address":{"address1":"String","address2":"String","address3":"String","postcode":"String","city":"String","state":"String","countrycode":"String"},"telephone":"String","primaryContact":{"title":"String","firstName":"String","lastName":"String","position":"String","emailAddress":"String"},"technicalContact":{"title":"String","firstName":"String","lastName":"String","position":"String","emailAddress":"String"},"providerType":"String","providerSoftware":"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"]}