Registers a new shop related to a merchant.

post

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Contains the data of the new shop.

name

string

required

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

cardAcceptanceMode

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:

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

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:

activationState

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:

countryCode

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.

billingDescriptor1

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.

billingDescriptor2

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.

merchantId

string

required

length between 1 and 50

The id of the merchant to which this shop belongs to. Used for associating the shop with the merchant.

questionAnswerPairs

array of objects

required

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

questionAnswerPairs*

preScreenShopId

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.

Responses

201Successful operation

400Error occurred