GuidesAPI ReferenceDiscussions
API Reference

Registers a new merchant.

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

Registers a new merchant.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Contains the data of the new merchant.

string
required

A short text, usually the company name or abbreviation. Used for display and filtering purposes in the PS Admin tool.

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.

incorporationAddress
object
required

Contains the address of a merchant, person or company.

operationAddress
object

Contains the address of a merchant, person or company.

billingAddress
object

Contains the address of a merchant, person or company.

string
enum
required

The legal form of the company. Used by the PXP Financial Risk Team.

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.

integer
1 to 4

The Payment Card Industry level of the merchant. Used by the PXP Financial Risk Team. The PCI Level of a merchant can be either 1, 2, 3 or 4. See https://developer.kalixa.com/docs/required-documents#section-pci-documents for more information about PCI levels and the related documents.

string
required

The exact starting date of the corporation, as it appears on the company registry of the country of incorporation. Used for screening purposes by the PXP Financial Risk Team.

string
required
length between 1 and 50

The federal number assigned to the business in the company registry at the time of incorporation. Used for screening purposes by the PXP Financial Risk Team.

string
required
length between 1 and 20

The Taxpayer Identification Number (TIN) of the primary location in which the merchant is doing business. Used for screening purposes by the PXP Financial Risk Team.

paymentMethodConfig
object

Contains payment method specific configuration items.

string

The reporting currency of the merchant as ISO 4217 3-digit code (https://en.wikipedia.org/wiki/ISO_4217). Used in PXP Financial reports for aggregating authorized amounts in different currencies. If not provided, the default value is EUR.

number
required
≥ 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 Risk Team.

number
≥ 0.01

An amount in EUR that gives an indication of the minimum limit for authorized amounts. Used for screening purposes by the PXP Financial Risk Team.

number
≥ 1

An amount in EUR that gives an indication of the maximum limit for authorized amounts. Used for screening purposes by the PXP Financial Risk Team.

number
required
≥ 1

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

number
≥ 1

An estimate about the number of authorizations per month. Used for screening purposes by the PXP Financial Risk Team.

boolean

The information if the merchant is a start up company. Used by the PXP Financial Risk Team.

boolean

The information if the merchant has a chargeback or fraud analysis process in place. Used by the PXP Financial Risk Team.

boolean

The information if the merchant's business is regulated by AML guidance. 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
string
required

The primary phone number to be used to contact the merchant. Used for screening purposes by the PXP Financial Risk Team.

string
length between 1 and 50

The number of the license/authorization held by the merchant, if such a license is required to operate the business. Used for screening purposes by the PXP Financial Risk Team.

string

The date when the business license/authorization expires. Only needs to be provided in case such a license is required to operate the business. Used for screening purposes by the PXP Financial Risk Team.

string
enum

The delivery or fulfilment time for the items/goods/services that are sold by the merchants shops. Used for screening purposes by the PXP Financial Risk Team.

Allowed:
string

The value added tax identification number or VAT identification number (VATINT) of the primary location in which the merchant is doing business. Used for financial purposes.

string
length between 1 and 50

The unique identifier of the approved PreScreenMerchant element which was received in the response of a newPreScreenMerchant request (if applicable). Used for verifying that the pre-screened Merchant was approved.

string
required
length between 1 and 50

The id of the partner that is submitting this onboarding request. This id is assigned upon partner onboarding and should be used for all applications.

shops
array of objects
required
length ≥ 1

Contains an optional list of shops that the merchant sells items or services from. Shops can be registered also later on with a separate POST /shops call.

shops*
string
required

A short text, usually the shop name or abbreviation. Used for display and filtering purposes in the PS Admin tool.

string
enum
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.

Allowed:
boolean

The information if a card not present (CNP) shop processes only MOTO transactions. Used to decide if a URL needs to be provided.

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.

string
enum

The information if the domain is owned by the merchant or its belongs to a retail platform. Used by the PXP Financial Risk Team.

Allowed:
string
enum

The information if the provided URL is already live or still in a test mode. Used by the PXP Financial Risk Team.

Allowed:
string
required

The country code of the country out of which this website operates or does the main business as ISO 3166-1 alpha-2 (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Used for screening purposes by the PXP Financial Risk Team.

string
required

The name of the Shop in a way the customer recognizes it. Used for card transactions and will appear on the 1st line of the billing descriptor.

string
required

Usually the location out of which the shop operates. Used for card transactions acquired by PXP Financial and will appear on the 2nd line of the billing descriptor.

volumeSpreadByProcessing
object

An indication how the volume is expected to be distributed across different types of transactions. Expressed in percentage which needs to sum up to 100. Applicable only for shops where cardAcceptanceMode equals CNP (ecommerce). Used for screening purposes by the PXP Financial Risk Team.

volumeSpreadByRegion
object

An indication how the volume is expected to be distributed across regions. Expressed in percentage which needs to sum up to 100. Applicable only for shops where cardAcceptanceMode equals CNP (ecommerce). Used for screening purposes by the PXP Financial Risk Team.

volumeSpreadByScheme
object

An indication how the volume is expected to be distributed across schemes. Expressed in percentage which needs to sum up to 100. Applicable only for shops where cardAcceptanceMode equals CNP (ecommerce). Used for screening purposes by the PXP Financial Risk Team.

questionAnswerPairs
array of objects
required

Contains a list of questions and answers. Used for risk screening purposes.

questionAnswerPairs*
string
length between 1 and 50

The unique identifier of the approved PreScreenShop element which was received in the response of a newPreScreenMerchant request (if applicable). Used for verifying that the pre-screened Shop was approved.

relatedPeople
array of objects

Contains an optional list of all relevant people PXP Financial needs to be aware of. This includes owners, shareholders, technical or operational contacts, etc. Related people can be registered also later on with a separate POST /related-people call.

relatedPeople
relatedCompanies
array of objects

Contains an optional list of all related companies PXP Financial needs to be aware of. This could be the case if the company is owned, wholly or in part, by another company, which would need to be disclosed to PXP Financial. Related companies can be registered also later on with a separate POST /related-companies call.

relatedCompanies
bankAccounts
array of objects

Contains an optional list of bank accounts in case funds should be settled directly to the merchant. Bank accounts can be registered also later on with a separate POST /bank-accounts call.

bankAccounts
questionAnswerPairs
array of objects
required

Contains a list of questions and answers. Used for risk screening purposes.

questionAnswerPairs*
Responses

Updated 11 months ago

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 11 months ago