--- title: "Returns a single merchant's data." method: GET path: "/merchants/{merchantId}" --- # Returns a single merchant's data. `GET /merchants/{merchantId}` ## Request - Base URL: `https://api.test.kalixa.com/payment-service/v6` - URL: `https://api.test.kalixa.com/payment-service/v6/merchants/{merchantId}` - Auth: HTTP basic Returns a single merchant's data. ## Path parameters - `merchantId` string, required ## Response `200` Successful operation - Merchant: Contains the merchant data. - `id` string: The unique identifier of the merchant, which was received in the response of a new merchant registration. - `name` string: A short text, usually the company name or abbreviation. Used for display and filtering purposes the PS Admin tool. - `legalName` string: 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` Address: Contains the address of a merchant, person or company. - `street` string, required: The Street including housenumber, housename, etc. - `city` string, required: The name of the city. - `postalCode` string, required: The postal code of the address. - `country` string, required: The address country code as ISO 3166-1 alpha-2 (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). - `operationAddress` Address: Contains the address of a merchant, person or company. - `street` string, required: The Street including housenumber, housename, etc. - `city` string, required: The name of the city. - `postalCode` string, required: The postal code of the address. - `country` string, required: The address country code as ISO 3166-1 alpha-2 (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). - `billingAddress` Address: Contains the address of a merchant, person or company. - `street` string, required: The Street including housenumber, housename, etc. - `city` string, required: The name of the city. - `postalCode` string, required: The postal code of the address. - `country` string, required: The address country code as ISO 3166-1 alpha-2 (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). - `legalForm` 'NonProfitCorporation' | 'Partnership' | 'PrivateCompany' | 'PublicListedCompany' | 'SoleProprietor' | 'SoleTrader' | 'Trust' | 'UnincorporatedAssociation': The legal form of the company. Used by the PXP Financial Risk Team. - `merchantCategoryCode` 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. - `pciLevel` integer: 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. - `incorporationDate` string: 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. - `incorporationNumber` string: 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. - `taxNumber` string: 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. - `cardDeposit` object - `useAccountStatusInquiry` boolean: The information if Account Status Inquiry is required (true) or not (false). Used for activating of the Card Verification Payment Methods in Payment Service in case the value is true. - `baseCurrencyCode` 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. - `estimatedMonthlyVolumeInEUR` number: 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. - `lowestAmountPerTransactionInEUR` number: 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. - `highestAmountPerTransactionInEUR` number: 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. - `averageAmountPerTransactionInEUR` number: An amount in EUR that gives an indication of the average authorization amounts. Used for screening purposes by the PXP Financial Risk Team. - `estimatedNumberOfTransactionsPerMonth` number: An estimate about the number of authorizations per month. Used for screening purposes by the PXP Financial Risk Team. - `isStartUp` boolean: The information if the merchant is a start up company. Used by the PXP Financial Risk Team. - `isChargebackOrFraudAnalysisProcessInPlace` boolean: The information if the merchant has a chargeback or fraud analysis process in place. Used by the PXP Financial Risk Team. - `isRegulatedByAMLGuideline` boolean: The information if the merchant's business is regulated by AML guidance. Used by the PXP Financial Risk Team. - `isQualifiedForFastOnboarding` boolean: The result if the merchant is qualified for fast onboarding after evaluation of the prescreen data. - `settlementCurrencies` string[]: A list of all currencies required for settlements. Used by the PXP Financial Pre-Screening Team. - `fraudRatiosForThePastMonths` object[]: 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. - `cardScheme` 'Mastercard' | 'Visa': The card scheme for which the fraud ratios are provided. - `months` number[]: The fraud ratios for the last 3 months - `chargebackCountRatiosForThePastMonths` object[]: 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. - `cardScheme` 'Mastercard' | 'Visa': The card scheme for which the chargeback ratios are provided. - `months` number[]: The chargeback count ratios for the last 3 months - `state` string: The current state of the merchant. Used for identifying the activation or blocking status. - `stateReason` string: Additional details for the current merchant state. Used for providing a reason for the current merchant state. - `cardPresentMid` string: 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. - `partner` ObjectWithId: Contains only the id of the resource. Used for future extensibility. - `id` string: The id of the resource. - `companyPhoneNumber` string: The primary phone number to get in contact - `licenseOrAuthorizationNumber` string: The number of the license/authorization held by the merchant. - `businessLicenseExpirationDate` string: 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. - `vatNumber` 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. - `documents` ObjectWithId[]: Contains a list of documents assigned for this merchant. - `id` string: The id of the resource. - `shops` ObjectWithId[]: Contains a list of shops registered for this merchant. - `id` string: The id of the resource. - `relatedPeople` ObjectWithId[]: Contains a list of persons related to this merchant. - `id` string: The id of the resource. - `relatedCompanies` ObjectWithId[]: Contains a list of companies related to this merchant. - `id` string: The id of the resource. - `bankAccounts` ObjectWithId[]: Contains a list of bank accounts related to this merchant. - `id` string: The id of the resource. - `questionAnswerPairs` QuestionAnswerPair[]: Contains a list of previously submitted questions and answers for the new shop. - `questionId` string: The predefined literal id of the question. See https://developer.kalixa.com/v1.0/docs/questions for more information. - `answer` string: The answer to the question, as provided by the merchant. Used for screening purposes. ## Other responses - `400`: Error occurred --- [API](https://skmtc.dev/kalixa/apis/payment-service-v6-merchant-onboarding.md) - [All operations](https://skmtc.dev/kalixa/apis/payment-service-v6-merchant-onboarding/llms.txt) - [OpenAPI document](https://skmtc.dev/kalixa/apis/payment-service-v6-merchant-onboarding/revisions/066120f66046?raw)