--- title: "Merchant:Info" method: GET path: "/v2/merchants/{merchantCode}/info" tags: ["Merchants"] --- # Merchant:Info `GET /v2/merchants/{merchantCode}/info` Get detailed information of a specific merchant ## Path parameters - `merchantCode` string, required ## Response `200` OK - MerchantMerchantOutput — Detailed representation of a merchant. - `code` string — The merchant id of your company starting with M. - `name` string — The name of the merchant. - `publicName` string, nullable — The public name of your merchant. - `boardingStatus` 'REGISTERED' | 'ONBOARDING' | 'ACCEPTED' | 'SUSPENDED' | 'OFFBOARDED' — The status of the boarding process for this merchant. - `status` 'ACTIVE' | 'INACTIVE' — The status of the merchant. - `payoutStatus` 'ENABLED' | 'DISABLED' — Whether this merchant has payouts enabled. - `coc` string, nullable — Your Chamber of commerce registration number. This format differs per country. - `vat` string, nullable — Value added tax identification number (VAT identification number). - `companyTypeId` string, nullable — ID of the company type. The available company types can be retrieved with the CompanyTypes Core Data API (https://developer.pay.nl/reference/get_companytypes) - `countryCode` string — The country code consisting of 2 uppercase letters - `contractPackageCode` string — The active contract package scramble code - `currentProfileCode` string, nullable — The contract profile scramble code - `contractLanguage` string, nullable — The language code supplied needs to be a locale in i18n format. The available languages can be retrieved with the Core Data API Languages (https://developer.pay.nl/reference/get_languages) where the contractLanguageAvailable flag is set to 'True' - `contractPackage` string, nullable - `contactPhone` string, nullable — The primary contact phone number. - `contactEmail` string, nullable — The primary contact email address. - `establishmentLegalRegistrationNumber` string, nullable — The legal registration number of the establishment. - `accountManager` string, nullable — The account manager' email assigned to this merchant. - `website` string, nullable — The website. - `categories` MerchantMerchantOutputCategory[] — The categories linked to this merchant. - `code` string — The CY-code for a category. - `name` string — The category name. - `integrations` MerchantMerchantOutputIntegration[] — The integrations linked to this merchant. - `code` string — The PL-code for a integration. - `name` string — The integration name. - `clearingAccounts` MerchantMerchantOutputClearingAccount[] — The clearing accounts linked to this merchant. - `code` string — The BA-code of the merchant clearing account. - `status` 'APPROVED' | 'DENIED' | 'NOT_CHECKED' — The status of the merchant clearing account. - `method` string — The method of the merchant clearing account. - `iban` MerchantMerchantOutputIban — Represents the IBAN information in the clearing account output. - `iban` string — The International Bank Account Number (IBAN). - `bic` string, nullable — The Business Identifier Codes (BIC/SWIFT). - `owner` string — The owner of the bank account. - `postalAddress` AddressOutput — A physical address. - `code` string — The address code identifier. - `streetName` string — The name of the street. - `streetNumber` string — The street number. - `zipCode` string — A zip/postal code. see https://en.wikipedia.org/wiki/List_of_postal_codes for a list of formats per country. - `city` string — The name of a city. - `countryCode` string — The country code consisting of 2 uppercase letters. - `visitAddress` AddressOutput — A physical address. - `code` string — The address code identifier. - `streetName` string — The name of the street. - `streetNumber` string — The street number. - `zipCode` string — A zip/postal code. see https://en.wikipedia.org/wiki/List_of_postal_codes for a list of formats per country. - `city` string — The name of a city. - `countryCode` string — The country code consisting of 2 uppercase letters. - `addresses` MerchantAddressOutput[] - `type` 'COMPANY' | 'POSTAL' | 'VISIT' — The type of the address. (visit, postal, company) - `code` string — The address code identifier. - `streetName` string — The name of the street. - `streetNumber` string — The street number. - `zipCode` string — A zip/postal code. see https://en.wikipedia.org/wiki/List_of_postal_codes for a list of formats per country. - `city` string — The name of a city. - `countryCode` string — The country code consisting of 2 uppercase letters. - `contactMethods` MerchantMerchantOutputContactMethod[] — The contact methods of the merchant. - `code` string — The CM-code for a contact method. - `type` 'email' | 'email_support' | 'phone' | 'phone_helpdesk' | 'phone_off_hours' | 'url' | 'messaging_app' | 'email_msnskype' — The type of contact method. - `value` string — The value of the contact method - `description` string — The description of the contact method - `public` boolean — Is the contact method public accessible - `notifications` boolean — Does the contact method needs to receive notifications - `authenticationTokens` MerchantMerchantOutputAuthenticationToken[] — The authentication tokens linked to this merchant. - `code` string — The AT-code for an authentication token. - `secret` string — A 40 character secret - `name` string — The description of the token - `trademarks` MerchantMerchantOutputTrademark[] — The trademarks linked to this merchant. - `code` string — The TM-code for a trademark. - `type` string — The type of the trademark. - `name` string — The name of the trademark. - `status` string — The status of the trademark. - `licenses` MerchantMerchantOutputLicense[] — The licenses linked to this merchant. - `code` string — The AL-code of the license. - `name` string — The name of the license. - `language` string — The language of the license. - `documents` MerchantMerchantOutputDocument[] — The documents of the license. - `code` string — The D-code for a document. - `type` string — The type of the document. - `status` string — The status of the document - `name` string — The name of the document. - `description` string — The description of the document. - `translations` object — Object containing all the translations with the property name in which the corresponds with a property on the object itself. - `createdAt` string, date-time — The date and time the document was created. - `createdBy` string, nullable — The user who created the document. - `acceptedAt` string, date-time, nullable — The date and time the document was accepted. - `declineReason` string, nullable — The reason why the document was declined. - `declinedAt` string, date-time, nullable — The date and time the document was declined. - `modifiedAt` string, date-time, nullable — The date and time the document was modified. - `modifiedBy` string, nullable — The user who modified the document. - `deletedAt` string, date-time, nullable — The date and time the document was deleted. - `deletedBy` string, nullable — The user who deleted the document. - `services` MerchantMerchantOutputServiceLocation[] — The services linked to this merchant. - `code` string — The code of your service. You can find the service code here: https://my.pay.nl/programs/programs - `secret` string, nullable — The secret of the service location. - `name` string — The name of the service location. - `status` string — The status of the service location. - `category` MerchantMerchantOutputCategory — Represents the Category information in the Merchant output. - `code` string — The CY-code for a category. - `name` string — The category name. - `integration` MerchantMerchantOutputIntegration — Represents the Integration Information in the Merchant output. - `code` string — The PL-code for a integration. - `name` string — The integration name. - `contactPhone` string, nullable — The primary contact phone number. - `contactEmail` string, nullable — The primary contact phone number. - `website` string — The website of the service location. - `urls` MerchantMerchantOutputServiceLocationUrl[] — The urls of the service location. - `code` string — The WU-code of the service location url. - `website` string — The website of the service location url. - `partner` MerchantMerchantOutputPartner[] - `code` string - `name` string - `type` union - 'PARENT' | 'REFERRAL' | 'ALLIANCE' | 'BP' | 'ISO' | 'FI' | 'SP' | 'CPSP' | 'UNKNOWN' - string - `accessToMerchant` boolean - `documents` MerchantMerchantOutputDocument[] — The documents linked to this merchant. - `code` string — The D-code for a document. - `type` string — The type of the document. - `status` string — The status of the document - `name` string — The name of the document. - `description` string — The description of the document. - `translations` object — Object containing all the translations with the property name in which the corresponds with a property on the object itself. - `createdAt` string, date-time — The date and time the document was created. - `createdBy` string, nullable — The user who created the document. - `acceptedAt` string, date-time, nullable — The date and time the document was accepted. - `declineReason` string, nullable — The reason why the document was declined. - `declinedAt` string, date-time, nullable — The date and time the document was declined. - `modifiedAt` string, date-time, nullable — The date and time the document was modified. - `modifiedBy` string, nullable — The user who modified the document. - `deletedAt` string, date-time, nullable — The date and time the document was deleted. - `deletedBy` string, nullable — The user who deleted the document. - `settings` MerchantMerchantOutputSettingsOutput — Represents the Settings information in the merchant output. - `clearing` MerchantMerchantOutputSettingsOutputClearingSettings — Represents the Clearing configuration information in the merchant output. - `clearingPeriod` string - `clearingFrequency` string - `invoicePeriod` string - `invoiceFrequency` string - `splitByTurnoverGroup` boolean - `settlementPerClearing` boolean, nullable - `clearingMoment` string - `mt940` MerchantMerchantOutputSettingsOutputClearingSettingsMt940Settings — Represents the Merchant MT940 settings in the Clearing Settings output. - `bankAccount` string, nullable - `type` string - `customInput` string, nullable - `layout` MerchantMerchantOutputSettingsOutputLayoutSettings — Represents the Layout settings in the Settings output. - `code` string, nullable - `createdAt` string, date-time — The date and time at which this entity was created in ISO-8601 (ATOM) notation - `createdBy` string — The reference to an account or token whom created the entity - `acceptedAt` string, date-time, nullable — The date and time at which this merchant was accepted in ISO-8601 (ATOM) notation. - `suspendedAt` string, date-time, nullable — The date and time at which this merchant was suspended in ISO-8601 (ATOM) notation. - `suspendedBy` string, nullable — The reference to an account or token whom suspended this merchant - `modifiedAt` string, date-time, nullable — The date and time at which this entity was modified in ISO-8601 (ATOM) notation. - `modifiedBy` string, nullable — The reference to an account or token whom modified this entity - `deletedAt` string, date-time, nullable — The date and time at which this entity was deleted in ISO-8601 (ATOM) notation. - `deletedBy` string, nullable — The reference to an account or token whom deleted the entity - `reviewedAt` string, date-time, nullable — The date and time at which this merchant was reviewed by a Pay. employee. - `nextReviewDate` string, date-time, nullable — The date and time at which this merchant will be reviewed again. - `_links` LinkOutput[], nullable - `href` string, nullable — The URI to the linked resource - `rel` string, nullable — The name of the linked resource - `type` string, nullable — The (http(s)) method needed to approach the linked resource ## Other responses - `400` — Bad request, see response body for more information - `401` — Unauthorized. Supplied credentials are invalid - `403` — Forbidden. Supplied credentials have no rights - `404` — Resource not found - `405` — Used HTTP method is not allowed - `406` — Not acceptable. The supplied content type in the accept parameter in the header is not supported - `410` — Indicates that this resource is no longer available for use - `415` — Unsupported media. The supplied content type in the content-type parameter in the header is not supported - `429` — Rate limit reached. - `500` — An internal error occurred. - `503` — The server is currently unable to handle your request --- [API](https://skmtc.net/pay/apis/pay-transaction-gateway-unit-api.md) · [All operations](https://skmtc.net/pay/apis/pay-transaction-gateway-unit-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pay/pay-transaction-gateway-unit-api/versions/2bc260c7bdfc/schema)