POST | /allchecks/submit/data |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ApplicationGUID | body | string | Yes | |
CSR | body | int | No | |
ApplicationDetails | body | ApplicationDetails | Yes | |
MainBusinessRepresentative | body | ContactDetails | Yes | |
CompanyDetail | body | CompanyDetails | Yes | |
BankDetail | body | BankDetails | Yes | |
BusinessProfile | body | BusinessProfile | Yes | |
Owners | body | List<OwnerDetails> | Yes | |
NapPartyId | body | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
specialInstructions | form | string | No | |
typeAcquiring | form | bool? | No | |
typePOS_F2F | form | bool? | No | |
typePOS_MOTO | form | bool? | No | |
typeOnlinePayments | form | bool? | No | |
typeVirtualTerminal | form | bool? | No | |
sellerCode | form | string | No | |
numOutlets | form | int? | No | |
mccCode | form | string | No | |
offerDescription | form | string | No | |
pricingPackage | form | string | No | |
contractLength | form | int? | No | |
settlementPeriodTPlus | form | string | No | |
ecomPSP | form | string | No | |
posPSP | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
name | form | ContactNameData | No | |
phone | form | string | No | |
form | string | No | ||
position | form | string | No | |
altPhone | 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 |
---|---|---|---|---|
legalName | form | string | No | |
tradingName | form | string | No | |
tradingAddress | form | AddressData | No | |
legalAddress | form | AddressData | No | |
website | form | string | No | |
companyType | form | string | No | |
registrationNumber | form | string | No | |
merchantCategoryPseudoName | form | string | No | |
vatNumber | form | string | No | |
hasStartedTrading | form | bool? | No | |
startedTradingMonth | form | string | No | |
startedTradingYear | form | string | No | |
companyTypeOther | form | string | No | |
isRegisteredCharity | form | bool? | No | |
countryOfIncorporation | form | string | No | |
regionOfIncorporation | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
address1 | form | string | No | |
address2 | form | string | No | |
address3 | form | string | No | |
postalCode | form | string | No | |
city | form | string | No | |
state | form | string | No | |
countryCode | 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 | |
settlementCurrency | form | string | No | |
swiftCode | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
descriptionOfYourGoodsAndServices | form | string | No | |
anticipatedAverageMonthlyTurnover | form | double? | No | |
anticipatedPeakMonthlyTurnover | form | double? | No | |
percentageOfPrepayments | form | double? | No | |
percentageOfDeposits | form | double? | No | |
percentageOfSubscriptions | form | double? | No | |
daysFromOrderConfirmationToDelivery | form | List<DaysToDelivery> | No | |
depositPaymentDetails | form | List<PaymentDetails> | No | |
averageSubscriptionLengthInMonths | form | int? | No | |
averageNumberOfSubscriptionPayments | form | int? | No | |
anticipatedPercentageIncreaseInTurnoverForAYear | form | double? | No | |
ccTurnover | form | double? | No | |
totalCardTurnover | form | double? | No | |
cnpPercentage | form | double? | No | |
totalTurnover | form | double? | No | |
avTransValue | form | double? | No | |
cnpRequired | form | bool | No | |
cashbackRequired | form | bool | No | |
futurePayRequired | form | bool | No | |
newToCards | form | bool? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
percentageOfOrders | form | double? | No | |
numberOfDays | form | int? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
percentageOfTotalTurnoverToRelatedBusiness | form | double? | No | |
percentageOfTotalTurnoverTakenAsDeposit | form | double? | No | |
averageDaysBetweenDepositAndFullPayment | form | int? | No | |
averageDaysBetweenFullPaymentAndDelivery | form | int? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
dayOfBirth | form | int | No | |
monthOfBirth | form | int | No | |
yearOfBirth | form | int | No | |
ownershipPercentage | form | double? | No | |
homeAddress | form | AddressData | No | |
currentAddressLessThanThreeYears | form | bool | No | |
previousHomeAddress | form | AddressData | No | |
name | form | ContactNameData | No | |
director | form | bool | No | |
nationality | form | string | No | |
position | form | string | No | |
timeAtHomeAddressYears | form | int? | No | |
timeAtHomeAddressMonths | form | int? | No | |
PrimaryPartyID | form | string | No | |
identityVerificationDocuments | form | List<IdentityVerificationDocuments> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
documentId | form | string | No | |
authenticity | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /allchecks/submit/data HTTP/1.1
Host: wpcdd-featuretest-ws.worldpay.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
ApplicationGUID: String,
CSR: 0,
ApplicationDetails:
{
specialInstructions: String,
typeAcquiring: False,
typePOS_F2F: False,
typePOS_MOTO: False,
typeOnlinePayments: False,
typeVirtualTerminal: False,
sellerCode: String,
numOutlets: 0,
mccCode: String,
offerDescription: String,
pricingPackage: Unknown,
contractLength: 0,
settlementPeriodTPlus: String,
ecomPSP: String,
posPSP: String
},
MainBusinessRepresentative:
{
name:
{
title: String,
firstName: String,
middleName: String,
lastName: String
},
phone: String,
email: String,
position: String,
altPhone: String,
preferredContactMethod: String,
preferredContactBestTime: String
},
CompanyDetail:
{
legalName: String,
tradingName: String,
tradingAddress:
{
address1: String,
address2: String,
address3: String,
postalCode: String,
city: String,
state: String,
countryCode: String
},
legalAddress:
{
address1: String,
address2: String,
address3: String,
postalCode: String,
city: String,
state: String,
countryCode: String
},
website: String,
companyType: String,
registrationNumber: String,
merchantCategoryPseudoName: String,
vatNumber: String,
hasStartedTrading: False,
startedTradingMonth: String,
startedTradingYear: String,
companyTypeOther: String,
isRegisteredCharity: False,
countryOfIncorporation: String,
regionOfIncorporation: String
},
BankDetail:
{
sortCode: String,
accountNumber: String,
bankName: String,
bankAccountName: String,
settlementCurrency: String,
swiftCode: String
},
BusinessProfile:
{
descriptionOfYourGoodsAndServices: String,
anticipatedAverageMonthlyTurnover: 0,
anticipatedPeakMonthlyTurnover: 0,
percentageOfPrepayments: 0,
percentageOfDeposits: 0,
percentageOfSubscriptions: 0,
daysFromOrderConfirmationToDelivery:
[
{
percentageOfOrders: 0,
numberOfDays: 0
}
],
depositPaymentDetails:
[
{
percentageOfTotalTurnoverToRelatedBusiness: 0,
percentageOfTotalTurnoverTakenAsDeposit: 0,
averageDaysBetweenDepositAndFullPayment: 0,
averageDaysBetweenFullPaymentAndDelivery: 0
}
],
averageSubscriptionLengthInMonths: 0,
averageNumberOfSubscriptionPayments: 0,
anticipatedPercentageIncreaseInTurnoverForAYear: 0,
ccTurnover: 0,
totalCardTurnover: 0,
cnpPercentage: 0,
totalTurnover: 0,
avTransValue: 0,
cnpRequired: False,
cashbackRequired: False,
futurePayRequired: False,
newToCards: False
},
Owners:
[
{
dayOfBirth: 0,
monthOfBirth: 0,
yearOfBirth: 0,
ownershipPercentage: 0,
homeAddress:
{
address1: String,
address2: String,
address3: String,
postalCode: String,
city: String,
state: String,
countryCode: String
},
currentAddressLessThanThreeYears: False,
previousHomeAddress:
{
address1: String,
address2: String,
address3: String,
postalCode: String,
city: String,
state: String,
countryCode: String
},
name:
{
title: String,
firstName: String,
middleName: String,
lastName: String
},
director: False,
nationality: String,
position: String,
timeAtHomeAddressYears: 0,
timeAtHomeAddressMonths: 0,
PrimaryPartyID: String,
identityVerificationDocuments:
[
{
documentId: String,
authenticity: String
}
]
}
],
NapPartyId: String
}