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

Request body

namestring required

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

legalNamestring 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.

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

merchantCategoryCodestring

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.

incorporationCountryCodestring 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.

estimatedMonthlyVolumeInEURnumber

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.

averageAmountPerTransactionInEURnumber

An amount in EUR that gives an indication of the average authorization amounts. Used for screening purposes by the PXP Financial Pre-Screening Team.

isAnyRelatedPersonListedOnPEPboolean

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.

settlementCurrenciesstring[]

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

notesstring

Additional details relevant for the merchant business setup and for the current pre-screening request. Used by the PXP Financial Pre-Screening Team.

partnerIdstring 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.

Example request

{
  "name": "Monsters University",
  "legalName": "Monsters University Inc.",
  "incorporationCountryCode": "AT",
  "estimatedMonthlyVolumeInEUR": 10000,
  "averageAmountPerTransactionInEUR": 200,
  "settlementCurrencies": [
    "EUR"
  ],
  "fraudRatiosForThePastMonths": [
    {
      "months": [
        0.32
      ]
    }
  ],
  "chargebackCountRatiosForThePastMonths": [
    {
      "months": [
        0.32
      ]
    }
  ],
  "notes": "The merchant operates in Austria only, please do not consider the German entity.",
  "partnerId": "f6b4d04e-1a67-4f7b-a6b0-181636af3290",
  "shops": [
    {
      "name": "Monster Shop",
      "url": "http://www.kalixa.com/"
    }
  ]
}

Response

Successful operation

idstring

The unique identifier of the prescreen-merchant data element which has to be used for the merchant registration request for a new merchant.

namestring

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

legalNamestring

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.

isQualifiedForFastOnboardingboolean

The result if the merchant is qualified for fast onboarding after evaluation of the prescreen data.