KAkalixa

Registers a new merchant.

Registers a new merchant.

post/merchants

Request

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

Request body

namestring required

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

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.

legalForm'NonProfitCorporation' | 'Partnership' | 'PrivateCompany' | 'PublicListedCompany' | 'SoleProprietor' | 'SoleTrader' | 'Trust' | 'UnincorporatedAssociation' required

The legal form of the company. Used by the PXP Financial Risk 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.

pciLevelinteger

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.

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

incorporationNumberstring required

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.

taxNumberstring required

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.

baseCurrencyCodestring

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.

estimatedMonthlyVolumeInEURnumber required

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.

lowestAmountPerTransactionInEURnumber

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.

highestAmountPerTransactionInEURnumber

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.

averageAmountPerTransactionInEURnumber required

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

estimatedNumberOfTransactionsPerMonthnumber

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

isStartUpboolean

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

isChargebackOrFraudAnalysisProcessInPlaceboolean

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

isRegulatedByAMLGuidelineboolean

The information if the merchant's business is regulated by AML guidance. Used by the PXP Financial Risk Team.

settlementCurrenciesstring[]

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

companyPhoneNumberstring required

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

licenseOrAuthorizationNumberstring

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.

businessLicenseExpirationDatestring

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.

deliveryOrFulfillmentTimeframe'Instant' | 'UpTo7' | 'UpTo14' | 'UpTo30' | 'MoreThan30'

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.

vatNumberstring

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.

preScreenMerchantIdstring

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.

partnerIdstring required

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.

Example request

{
  "name": "Monsters University",
  "legalName": "Monsters University Inc.",
  "incorporationAddress": {
    "street": "Tottenhamroad 123",
    "city": "London",
    "postalCode": "AHC 334",
    "country": "GB"
  },
  "operationAddress": {
    "street": "Tottenhamroad 123",
    "city": "London",
    "postalCode": "AHC 334",
    "country": "GB"
  },
  "billingAddress": {
    "street": "Tottenhamroad 123",
    "city": "London",
    "postalCode": "AHC 334",
    "country": "GB"
  },
  "pciLevel": 1,
  "incorporationDate": "2020-12-09T09:46:18.643Z",
  "incorporationNumber": "U4567UP1234234",
  "taxNumber": "ATU99999978",
  "paymentMethodConfig": {
    "cardDeposit": {
      "useAccountStatusInquiry": true
    }
  },
  "baseCurrencyCode": "EUR",
  "estimatedMonthlyVolumeInEUR": 10000,
  "lowestAmountPerTransactionInEUR": 10,
  "highestAmountPerTransactionInEUR": 5000,
  "averageAmountPerTransactionInEUR": 200,
  "estimatedNumberOfTransactionsPerMonth": 1000,
  "settlementCurrencies": [
    "EUR"
  ],
  "fraudRatiosForThePastMonths": [
    {
      "months": [
        0.32
      ]
    }
  ],
  "chargebackCountRatiosForThePastMonths": [
    {
      "months": [
        0.32
      ]
    }
  ],
  "companyPhoneNumber": "+431234567890-1",
  "licenseOrAuthorizationNumber": "A1884B1111-01",
  "businessLicenseExpirationDate": "2020-12-09T09:46:18.643Z",
  "vatNumber": "DE999999999",
  "preScreenMerchantId": "PartnerABC",
  "partnerId": "PartnerABC",
  "shops": [
    {
      "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
      },
      "questionAnswerPairs": [
        {
          "questionId": "TimeAcceptingCards",
          "answer": "five years"
        }
      ],
      "preScreenShopId": "da8223fb-ae7b-4c78-a94f-0fc43beb5318"
    }
  ],
  "relatedPeople": [
    {
      "firstname": "Paul",
      "lastname": "Smith",
      "address": {
        "street": "Tottenhamroad 123",
        "city": "London",
        "postalCode": "AHC 334",
        "country": "GB"
      },
      "dateOfBirth": "2020-12-09T09:46:18.645Z",
      "skypeName": "PaulSmith461029",
      "email": "paul.smith@testabc.com",
      "shareOrOwnershipPercentage": 51,
      "passportOrGovernmentNumber": "1633PY-111Z",
      "passportOrGovernmentIDExpirationDate": "2020-12-09T09:46:18.645Z"
    }
  ],
  "relatedCompanies": [
    {
      "name": "Master Universe Inc.",
      "incorporationAddress": {
        "street": "Tottenhamroad 123",
        "city": "London",
        "postalCode": "AHC 334",
        "country": "GB"
      },
      "taxNumber": "ATU99999978",
      "incorporationDate": "2020-12-09T09:46:18.646Z",
      "incorporationNumber": "U4567UP1234234",
      "shareOrOwnershipPercentage": 25
    }
  ],
  "bankAccounts": [
    {
      "bankName": "Erste Bank",
      "countryCode": "AT",
      "currencyCode": "EUR",
      "holderName": "Max Mayer",
      "iban": "AT990000111122223333",
      "bic": "DABAIE2D"
    }
  ],
  "questionAnswerPairs": [
    {
      "questionId": "TimeAcceptingCards",
      "answer": "five years"
    }
  ]
}

Response

Successful operation

idstring

The unique identifier of the merchant, which was received in the response of a new merchant registration.

namestring

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

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.

legalForm'NonProfitCorporation' | 'Partnership' | 'PrivateCompany' | 'PublicListedCompany' | 'SoleProprietor' | 'SoleTrader' | 'Trust' | 'UnincorporatedAssociation'

The legal form of the company. Used by the PXP Financial Risk 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.

pciLevelinteger

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.

incorporationDatestring

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.

incorporationNumberstring

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.

taxNumberstring

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.

baseCurrencyCodestring

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.

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 Risk Team.

lowestAmountPerTransactionInEURnumber

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.

highestAmountPerTransactionInEURnumber

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.

averageAmountPerTransactionInEURnumber

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

estimatedNumberOfTransactionsPerMonthnumber

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

isStartUpboolean

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

isChargebackOrFraudAnalysisProcessInPlaceboolean

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

isRegulatedByAMLGuidelineboolean

The information if the merchant's business is regulated by AML guidance. Used by the PXP Financial Risk Team.

isQualifiedForFastOnboardingboolean

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

settlementCurrenciesstring[]

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

statestring

The current state of the merchant. Used for identifying the activation or blocking status.

stateReasonstring

Additional details for the current merchant state. Used for providing a reason for the current merchant state.

cardPresentMidstring

The merchant identifier to be used in payment initiations for a card present (CP/POS) shop. Applicable only for merchants with shops where cardAcceptanceMode equals CP (POS). See https://developer.kalixa.com/docs/cp-cnp-merchant-shops#section-submitting-card-payments-for-pos-cp-shops for more information about submitting card payments for POS (CP) shops.

companyPhoneNumberstring

The primary phone number to get in contact

licenseOrAuthorizationNumberstring

The number of the license/authorization held by the merchant.

businessLicenseExpirationDatestring

The date when the business license/authorization expires. Used for screening purposes by the PXP Financial Risk Team.

deliveryOrFulfillmentTimeframe'Instant' | 'UpTo7' | 'UpTo14' | 'UpTo30' | 'MoreThan30'

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.

vatNumberstring

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.

Example response

{
  "id": "f0deffbc-9c87-40aa-b863-5e2b6caf14a7",
  "name": "Monsters University",
  "legalName": "Monsters University Inc.",
  "incorporationAddress": {
    "street": "Tottenhamroad 123",
    "city": "London",
    "postalCode": "AHC 334",
    "country": "GB"
  },
  "operationAddress": {
    "street": "Tottenhamroad 123",
    "city": "London",
    "postalCode": "AHC 334",
    "country": "GB"
  },
  "billingAddress": {
    "street": "Tottenhamroad 123",
    "city": "London",
    "postalCode": "AHC 334",
    "country": "GB"
  },
  "pciLevel": 1,
  "incorporationDate": "2020-12-09T09:46:18.644Z",
  "incorporationNumber": "U4567UP1234234",
  "taxNumber": "ATU99999978",
  "paymentMethodConfig": {
    "cardDeposit": {
      "useAccountStatusInquiry": true
    }
  },
  "baseCurrencyCode": "EUR",
  "estimatedMonthlyVolumeInEUR": 10000,
  "lowestAmountPerTransactionInEUR": 10,
  "estimatedNumberOfTransactionsPerMonth": 1000,
  "isQualifiedForFastOnboarding": true,
  "settlementCurrencies": [
    "EUR"
  ],
  "fraudRatiosForThePastMonths": [
    {
      "months": [
        0.32
      ]
    }
  ],
  "chargebackCountRatiosForThePastMonths": [
    {
      "months": [
        0.32
      ]
    }
  ],
  "state": "Active",
  "stateReason": "Already Processing",
  "partner": {
    "id": "f6b4d04e-1a67-4f7b-a6b0-181636af3290"
  },
  "companyPhoneNumber": "+431234567890-1",
  "licenseOrAuthorizationNumber": "A1884B1111-01",
  "businessLicenseExpirationDate": "2020-12-09T09:46:18.644Z",
  "vatNumber": "DE999999999",
  "documents": [
    {
      "id": "f6b4d04e-1a67-4f7b-a6b0-181636af3290"
    }
  ],
  "shops": [
    {
      "id": "f6b4d04e-1a67-4f7b-a6b0-181636af3290"
    }
  ],
  "relatedPeople": [
    {
      "id": "f6b4d04e-1a67-4f7b-a6b0-181636af3290"
    }
  ],
  "relatedCompanies": [
    {
      "id": "f6b4d04e-1a67-4f7b-a6b0-181636af3290"
    }
  ],
  "bankAccounts": [
    {
      "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.