Quickstart - Successful request
Example POST /merchants request:
{
"name":"This is name of the Merchant",
"legalName":"This is LegalName of the Merchant",
"legalForm":"PrivateCompany",
"merchantCategoryCode":"7994",
"pciLevel":"1",
"incorporationDate":"2008-12-31",
"incorporationNumber":"IncorporationNumber AB111AB111AB111AB111AB111AB111",
"taxNumber":"TaxNumber AB111AB111",
"baseCurrencyCode":"GBP",
"estimatedMonthlyVolumeInEUR":10000,
"lowestAmountPerTransactionInEUR":15,
"highestAmountPerTransactionInEUR":500,
"averageAmountPerTransactionInEUR":50,
"estimatedNumberOfTransactionsPerMonth":1001,
"isStartUp":true,
"isChargebackOrFraudAnalysisProcessInPlace":true,
"isRegulatedByAMLGuideline":true,
"settlementCurrencies":[
"EUR",
"GBP",
"USD",
"UAH"
],
"paymentMethodConfig":{
"cardDeposit":{
"useAccountStatusInquiry":true
}
},
"incorporationAddress":{
"street":"This is Street of IncorporationAddress with house number 99/1/2",
"city":"This is City of IncorporationAddress",
"postalCode":"PostalCode-IncorpAdd",
"country":"AT"
},
"operationAddress":{
"street":"a",
"city":"b",
"postalCode":"c",
"country":"DE"
},
"billingAddress":{
"street":"This is Street of BillingAddress with house number 99/1/2",
"city":"This is City of BillingAddress",
"postalCode":"PostalCode-BillAdd",
"country":"GB"
},
"fraudRatiosForThePastMonths":[
{
"cardScheme":"Visa",
"months":[
"1.01",
"1.2",
"1.33"
]
},
{
"cardScheme":"Mastercard",
"months":[
"0.21",
"0.22",
"0.23"
]
}
],
"chargebackCountRatiosForThePastMonths":[
{
"cardScheme":"Visa",
"months":[
1,
2,
100.00
]
},
{
"cardScheme":"Mastercard",
"months":[
"0",
"99.42",
"99.43"
]
}
],
"companyPhoneNumber":"+431234567890-1",
"licenseOrAuthorizationNumber":"A1884B1111-01",
"businessLicenseExpirationDate":"2026-10-25",
"deliveryOrFulfillmentTimeframe":"UpTo7",
"vatNumber":"12B34567890def-",
"partnerId":"CAAB26D2-6E46-E911-A82D-000D3AB18D29",
"shops":[
{
"name":"This is a name of Shop1",
"cardAcceptanceMode":"CNP",
"isMotoOnlyBusiness":false,
"url":"https://www.shop1.320c909b-d7d6-42eb-a4a6-8707c6735b35.com",
"domainOwnership":"Own",
"activationState":"LiveAcceptingCards",
"countryCode":"AT",
"billingDescriptor1":"Shop 1",
"billingDescriptor2":"Vienna",
"volumeSpreadByProcessing":{
"ecom":24,
"moto":50,
"recurring":26
},
"volumeSpreadByRegion":{
"northAmerica":49,
"europeanEconomicArea":20,
"asia":21,
"latinAmerica":5,
"others":5
},
"volumeSpreadByScheme":{
"visa":25,
"mastercard":10,
"others":65
},
"questionAnswerPairs":[
{
"questionId":"ActivityDescription",
"answer":"Answer to ActivityDescription"
},
{
"questionId":"CancellationTimeframe",
"answer":"Answer to CancellationTimeframe"
},
{
"questionId":"CustomerAccounts",
"answer":"Answer to CustomerAccounts"
},
{
"questionId":"RecurringSubscriptionDescription",
"answer":"Answer to RecurringSubscriptionDescription"
},
{
"questionId":"RefundsTimeframe",
"answer":"Answer to RefundsTimeframe"
},
{
"questionId":"SeasonalActivity",
"answer":"Answer to SeasonalActivity"
},
{
"questionId":"URLOwnership",
"answer":"Answer to URLOwnership"
},
{
"questionId":"WebsitePassword",
"answer":"Answer to WebsitePassword"
},
{
"questionId":"WebsiteUsername",
"answer":"Answer to WebsiteUsername"
}
]
}
],
"relatedPeople":[
{
"roles":[
"Owner",
"Shareholder",
"DirectorOrExecutive",
"UltimateBeneficiary",
"OperationalContact",
"TechnicalContact",
"Signatory",
],
"firstname":"This is first name of person 1",
"lastname":"This is last name of person 1",
"address":{
"street":"This is Street of address of related person 1",
"city":"This is City of address of related person 1",
"postalCode":"PostalCode-AddPer1",
"country":"AT"
},
"phoneNumber":"+43(0)68220405289",
"dateOfBirth":"2000-08-30",
"skypeName":"This is skype name of person 1",
"email":"[email protected]",
"shareOrOwnershipPercentage":10,
"passportOrGovernmentNumber":"Passport Number of Person 1: 1633PY-111Z",
"passportOrGovernmentIDExpirationDate":"2027-10-25",
"isListedOnPEP":false
}
],
"relatedCompanies":[
{
"roles":[
"Owner",
"ExclusiveOwner",
"Shareholder",
"UltimateBeneficiary",
"ExclusiveShareholder"
],
"name":"This is name of related company 1",
"incorporationAddress":{
"street":"This is Street of address of related company 1",
"city":"This is City of address of related company 1",
"postalCode":"PostalCode-AddCom1",
"country":"GB"
},
"taxNumber":"ATU99999978",
"incorporationDate":"2005-11-22",
"incorporationNumber":"U4567UP1234234",
"shareOrOwnershipPercentage":25
}
],
"bankAccounts":[
{
"bankName":"Erste bank",
"accountNumber":"779466558",
"bankCode":"60000",
"countryCode":"DE",
"currencyCode":"EUR",
"holderName":"This is LegalName of the Merchant",
"iban":"DE93450800604936569200",
"bic":"BCITITMM300"
}
],
"questionAnswerPairs":[
{
"questionId":"AML&CTF_Guidance",
"answer":"Answer to AML&CTF_Guidance"
},
{
"questionId":"BusinessModelDescription",
"answer":"Answer to BusinessModelDescription"
},
{
"questionId":"CardProcessingHistory",
"answer":"Answer to CardProcessingHistory"
},
{
"questionId":"ChargebackFraudContact",
"answer":"Answer to ChargebackFraudContact"
},
{
"questionId":"ChargebackFraudProcess",
"answer":"Answer to ChargebackFraudProcess"
},
{
"questionId":"CurrentAcquirers",
"answer":"Answer to CurrentAcquirers"
},
{
"questionId":"CustomersPhoneAddress",
"answer":"Answer to CustomersPhoneAddress"
},
{
"questionId":"CVVCompulsory",
"answer":"Answer to CVVCompulsory"
},
{
"questionId":"Is3DSecureMandatory",
"answer":"Answer to Is3DSecureMandatory"
},
{
"questionId":"Is3DSEnabled",
"answer":"Answer to Is3DSEnabled"
},
{
"questionId":"LengthOfAcquirerRelationship",
"answer":"Answer to LengthOfAcquirerRelationship"
},
{
"questionId":"MLRO_Contact",
"answer":"Answer to MLRO_Contact"
},
{
"questionId":"NoLicenseOrAuthorizationNumberProvided",
"answer":"Answer to NoLicenseOrAuthorizationNumberProvided"
},
{
"questionId":"ReasonForNewAcquirer",
"answer":"Answer to ReasonForNewAquirer"
},
{
"questionId":"TimeAcceptingCards",
"answer":"Answer to TimeAcceptingCards"
},
{
"questionId":"VerifyCustomer",
"answer":"Answer to VerifyCustomer"
},
{
"questionId":"RiskMeasure_Delayed Settlement",
"answer":"Answer to RiskMeasure_Delayed Settlement"
},
{
"questionId":"RiskMeasure_RollingReserve",
"answer":"Answer to RiskMeasure_RollingReserve"
},
{
"questionId":"RiskMeasure_SecurityDeposit",
"answer":"Answer to RiskMeasure_SecurityDeposit"
}
]
}
The following response will be returned with HTTP status code 201 - Created, indicating that the resource has been stored successfully.
Example POST /merchants response:
{
"id": "cad86ba4-f0a4-47fd-968c-13630b1d2ae9",
"legalForm": "PrivateCompany",
"name": "This is name of the Merchant",
"legalName": "This is LegalName of the Merchant",
"incorporationAddress": {
"street": "This is Street of IncorporationAddress with house number 99/1/2",
"city": "This is City of IncorporationAddress",
"postalCode": "PostalCode-IncorpAdd",
"country": "AT"
},
"operationAddress": {
"street": "a",
"city": "b",
"postalCode": "c",
"country": "DE"
},
"billingAddress": {
"street": "This is Street of BillingAddress with house number 99/1/2",
"city": "This is City of BillingAddress",
"postalCode": "PostalCode-BillAdd",
"country": "GB"
},
"merchantCategoryCode": "7994",
"pciLevel": 1,
"incorporationDate": "2008-12-31",
"incorporationNumber": "IncorporationNumber AB111AB111AB111AB111AB111AB111",
"isStartUp": true,
"isChargebackOrFraudAnalysisProcessInPlace": true,
"isRegulatedByAMLGuideline": true,
"isQualifiedForFastOnboarding": false,
"taxNumber": "TaxNumber AB111AB111",
"vatNumber": "12B34567890def-",
"paymentMethodConfig": {
"cardDeposit": {
"useAccountStatusInquiry": true
}
},
"baseCurrencyCode": "GBP",
"estimatedMonthlyVolumeInEUR": 10000,
"lowestAmountPerTransactionInEUR": 15,
"highestAmountPerTransactionInEUR": 500,
"averageAmountPerTransactionInEUR": 50,
"estimatedNumberOfTransactionsPerMonth": 1001,
"fraudRatiosForThePastMonths": [
{
"cardScheme": "Mastercard",
"months": [
0.21,
0.22,
0.23
]
},
{
"cardScheme": "Visa",
"months": [
1.01,
1.2,
1.33
]
}
],
"chargebackCountRatiosForThePastMonths": [
{
"cardScheme": "Mastercard",
"months": [
0,
99.42,
99.43
]
},
{
"cardScheme": "Visa",
"months": [
1,
2,
100
]
}
],
"deliveryOrFulfillmentTimeframe": "UpTo7",
"state": "PendingOnPreScreening",
"companyPhoneNumber": "+431234567890-1",
"licenseOrAuthorizationNumber": "A1884B1111-01",
"businessLicenseExpirationDate": "2026-10-25",
"partner": {
"id": "caab26d2-6e46-e911-a82d-000d3ab18d29"
},
"settlementCurrencies": [
"USD",
"GBP",
"EUR",
"UAH"
],
"shops": [
{
"id": "adeaef1a-8eb5-4e76-89ee-4fcc3b500fba"
}
],
"relatedPeople": [
{
"id": "844cb236-4713-4c54-a39a-582c2cae6db7"
}
],
"relatedCompanies": [
{
"id": "1ea69dce-f87c-47d9-8757-e35c0c26e184"
}
],
"bankAccounts": [
{
"id": "c579581e-81d0-4f89-893a-df5e70e1e422"
}
],
"questionAnswerPairs": [
{
"questionId": "CVVCompulsory",
"answer": "Answer to CVVCompulsory"
},
{
"questionId": "NoLicenseOrAuthorizationNumberProvided",
"answer": "Answer to NoLicenseOrAuthorizationNumberProvided"
},
{
"questionId": "ChargebackFraudContact",
"answer": "Answer to ChargebackFraudContact"
},
{
"questionId": "BusinessModelDescription",
"answer": "Answer to BusinessModelDescription"
},
{
"questionId": "CustomersPhoneAddress",
"answer": "Answer to CustomersPhoneAddress"
},
{
"questionId": "AML&CTF_Guidance",
"answer": "Answer to AML&CTF_Guidance"
},
{
"questionId": "TimeAcceptingCards",
"answer": "Answer to TimeAcceptingCards"
},
{
"questionId": "CardProcessingHistory",
"answer": "Answer to CardProcessingHistory"
},
{
"questionId": "VerifyCustomer",
"answer": "Answer to VerifyCustomer"
},
{
"questionId": "MLRO_Contact",
"answer": "Answer to MLRO_Contact"
},
{
"questionId": "CurrentAcquirers",
"answer": "Answer to CurrentAcquirers"
},
{
"questionId": "ChargebackFraudProcess",
"answer": "Answer to ChargebackFraudProcess"
},
{
"questionId": "ReasonForNewAcquirer",
"answer": "Answer to ReasonForNewAquirer"
},
{
"questionId": "Is3DSecureMandatory",
"answer": "Answer to Is3DSecureMandatory"
},
{
"questionId": "Is3DSEnabled",
"answer": "Answer to Is3DSEnabled"
},
{
"questionId": "LengthOfAcquirerRelationship",
"answer": "Answer to LengthOfAcquirerRelationship"
}
]
}
Example POST /prescreen-merchants request:
{
"averageAmountPerTransactionInEUR":1,
"chargebackCountRatiosForThePastMonths":[
{
"cardScheme":"Mastercard",
"months":[
0.2,
0.3,
0.4
]
},
{
"cardScheme":"Visa",
"months":[
0.52,
0.53,
0.54
]
}
],
"estimatedMonthlyVolumeInEUR":2000,
"fraudRatiosForThePastMonths":[
{
"cardScheme":"Mastercard",
"months":[
0.6,
0.7,
0.8
]
},
{
"cardScheme":"Visa",
"months":[
0.56,
0.57,
0.58
]
}
],
"incorporationCountryCode":"AT",
"legalForm":3,
"legalName":"PreScreenMerchant",
"merchantCategoryCode":"0742",
"name":"PreScreenMerchant",
"partnerId":"7DB3BBE4-ACE4-E711-812B-3863BB349BD8",
"settlementCurrencies":[
"EUR"
],
"shops":[
{
"name":"PreScreenShop",
"Url":"http:\/\/someshop.com",
"cardAcceptanceMode":2
}
]
}
The following response will be returned with HTTP status code 201 - Created, indicating that the resource has been stored successfully.
Example POST /prescreen-merchants response:
{
"id": "3dd42c33-dc88-4a65-af96-6a731bb552db",
"partnerId": "7db3bbe4-ace4-e711-812b-3863bb349bd8",
"name": "PreScreenMerchant",
"state": "Pending",
"legalName": "PreScreenMerchant",
"legalForm": "SoleProprietor",
"incorporationCountryCode": "AT",
"merchantCategoryCode": "0742",
"settlementCurrencies": [
"EUR"
],
"estimatedMonthlyVolumeInEUR": 2000,
"averageAmountPerTransactionInEUR": 1,
"fraudRatiosForThePastMonths": [
{
"cardScheme": "Mastercard",
"months": [
0.6,
0.7,
0.8
]
},
{
"cardScheme": "Visa",
"months": [
0.56,
0.57,
0.58
]
}
],
"chargebackCountRatiosForThePastMonths": [
{
"cardScheme": "Mastercard",
"months": [
0.2,
0.3,
0.4
]
},
{
"cardScheme": "Visa",
"months": [
0.52,
0.53,
0.54
]
}
],
"shops": [
{
"id": "72619c9a-841e-4c11-973c-4e81f1a357a7",
"url": "http://someshop.com",
"name": "PreScreenShop",
"cardAcceptanceMode": "CP",
"state": "Pending"
}
]
}
Updated about 5 years ago