POST | /OrderBoarding |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CorrelationId | body | Guid | Yes | |
OrderJson | body | Order | Yes | |
OnboardingRequestId | body | Guid? | No | |
LocalEnterpriseId | body | Guid? | No | |
Audience | body | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Meta | form | OrderMeta | No | |
Payload | form | OrderPayload | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
SourceSystem | form | string | No | |
SourceSystemIdentifier | form | string | No | |
Csr | form | string | No | |
UltimateParentId | form | string | No | |
OrderType | form | string | No | |
CustomerType | form | string | No | |
Partner | form | Partner | No | |
SellerCode | form | string | No | |
SellerEmail | form | string | No | |
SpecialInstructions | form | string | No | |
Contact | form | AuthorisedSigner | No | |
OfferDetails | form | string | No | |
DateContractAccepted | form | DateTime | No | |
WorldpayBusinessFinanceInterest | form | bool? | No | |
Sar | form | bool? | No | |
HasSupportingFiles | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
PartnerName | form | string | No | |
PartnerId | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
DateOfBirth | form | DateTime? | No | |
CountryCode | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
IdpGuid | form | Guid? | No | |
TelephoneNumber | form | string | No | |
AltTelephoneNumber | form | string | No | |
form | string | No | ||
Position | form | string | No | |
PreferredContactMethod | form | string | No | |
PreferredContactBestTime | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Title | form | string | No | |
FirstName | form | string | No | |
MiddleName | form | string | No | |
LastName | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
PartyId | form | string | No | |
ParentPartyId | form | string | No | |
LegalName | form | string | No | |
TradingName | form | string | No | |
Addresses | form | IEnumerable<MerchantAddress> | No | |
TradingContact | form | Contact | No | |
InvoiceContact | form | InvoiceContact | No | |
SettlementBankAccount | form | BankAccount | No | |
ChargesBankAccount | form | BankAccount | No | |
DirectDebitCorrespondenceEmail | form | string | No | |
WebsiteAddress | form | string | No | |
CompanyType | form | string | No | |
CompanyTypeOther | form | string | No | |
CompanyRegistrationNumber | form | string | No | |
CharityNumber | form | string | No | |
MerchantCategories | form | IEnumerable<MerchantCategory> | No | |
VatNumber | form | string | No | |
DateStartedTrading | form | DateTime? | No | |
AnticipatedGoLiveDate | form | DateTime? | No | |
CountryOfIncorporation | form | string | No | |
RegionOfIncorporation | form | string | No | |
Financials | form | Financials | No | |
NewToCards | form | bool? | No | |
TradeAssociation | form | TradeAssociation | No | |
Principals | form | IEnumerable<Principal> | No | |
GoodsAndServices | form | GoodsAndServices | No | |
AccessibilityOptions | form | AccessibilityOptions | No | |
ClearingDetails | form | ClearingDetails | No | |
Acquiring | form | Acquiring | No | |
Subscriptions | form | IEnumerable<Subscription> | No | |
Children | form | IEnumerable<OrderPayload> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
AddressType | form | string | No | |
IsCommercial | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Address1 | form | string | No | |
Address2 | form | string | No | |
Address3 | form | string | No | |
Postcode | form | string | No | |
City | form | string | No | |
State | form | string | No | |
CountryCode | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
form | string | No | ||
Position | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
SortCode | form | string | No | |
AccountNumber | form | string | No | |
BankName | form | string | No | |
BankAccountName | form | string | No | |
SwiftCode | form | string | No | |
InternationalBankAccountNumber | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
MerchantCategoryCode | form | string | No | |
MerchantCategoryDescription | form | string | No | |
DescriptionOfGoodsAndServices | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Annual | form | decimal | No | |
CardPercentage | form | decimal | No | |
CreditCardPercentage | form | decimal | No | |
AverageTransactionValue | form | decimal | No | |
CardNotPresentPercentage | form | decimal? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
GroupName | form | string | No | |
MemberNumber | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Title | form | string | No | |
FirstName | form | string | No | |
MiddleName | form | string | No | |
LastName | form | string | No | |
DateOfBirth | form | DateTime | No | |
Nationality | form | string | No | |
HomeAddresses | form | IEnumerable<PrincipalAddress> | No | |
OwnershipPercentage | form | decimal | No | |
Position | form | PositionType | No | |
IsFinancialController | form | bool? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
StartDate | form | DateTime | No | |
EndDate | form | DateTime? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Address1 | form | string | No | |
Address2 | form | string | No | |
Address3 | form | string | No | |
Postcode | form | string | No | |
City | form | string | No | |
State | form | string | No | |
Countrycode | form | string | No |
Name | Value | |
---|---|---|
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 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
GoodsProvidedByThirdParty | form | bool? | No | |
Deposits | form | Deposits | No | |
WarrantiesAndGuarantees | form | WarrantiesAndGuarantees | No | |
Prepayments | form | Prepayments | No | |
MembershipsSubscriptionAndInsurancePremiums | form | MembershipsSubscriptionAndInsurancePremiums | No | |
StockHeldAtAnotherAddressLocation | form | Address | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
PerOfSalesWhereInitialDepositTaken | form | int | No | |
SizePerTotalValue | form | int | No | |
AvgTimeBeforeDeliveryDepositTaken | form | int | No | |
AvgTimeBeforeDeliveryBalanceTaken | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
PercCardTurnover | form | int | No | |
AvgLengthInMonths | form | int | No | |
PercGoodsReturned | form | int | No | |
ThirdPartyProviders | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
PercGoodsWherePaymentTakenPriorToDelivery | form | int | No | |
AvgDaysPaymentTakenInAdvance | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
PercCardTurnover | form | int | No | |
AvgLengthInMonths | form | int | No | |
MembershipCost | form | decimal | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
AudiotapeRequired | form | bool? | No | |
LargePrintRequired | form | bool? | No | |
UncontractedBrailleGrade1Required | form | bool? | No | |
UncontractedBrailleGrade2Required | form | bool? | No | |
NextGenerationTextRequired | form | bool? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
MerchantUrl | form | string | No | |
Telephone | form | string | No | |
form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
SettlementPeriod | form | int | No | |
FundingMode | form | string | No | |
Rates | form | Rates | No | |
TradingCurrencies | form | IEnumerable<TradingCurrency> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CardCharges | form | IEnumerable<CardCharge> | No | |
PremiumTransactionCharges | form | IEnumerable<PremiumTransactionCharge> | No | |
AdditionalTariffs | form | IEnumerable<AdditionalTariff> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CardType | form | CardType | No | |
Purchase | form | RateChargePair | No | |
Refund | form | RateChargePair | No |
VisaDebit | |
VisaCredit | |
VisaCommercial | |
MastercardDebit | |
MastercardCredit | |
MastercardCommercial | |
MastercardWorldSignia | |
JcbCredit | |
JcbDebit | |
JcbCommercial | |
DinersDiscoverCredit | |
DinersDiscoverDebit | |
DinersDiscoverCommercial | |
Amex | |
ChinaUnionPayCredit | |
ChinaUnionPayDebit | |
ChinaUnionPayCommercial | |
VisaBusinessDebit | |
MastercardBusiness |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Percent | form | decimal? | No | |
Cost | form | decimal? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Type | form | PremiumTransactionChargeType | No | |
CreditCard | form | RateChargePair | No | |
DebitCard | form | RateChargePair | No |
Magstripe | |
CnpMoto | |
Paper | |
PanKeyEntry | |
SecureEcom | |
NonSecureEcom | |
InterRegional | |
IntraRegional | |
NonAuth |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Type | form | string | No | |
Cost | form | decimal | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
TransactionCurrencies | form | IEnumerable<CurrencyCodeType> | No | |
SettlementCurrency | form | CurrencyCodeType | No | |
SettlementBankSwift | form | string | No | |
SettlementBankIban | form | string | No |
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 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Proposition | form | string | No | |
PricingPackage | form | string | No | |
Term | form | int? | No | |
RenewalLength | form | int? | No | |
Acquiring | form | Acquiring | No | |
Products | form | IEnumerable<Product> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | No | |
Type | form | string | No | |
Variant | form | string | No | |
Quantity | form | int? | No | |
RelatedFees | form | IEnumerable<ProductFee> | No | |
Options | form | IEnumerable<ProductOption> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Type | form | ProductFeeType | No | |
Cost | form | decimal | No |
HireCost | |
TransactionCost | |
ServiceFee | |
ManagedServiceSetup | |
ManagedServiceMonthly |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Type | form | string | No | |
Value | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ApplicationGuid | form | Guid | No | |
CSR | form | int | No | |
ApplicationQueueGuid | form | Guid? | No | |
QueueStatus | form | ApplicationQueueStatus | No | |
BoardingStatus | form | ApplicationBoardingStatus? | No | |
ErrorMessages | form | List<string> | No |
Name | Value | |
---|---|---|
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 |
Name | Value | |
---|---|---|
PENDING | 0 | |
IN_PROGRESS | 5 | |
FAILED | 9 | |
COMPLETED | 10 |
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-featuretest.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"]}