--- title: "Uploads merchant and shop related details used for pre-screening." method: POST path: "/prescreen-merchants" --- # Uploads merchant and shop related details used for pre-screening. `POST /prescreen-merchants` ## Request - Base URL: `https://api.test.kalixa.com/payment-service/v6` - URL: `https://api.test.kalixa.com/payment-service/v6/prescreen-merchants` - Auth: HTTP basic Uploads merchant and shop related details used for pre-screening. ## Request body - NewPreScreenMerchant: Contains merchant and shop related details used for pre-screening. - `name` string, required: A short text, usually the company name or abbreviation. Used by the PXP Financial Pre-Screening Team. - `legalName` string, required: The company name as it is officially incorporated. Used for reports and invoices and is also shown in the footer area of the PXP Financial Checkout. - `legalForm` 'NonProfitCorporation' | 'Partnership' | 'PrivateCompany' | 'PublicListedCompany' | 'SoleProprietor' | 'SoleTrader' | 'Trust' | 'UnincorporatedAssociation': The legal form of the company. Used by the PXP Financial Pre-Screening Team. - `merchantCategoryCode` string: The MCC code which identifies the type of business conducted as ISO 18245 4-digit code (https://en.wikipedia.org/wiki/ISO_18245). Used for PXP Financial risk screening, partner commissioning and by the card schemes. - `incorporationCountryCode` string, required: The country code of the country of incorporation as it appears on the company registry as ISO 3166-2 alpha-2 (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Used by the PXP Financial Pre-Screening Team. - `estimatedMonthlyVolumeInEUR` number: An amount in EUR that gives an indication of the expected monthly turnover of the merchant. Used for screening purposes by the PXP Financial Pre-Screening Team. - `averageAmountPerTransactionInEUR` number: An amount in EUR that gives an indication of the average authorization amounts. Used for screening purposes by the PXP Financial Pre-Screening Team. - `isAnyRelatedPersonListedOnPEP` boolean: The information if one of the related persons are listed on PEP. PEP is short for 'politically exposed person', a natural person who is or who has been entrusted with prominent public functions. Used by the PXP Financial Risk Team. - `settlementCurrencies` string[]: A list of all currencies required for settlements. Used by the PXP Financial Pre-Screening Team. - `fraudRatiosForThePastMonths` object[]: Contains a list of fraud ratios for the last three months for the specific card schemes (Visa, Mastercard), expressed in percentage. Applicable for merchants that are already accepting cards. - `cardScheme` 'Mastercard' | 'Visa': The card scheme for which the fraud ratios are provided. - `months` number[]: The fraud ratios for the last 3 months - `chargebackCountRatiosForThePastMonths` object[]: Contains a list of chargeback count ratios for the last three months for the specific card schemes (Visa, Mastercard), expressed in percentage. Applicable for merchants that are already accepting cards. - `cardScheme` 'Mastercard' | 'Visa': The card scheme for which the chargeback ratios are provided. - `months` number[]: The chargeback count ratios for the last 3 months - `notes` string: Additional details relevant for the merchant business setup and for the current pre-screening request. Used by the PXP Financial Pre-Screening Team. - `partnerId` string, required: The id of the partner that is submitting this pre-screening request. This id is assigned upon partner onboarding and should be used for all applications. - `shops` NewPreScreenShop[], required: Contains a list of shop details to be validated before the registration request is sent. - `name` string, required: A short text, usually the shop name or abbreviation. Used by the PXP Financial Pre-Screening Team. - `cardAcceptanceMode` 'CP' | 'CNP', required: The information if the Shop operates in card present (CP) or card not present (CNP) mode. Used for setting up the Shop correctly with the Card Schemes. - `isMotoOnlyBusiness` boolean: The information if a card not present (CNP) shop processes only MOTO transactions. Used to decide if a URL needs to be provided. - `url` string: The URL of the shop's main website where the items/goods/services are sold if cardAcceptanceMode equals CNP (ecommerce). The URL of the company website if cardAcceptanceMode equals CP (POS). Used for screening purposes by the PXP Financial Risk Team. - `domainOwnership` 'Own' | 'RetailPlatform': The information if the domain is owned by the merchant or its belongs to a retail platform. Used by the PXP Financial Risk Team. - `activationState` 'LiveAcceptingCards' | 'LiveNotAcceptingCards' | 'Test' | 'BetaVersion': The information if the provided URL is already live or still in a test mode. Used by the PXP Financial Risk Team. ## Response `201` Successful operation - PreScreenMerchant: Contains the merchant and shop related pre-screening data and the current status of the check result. - `id` string: The unique identifier of the prescreen-merchant data element which has to be used for the merchant registration request for a new merchant. - `name` string: A short text, usually the company name or abbreviation. Used by the PXP Financial Pre-Screening Team. - `legalName` string: The company name as it is officially incorporated. Used for reports and invoices and is also shown in the footer area of the PXP Financial Checkout. - `state` 'Approved' | 'Declined' | 'Pending': The current state of the prescreen-merchant check. Used for identifying if the PXP Financial Pre-Screening has approved or declined the potential merchant/shops. - `customerDueDiligenceLevel` 'Simplified' | 'Standard' | 'Enhanced': The definition which CDD (Customer Due Diligence) information is required to be transmitted in the POST /merchant and POST /documents request. Only provided if the request was approved by the PXP Financial Pre-Screening Team. - `isQualifiedForFastOnboarding` boolean: The result if the merchant is qualified for fast onboarding after evaluation of the prescreen data. - `legalForm` 'NonProfitCorporation' | 'Partnership' | 'PrivateCompany' | 'PublicListedCompany' | 'SoleProprietor' | 'SoleTrader' | 'Trust' | 'UnincorporatedAssociation': The legal form of the company. Used by the PXP Financial Pre-Screening Team. - `merchantCategoryCode` string: The MCC code which identifies the type of business conducted as ISO 18245 4-digit code (https://en.wikipedia.org/wiki/ISO_18245). Used for PXP Financial risk screening, partner commissioning and by the card schemes. - `incorporationCountryCode` string: The country code of the country of incorporation as it appears on the company registry as ISO 3166-2 alpha-2 (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Used by the PXP Financial Pre-Screening Team. - `estimatedMonthlyVolumeInEUR` number: An amount in EUR that gives an indication of the expected monthly turnover of the merchant. Used for screening purposes by the PXP Financial Pre-Screening Team. - `averageAmountPerTransactionInEUR` number: An amount in EUR that gives an indication of the average authorization amounts. Used for screening purposes by the PXP Financial Pre-Screening Team. - `isAnyRelatedPersonListedOnPEP` boolean: The information if one of the related persons are listed on PEP. PEP is short for 'politically exposed person', a natural person who is or who has been entrusted with prominent public functions. Used by the PXP Financial Risk Team. - `settlementCurrencies` string[]: A list of all currencies required for settlements. Used by the PXP Financial Pre-Screening Team. - `fraudRatiosForThePastMonths` object[]: Contains a list of fraud ratios for the last three months for the specific card schemes (Visa, Mastercard), expressed in percentage. Applicable for merchants that are already accepting cards. - `cardScheme` 'Mastercard' | 'Visa': The card scheme for which the fraud ratios are provided. - `months` number[]: The fraud ratios for the last 3 months - `chargebackCountRatiosForThePastMonths` object[]: Contains a list of chargeback count ratios for the last three months for the specific card schemes (Visa, Mastercard), expressed in percentage. Applicable for merchants that are already accepting cards. - `cardScheme` 'Mastercard' | 'Visa': The card scheme for which the chargeback ratios are provided. - `months` number[]: The chargeback count ratios for the last 3 months - `notes` string: Additional details relevant for the merchant business setup and for the current pre-screening request. Used by the PXP Financial Pre-Screening Team. - `partnerId` string: The id of the partner that is submitting this pre-screening request. This id is assigned upon partner onboarding and should be used for all applications. - `shops` PreScreenShop[]: Contains a list of shop details to be validated before the registration request is sent. - `id` string: The unique identifier of the shop-prescreening data element for the particular shop which has to be used for the shop registration request for an existing merchant (newShop). - `name` string: A short text, usually the shop name or abbreviation. Used by the PXP Financial Pre-Screening Team. - `cardAcceptanceMode` 'CP' | 'CNP': The information if the Shop operates in card present (CP) or card not present (CNP) mode. Used for setting up the Shop correctly with the Card Schemes. - `isMotoOnlyBusiness` boolean: The information if a card not present (CNP) shop processes only MOTO transactions. Used to decide if a URL needs to be provided. - `url` string: The URL of the shop's main website where the items/goods/services are sold if cardAcceptanceMode equals CNP (ecommerce). The URL of the company website if cardAcceptanceMode equals CP (POS). Used for screening purposes by the PXP Financial Risk Team. - `domainOwnership` 'Own' | 'RetailPlatform': The information if the domain is owned by the merchant or its belongs to a retail platform. Used by the PXP Financial Risk Team. - `activationState` 'LiveAcceptingCards' | 'LiveNotAcceptingCards' | 'Test' | 'BetaVersion': The information if the provided URL is already live or still in a test mode. Used by the PXP Financial Risk Team. - `state` 'Approved' | 'Declined' | 'Pending': The current state of the pre-screening check. Used for identifying if the PXP Financial Pre-Screening has approved or declined the potential shop/merchant. ## Other responses - `400`: Error occurred --- [API](https://skmtc.dev/kalixa/apis/payment-service-v6-merchant-onboarding.md) - [All operations](https://skmtc.dev/kalixa/apis/payment-service-v6-merchant-onboarding/llms.txt) - [OpenAPI document](https://skmtc.dev/kalixa/apis/payment-service-v6-merchant-onboarding/revisions/066120f66046?raw)