Uploads merchant and shop related details used for pre-screening.

post

https://api.test.kalixa.com/payment-service/v6/prescreen-merchants

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Contains the key parameters (e.g. shop URL) for a merchant/shop registration request to be checked upfront (pre-screening).

Contains merchant and shop related details used for pre-screening.

name

string

required

^(?!^ +$)^.{1,50}$

A short text, usually the company name or abbreviation. Used by the PXP Financial Pre-Screening Team.

legalName

string

required

^(?!^ +$)^.{1,50}$

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

string

enum

The legal form of the company. Used by the PXP Financial Pre-Screening Team.

merchantCategoryCode

string

^\d{4}$

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

^[A-Z]{2}$

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

≥ 1

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

≥ 1

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

array of strings

A list of all currencies required for settlements. Used by the PXP Financial Pre-Screening Team.

settlementCurrencies

fraudRatiosForThePastMonths

array of objects

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.

fraudRatiosForThePastMonths

chargebackCountRatiosForThePastMonths

array of objects

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.

chargebackCountRatiosForThePastMonths

notes

string

length between 1 and 4000

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

length between 1 and 50

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

array of objects

required

Contains a list of shop details to be validated before the registration request is sent.

shops*

Responses

201Successful operation

400Error occurred