Registers a new shop related to a merchant.

post/shops

Request

Base URL
https://api.test.kalixa.com/payment-service/v6
URL
https://api.test.kalixa.com/payment-service/v6/shops
Auth
HTTP basic

Request body

namestring required

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

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.

isMotoOnlyBusinessboolean

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

urlstring

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.

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

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

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

merchantIdstring required

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

preScreenShopIdstring

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.

Example request

{
  "name": "Monster Shop",
  "url": "http://www.kalixa.com/",
  "countryCode": "AT",
  "billingDescriptor1": "Monster Shop",
  "billingDescriptor2": "Vienna",
  "volumeSpreadByProcessing": {
    "ecom": 25,
    "moto": 25,
    "recurring": 50
  },
  "volumeSpreadByRegion": {
    "northAmerica": 25,
    "europeanEconomicArea": 25,
    "asia": 25,
    "latinAmerica": 20,
    "others": 5
  },
  "volumeSpreadByScheme": {
    "visa": 25,
    "mastercard": 25,
    "others": 50
  },
  "merchantId": "f6b4d04e-1a67-4f7b-a6b0-181636af3290",
  "questionAnswerPairs": [
    {
      "questionId": "TimeAcceptingCards",
      "answer": "five years"
    }
  ],
  "preScreenShopId": "da8223fb-ae7b-4c78-a94f-0fc43beb5318"
}

Response

Successful operation

idstring

The id of the registered shop. Used for identifying the shop in other methods e.g. getShop.

namestring

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

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.

isMotoOnlyBusinessboolean

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

urlstring

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.

approvalState'Approved' | 'Declined' | 'Pending'

The information if the shop was approved, declined or if the approval is still pending.

countryCodestring

billingDescriptor1string

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.

billingDescriptor2string

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.

Example response

{
  "id": "da8223fb-ae7b-4c78-a94f-0fc43beb5318",
  "name": "Monster Shop",
  "url": "http://www.kalixa.com/",
  "approvalState": "Active",
  "countryCode": "AT",
  "billingDescriptor1": "Monster Shop",
  "billingDescriptor2": "Vienna",
  "volumeSpreadByProcessing": {
    "ecom": 25,
    "moto": 25,
    "recurring": 50
  },
  "volumeSpreadByRegion": {
    "northAmerica": 25,
    "europeanEconomicArea": 25,
    "asia": 25,
    "latinAmerica": 20,
    "others": 5
  },
  "volumeSpreadByScheme": {
    "visa": 25,
    "mastercard": 25,
    "others": 50
  },
  "merchant": {
    "id": "f6b4d04e-1a67-4f7b-a6b0-181636af3290"
  },
  "documents": [
    {
      "id": "f6b4d04e-1a67-4f7b-a6b0-181636af3290"
    }
  ],
  "questionAnswerPairs": [
    {
      "questionId": "TimeAcceptingCards",
      "answer": "five years"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.