POST | /allchecks/submit/json |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Application | body | Application | Yes | |
CorrelationId | body | string | Yes | |
NapPartyId | body | string | No | |
LEID | body | string | No | |
OrderId | body | string | No | |
PartyIndividuals | body | List<string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ApplicationDetails | form | ApplicationDetails | No | |
MerchantDetails | form | MerchantDetails | No | |
Acquiring | form | Acquiring | No | |
Products | form | Products | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
SourceSystem | form | SourceSystemType | No | |
SourceSystemIdentifier | form | string | No | |
CustomerType | form | CustomerType | No | |
Csr | form | string | No | |
Partner | form | Partner | No | |
SellerCode | form | string | No | |
PricingPackage | form | PricingPackageType | No | |
ContactPerson | form | AuthorisedSigner | No | |
SpecialInstructions | form | string | No | |
OfferDetails | form | string | No | |
DateContractAccepted | form | DateTime | No | |
WorldpayBusinessFinanceInterest | form | bool? | No | |
Sar | form | bool? | No | |
SellerEmail | form | string | No | |
AnticipatedGoLiveDate | form | DateTime? | No | |
AccessibilityOptions | form | AccessibilityOptions | No | |
UltimateParentId | form | string | No |
MARS | |
ASA | |
OLS | |
INASA |
Name | Value | |
---|---|---|
New | 0 | |
Existing | 1 | |
None | -1 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
PartnerId | form | string | No | |
PartnerName | form | string | No |
Name | Value | |
---|---|---|
CustomUk | 0 | |
MonthlyUk | 1 | |
SimplicityUk | 2 | |
PaygUk | 3 | |
CustomRoi | 4 | |
PaygeComUK | 5 | |
None | -1 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
DateOfBirth | form | DateTime? | No | |
CountryCode | 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 | |
TelephoneNumber | form | string | No | |
AltTelephoneNumber | form | string | No | |
form | string | No | ||
Position | form | string | No | |
PreferredContactMethod | form | PreferredContactMethodType | No | |
PreferredContactBestTime | form | string | No |
Telephone | |
Any |
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 |
---|---|---|---|---|
Business | form | Business | No | |
Principals | form | IEnumerable<Principal> | No | |
Outlets | form | IEnumerable<Outlet> | No | |
GoodsAndServices | form | GoodsAndServices | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
LegalName | form | string | No | |
LegalAddress | form | BusinessAddress | No | |
WebsiteAddress | form | string | No | |
CompanyType | form | CompanyType | No | |
CompanyTypeOther | form | string | No | |
CompanyRegistrationNumber | form | string | No | |
CharityNumber | form | string | No | |
MerchantCategoryCode | form | string | No | |
MerchantCategoryDescription | form | string | No | |
DescriptionOfGoodsAndServices | form | string | No | |
VatNumber | form | string | No | |
DateStartedTrading | form | DateTime? | No | |
CountryOfIncorporation | form | string | No | |
RegionOfIncorporation | form | string | No | |
Financials | form | Financials | No | |
NewToCards | form | bool | No | |
TradeAssociation | form | TradeAssociation | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 |
SoleTrader | |
Partnership | |
LimitedCompany | |
Trust | |
RegisteredCharity | |
PublicLimitedCompany | |
LimitedByGuarantee | |
ClubSocietyAssociation | |
CommunityInterestCompanyOrIndustrialProvident | |
LimitedLiabilityPartnership | |
Other |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Annual | form | decimal | No | |
CardPercentage | form | decimal | No | |
CreditCardPercentage | form | decimal | No | |
AverageTransactionValue | 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 | 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 |
---|---|---|---|---|
TradingName | form | string | No | |
TradingAddress | form | BusinessAddress | No | |
ContactPerson | form | ContactPerson | No | |
TerminalDeliveryAddress | form | BusinessAddress | No | |
CorrespondenceAddress | form | BusinessAddress | No | |
SettlementBankAccount | form | BankAccount | No | |
ChargesBankAccount | form | BankAccount | No | |
DirectDebitCorrespondenceEmail | form | string | No | |
ClearingDetails | form | ClearingDetails | No | |
ProductAllocation | form | IEnumerable<OutletAllocatedProduct> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
SortCode | form | string | No | |
AccountNumber | form | string | No | |
BankName | form | string | No | |
BankAccountName | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
MerchantUrl | form | string | No | |
Telephone | form | string | No | |
form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | |
Quantity | form | int | No |
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 |
---|---|---|---|---|
Accepted | form | bool? | No | |
PerOfSalesWhereInitialDepositTaken | form | int? | No | |
SizePercOfTotalValue | form | int? | No | |
AvgTimeBeforeDeliveryTaken | form | int? | No | |
AvgTimeBeforeDeliveryBalanceTaken | form | int? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
LevyCharge | form | bool? | No | |
PercCardTurnover | form | int? | No | |
AvgLengthInMonths | form | int? | No | |
PercGoodsReturned | form | int? | No | |
ThirdPartyProviders | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
FullPaymentAcceptedPriorToSupply | form | bool? | No | |
PercGoodsWherePaymentTakenPriorToDelivery | form | int? | No | |
AvgDaysPaymentTakenInAdvance | form | int? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
LevyCharge | form | bool? | No | |
PercCardTurnover | form | int? | No | |
AvgLengthInMonths | form | int? | No | |
MembershipCost | form | decimal? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
SettlementPeriodTPlus | form | int | No | |
Rates | form | Rates | No | |
Services | form | Services | No | |
TradingCurrencies | form | IEnumerable<TradingCurrency> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CardCharges | form | IEnumerable<CardCharge> | No | |
PremiumTransactionCharges | form | IEnumerable<PremiumTransactionCharge> | No | |
AdditionalTarrifs | form | IEnumerable<AdditionalTarrif> | 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 | AdditionalTarrifType | No | |
Cost | form | decimal | No |
NameAndAddressCheck | |
Auth | |
chargeback | |
Mmsc | |
PaperStatement | |
PciVerbalAssessment | |
PciIpScan | |
PciNonCompliance | |
PciSaferPaymentsPlus | |
JoiningFee | |
PayMonthlyAcquiringFee | |
PciSaferPayments |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Cnp | form | Cnp | No | |
Amex | form | Amex | No | |
CashbackRequired | form | bool | No | |
WorldpayDashboardRequired | form | bool | No | |
PaperInvoicingRequired | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Required | form | bool | No | |
Percentage | form | decimal | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Required | form | bool | No | |
ExistingAmexNumber | form | string | 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 |
---|---|---|---|---|
PosProducts | form | PosProducts | No | |
EcomProducts | form | EcomProducts | No | |
WptProducts | form | WptProducts | No | |
IpProducts | form | IpProducts | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Term | form | int? | No | |
RenewalLength | form | int? | No | |
Products | form | IEnumerable<PosProduct> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | |
Type | form | PosProductType | No | |
Quantity | form | int | No | |
RelatedFees | form | IEnumerable<ProductFee> | No | |
Options | form | IEnumerable<PosProductOption> | No |
Mobile | |
Wifi | |
Bluetooth | |
Fixed | |
PosMidOnly |
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 | PosProductOptionType | No | |
Value | form | string | No |
PSP |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Term | form | int? | No | |
RenewalLength | form | int? | No | |
Products | form | IEnumerable<EcomProduct> | No | |
Options | form | IEnumerable<EcomOption> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | |
Type | form | EcomProductType | No | |
Quantity | form | int | No | |
RelatedFees | form | IEnumerable<ProductFee> | No | |
Options | form | IEnumerable<EcomProductOption> | No |
Gateway | |
VirtualTerminal | |
PayByLink | |
EcomMidOnly |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Type | form | EcomProductOptionType | No | |
Value | form | string | No |
PSP | |
FreeTransactions |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Type | form | EcomOptionType | No | |
RelatedFees | form | IEnumerable<ProductFee> | No |
Paypal | |
FuturePay | |
RMM |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Term | form | int? | No | |
RenewalLength | form | int? | No | |
PosInstallationDate | form | DateTime | No | |
IntegratedSolutionProvider | form | IntegratedSolutionProvider | No | |
Products | form | IEnumerable<WptProduct> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | No | |
Address | form | Address | No | |
Telephone | form | string | No | |
PrimaryContact | form | IspContact | No | |
TechnicalContact | form | IspContact | No | |
ProviderType | form | string | No | |
ProviderSoftware | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Title | form | string | No | |
FirstName | form | string | No | |
LastName | form | string | No | |
Position | form | string | No | |
EmailAddress | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Type | form | WptProductType | No | |
Id | form | int | No | |
Variant | form | WptVariantType? | No | |
Quantity | form | int | No | |
RelatedFees | form | IEnumerable<ProductFee> | No |
VerifoneP400 | |
IngenicoWL258 | |
VerifoneV240 |
Serial | |
Usb | |
Ethernet | |
None |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Term | form | int? | No | |
RenewalLength | form | int? | No | |
IntegratedSolutionProvider | form | IntegratedSolutionProvider | No | |
Products | form | IEnumerable<IpProduct> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | |
Type | form | IpProductType | No | |
Quantity | form | int | No | |
RelatedFees | form | IEnumerable<ProductFee> | No | |
Variant | form | IpVariantType? | No |
PaxA920 | |
MiuraM020 |
Sdk | |
Cloud | |
None |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Status | form | int | No | |
CorrelationId | form | string | No | |
Message | 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/json HTTP/1.1
Host: wp-cddws-test.worldpay.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Application:
{
ApplicationDetails:
{
SourceSystem: MARS,
SourceSystemIdentifier: String,
CustomerType: New,
Csr: String,
Partner:
{
PartnerId: String,
PartnerName: String
},
SellerCode: String,
PricingPackage: CustomUk,
ContactPerson:
{
DateOfBirth: 0001-01-01,
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: 0001-01-01,
WorldpayBusinessFinanceInterest: False,
Sar: False,
SellerEmail: String,
AnticipatedGoLiveDate: 0001-01-01,
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: 0001-01-01,
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: 0001-01-01,
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
}
}
}
},
CorrelationId: String,
NapPartyId: String,
LEID: String,
OrderId: String,
PartyIndividuals:
[
String
]
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { Status: 0, CorrelationId: String, Message: String }