> ## Documentation Index > Fetch the complete documentation index at: https://docs.eximpe.com/llms.txt > Use this file to discover all available pages before exploring further. # Get Merchant Options > The values every dropdown field on a sub-merchant accepts, including the business categories you are approved for. ## Overview Returns the values the sub-merchant dropdown fields accept: countries, nationalities, organisation types, monthly volume bands, and the business categories **your** account is approved for. Fetch it before you build a [Create Merchant](https://docs.eximpe.com/api-reference/v3/merchant/create.md) request, and use the values exactly as listed. > [!NOTE] > > **Matching is case-insensitive; storage is not.** `india` and `INDIA` are both accepted for `India`, and `goods` for `GOODS`. This applies to countries, nationalities, organisation types, volume bands and business categories. The sub-merchant always stores and returns the listed spelling, accents included (`Curaçao`, `Burkinabé`); business categories are returned in upper case. HS codes are not listed here. There are thousands of them, so look them up with [Search HS Codes](https://docs.eximpe.com/api-reference/v3/merchant/hs-codes.md). ## Response | Name | Type | Used by | | - | - | - | | countries | string\[] | `global_company.registered_country`, `global_company.communication_country`, `settlement_details.bank_country`, `beneficial_owners[].country_of_incorporation` | | nationalities | string\[] | `beneficial_owners[].nationality` | | international\_org\_types | string\[] | `global_company.international_org_type` | | monthly\_avg\_transaction\_volumes | object\[] | `global_company.monthly_avg_transaction_volume`. Each entry has a `value` to send and a `label` to show. | | business\_categories | object\[] | `global_company.business_category`. Only the categories your account is approved for. Each entry has a `value` to send, a `label` to show, and `requires_hs_codes`, which is `true` for goods categories. | ```json 200 OK theme={null} { "success": true, "message": "Sub-merchant options retrieved successfully", "data": { "countries": ["Afghanistan", "Albania", "Algeria", "…", "India", "…", "Zimbabwe", "Åland Islands"], "nationalities": ["Afghan", "Albanian", "Algerian", "…", "Indian", "…", "Zimbabwean", "Åland Islander"], "international_org_types": [ "Private Limited Company", "Public Limited Company", "Limited Liability Company", "Joint Stock Company", "Free Zone Company / Entity", "Partnership / LLP", "Sole Proprietorship", "Other" ], "monthly_avg_transaction_volumes": [ { "value": "LESS_THAN_5_K", "label": "Less than $5,000" }, { "value": "BETWEEN_5_K_AND_20_K", "label": "$5,000 - $20,000" }, { "value": "BETWEEN_20_K_AND_50_K", "label": "$20,000 - $50,000" }, { "value": "BETWEEN_50_K_AND_100_K", "label": "$50,000 - $100,000" }, { "value": "BETWEEN_100_K_AND_250_K", "label": "$100,000 - $250,000" }, { "value": "BETWEEN_250_K_AND_500_K", "label": "$250,000 - $500,000" }, { "value": "ABOVE_500_K", "label": "$500,000 & above" } ], "business_categories": [ { "value": "GOODS", "label": "Goods (physical products shipped cross-border)", "requires_hs_codes": true }, { "value": "SOFTWARE_CONSULTING", "label": "Software consulting & implementation", "requires_hs_codes": false } ] } } ``` ## Supported values The lists below are the full set EximPe supports. The Get Merchant Options endpoint is the source of truth for accepted values; values are matched ignoring letter case. It is also the only place that shows which business categories you are approved for. ### Organisation types For `global_company.international_org_type`. Eight values: | Value | | - | | `Private Limited Company` | | `Public Limited Company` | | `Limited Liability Company` | | `Joint Stock Company` | | `Free Zone Company / Entity` | | `Partnership / LLP` | | `Sole Proprietorship` | | `Other` | ### Monthly volume bands For `global_company.monthly_avg_transaction_volume`. Seven values, in US dollars: | Value | Meaning | | - | - | | `LESS_THAN_5_K` | Less than \$5,000 | | `BETWEEN_5_K_AND_20_K` | $5,000 - $20,000 | | `BETWEEN_20_K_AND_50_K` | $20,000 - $50,000 | | `BETWEEN_50_K_AND_100_K` | $50,000 - $100,000 | | `BETWEEN_100_K_AND_250_K` | $100,000 - $250,000 | | `BETWEEN_250_K_AND_500_K` | $250,000 - $500,000 | | `ABOVE_500_K` | \$500,000 & above | ### Business categories For `global_company.business_category`. Send one or more slugs, comma-separated, e.g. `GOODS,SOFTWARE_CONSULTING`. > [!WARNING] > > **You can only use the categories your own account is approved for.** A sub-merchant's categories must come from the categories EximPe approved for you at onboarding. Any other slug is refused with a `400`, and so are labels and purpose codes. The `business_categories` list in the response above holds exactly your approved slugs. To add a category, contact EximPe. A goods category (**HS codes required** below) needs at least one HS code in `global_company.hs_codes`. If no goods category is selected, leave `hs_codes` out. If you select `OTHER` or `OTHER_B2B_SERVICE`, the sub-merchant takes the description you gave EximPe for your own "Other" category. There is no description field to send. | Slug | Label | Business model | HS codes required | | - | - | - | - | | `GOODS` | Goods (physical products shipped cross-border) | B2B | Yes | | `SOFTWARE_CONSULTING` | Software consulting & implementation | B2B | No | | `DATA_PROCESSING` | Database & data processing | B2B | No | | `ACCOUNTING` | Accounting, auditing & bookkeeping | B2B | No | | `ARCHITECTURAL` | Architectural services | B2B | No | | `AGRICULTURE_FORESTRY` | Agriculture & forestry services | B2B | No | | `ENVIRONMENTAL` | Environmental services | B2B | No | | `TAX_CONSULTING` | Tax consulting | B2B | No | | `MARKET_RESEARCH` | Market research & opinion polling | B2B | No | | `PUBLISHING_PRINTING` | Publishing & printing | B2B | No | | `MUSEUM_LIBRARY` | Museum, library & archival services | B2B | No | | `RECREATION_SPORTING` | Recreation & sporting activities | B2B | No | | `OTHER_B2B_SERVICE` | Other | B2B | No | | `CROSS_BORDER_PHYSICAL_GOODS_ECOMMERCE` | Cross-border physical goods (e-commerce) | B2C | Yes | | `DIGITAL_GOODS_SAAS` | Digital goods / SaaS | B2C | No | | `SUBSCRIPTIONS_RECURRING_BILLING` | Subscriptions / recurring billing | B2C | No | | `MARKETPLACES_PLATFORMS` | Marketplaces / platforms | B2C | No | | `FINANCIAL_SERVICES_WALLETS_CRYPTO` | Financial services / wallets / crypto | B2C | No | | `GAMING_GAMBLING_FANTASY_SPORTS` | Gaming / gambling / fantasy sports | B2C | No | | `ADULT_DATING` | Adult / dating | B2C | No | | `OTHER` | Other | B2C | No | | `EDUCATION_ABROAD` | Tuition & fees for studying abroad | B2C | No | | `EDUCATION_DISTANCE` | Online / distance course fees | B2C | No | | `TRAVEL_HOLIDAY` | Holiday / tourism travel | B2C | No | | `TRAVEL_BUSINESS` | Business travel | B2C | No | | `TRAVEL_MEDICAL` | Medical treatment travel | B2C | No | | `TRAVEL_PILGRIMAGE` | Pilgrimage travel | B2C | No | Not every slug is open to every account, and EximPe can withdraw a category from new selections. The endpoint only returns the categories you can select today. ### Beneficial owner types For `beneficial_owners[].type`: | Value | Meaning | | - | - | | `INDIVIDUAL` | A person. Send `first_name`, `last_name`, `email`, `nationality` and `date_of_birth`. | | `INSTITUTIONAL` | A company. Send `authorized_user_name` (the company's name), `country_of_incorporation` and `date_of_incorporation`. | ### Statuses Returned in `status`. You cannot set it. EximPe's review sets it, and so does resubmitting through [Update Merchant](https://docs.eximpe.com/api-reference/v3/merchant/update.md#resubmitting). | Value | Meaning | | - | - | | `PENDING` | Submitted and waiting for review. | | `IN_REVIEW` | EximPe is reviewing the application. | | `CHANGES_REQUESTED` | EximPe needs changes before it can approve. | | `APPROVED` | Active. You can collect for it. | | `REJECTED` | The application was declined. | ### Sections Returned in `section_reasons[].section` when EximPe asks for changes. Each value names the part of the application that needs attention: | Value | Part of the application | | - | - | | `company_details` | Company details | | `company_address` | Registered and communication addresses | | `business_details` | Business details | | `settlement_account` | Settlement bank account | | `beneficial_owners` | Beneficial owners | | `authorized_persons` | Authorised persons | | `security_assessment` | Security assessment | Every section except `authorized_persons` and `security_assessment` maps to fields you can change with [Update Merchant](https://docs.eximpe.com/api-reference/v3/merchant/update.md). Those two cannot be fixed through the API; contact EximPe to resolve them. ### Countries For `registered_country`, `communication_country`, `bank_country` and `country_of_incorporation`. 249 values. > [accordion] All supported countries > > `Afghanistan`, `Albania`, `Algeria`, `American Samoa`, `Andorra`, `Angola`, `Anguilla`, `Antarctica`, `Antigua and Barbuda`, `Argentina`, `Armenia`, `Aruba`, `Australia`, `Austria`, `Azerbaijan`, `Bahamas`, `Bahrain`, `Bangladesh`, `Barbados`, `Belarus`, `Belgium`, `Belize`, `Benin`, `Bermuda`, `Bhutan`, `Bolivia - Plurinational State of`, `Bosnia and Herzegovina`, `Botswana`, `Bouvet Island`, `Brazil`, `British Indian Ocean Territory`, `Brunei Darussalam`, `Bulgaria`, `Burkina Faso`, `Burundi`, `Cambodia`, `Cameroon`, `Canada`, `Cape Verde`, `Caribbean Netherlands`, `Cayman Islands`, `Central African Republic`, `Chad`, `Chile`, `China`, `Christmas Island`, `Cocos (Keeling) Islands`, `Colombia`, `Comoros`, `Congo`, `Congo - Democratic Republic of the`, `Cook Islands`, `Costa Rica`, `Cote d'Ivoire`, `Croatia`, `Cuba`, `Curaçao`, `Cyprus`, `Czechia`, `Denmark`, `Djibouti`, `Dominica`, `Dominican Republic`, `Ecuador`, `Egypt`, `El Salvador`, `Equatorial Guinea`, `Eritrea`, `Estonia`, `Eswatini`, `Ethiopia`, `Falkland Islands (Malvinas)`, `Faroe Islands`, `Fiji`, `Finland`, `France`, `French Guiana`, `French Polynesia`, `French Southern Territories`, `Gabon`, `Gambia`, `Georgia`, `Germany`, `Ghana`, `Gibraltar`, `Greece`, `Greenland`, `Grenada`, `Guadeloupe`, `Guam`, `Guatemala`, `Guernsey`, `Guinea`, `Guinea-Bissau`, `Guyana`, `Haiti`, `Heard & McDonald Islands`, `Holy See (Vatican City State)`, `Honduras`, `Hong Kong`, `Hungary`, `Iceland`, `India`, `Indonesia`, `Iran - Islamic Republic of`, `Iraq`, `Ireland`, `Isle of Man`, `Israel`, `Italy`, `Jamaica`, `Japan`, `Jersey`, `Jordan`, `Kazakhstan`, `Kenya`, `Kiribati`, `Korea - Democratic People's Republic of`, `Korea - Republic of`, `Kuwait`, `Kyrgyzstan`, `Lao People's Democratic Republic`, `Latvia`, `Lebanon`, `Lesotho`, `Liberia`, `Libya`, `Liechtenstein`, `Lithuania`, `Luxembourg`, `Macao`, `Madagascar`, `Malawi`, `Malaysia`, `Maldives`, `Mali`, `Malta`, `Marshall Islands`, `Martinique`, `Mauritania`, `Mauritius`, `Mayotte`, `Mexico`, `Micronesia - Federated States of`, `Moldova - Republic of`, `Monaco`, `Mongolia`, `Montenegro`, `Montserrat`, `Morocco`, `Mozambique`, `Myanmar`, `Namibia`, `Nauru`, `Nepal`, `Netherlands`, `New Caledonia`, `New Zealand`, `Nicaragua`, `Niger`, `Nigeria`, `Niue`, `Norfolk Island`, `North Macedonia`, `Northern Mariana Islands`, `Norway`, `Oman`, `Pakistan`, `Palau`, `Palestine - State of`, `Panama`, `Papua New Guinea`, `Paraguay`, `Peru`, `Philippines`, `Pitcairn`, `Poland`, `Portugal`, `Puerto Rico`, `Qatar`, `Romania`, `Russia`, `Rwanda`, `Réunion`, `Saint Barthélemy`, `Saint Helena - Ascension and Tristan Da Cunha`, `Saint Kitts and Nevis`, `Saint Lucia`, `Saint Martin`, `Saint Pierre and Miquelon`, `Saint Vincent and the Grenadines`, `Samoa`, `San Marino`, `Sao Tome and Principe`, `Saudi Arabia`, `Senegal`, `Serbia`, `Seychelles`, `Sierra Leone`, `Singapore`, `Sint Maarten`, `Slovakia`, `Slovenia`, `Solomon Islands`, `Somalia`, `South Africa`, `South Georgia and the South Sandwich Islands`, `South Sudan`, `Spain`, `Sri Lanka`, `Sudan`, `Suriname`, `Svalbard and Jan Mayen`, `Sweden`, `Switzerland`, `Syrian Arab Republic`, `Taiwan - Province of China`, `Tajikistan`, `Tanzania - United Republic of`, `Thailand`, `Timor-Leste`, `Togo`, `Tokelau`, `Tonga`, `Trinidad and Tobago`, `Tunisia`, `Turkey`, `Turkmenistan`, `Turks and Caicos Islands`, `Tuvalu`, `Uganda`, `Ukraine`, `United Arab Emirates`, `United Kingdom`, `United States`, `United States Minor Outlying Islands`, `Uruguay`, `Uzbekistan`, `Vanuatu`, `Venezuela - Bolivarian Republic of`, `Vietnam`, `Virgin Islands - British`, `Virgin Islands - U.S.`, `Wallis and Futuna`, `Western Sahara`, `Yemen`, `Zambia`, `Zimbabwe`, `Åland Islands` ### Nationalities For `beneficial_owners[].nationality`. 244 values. Several countries can share one nationality. Nationalities use letters only. > [accordion] All supported nationalities > > `Afghan`, `Albanian`, `Algerian`, `American`, `American Samoan`, `Andorran`, `Angolan`, `Anguillan`, `Antiguan or Barbudan`, `Argentine`, `Armenian`, `Aruban`, `Australian`, `Austrian`, `Azerbaijani`, `Bahamian`, `Bahraini`, `Bangladeshi`, `Barbadian`, `Barthélemois`, `Basotho`, `Belarusian`, `Belgian`, `Belizean`, `Beninese`, `Bermudian`, `Bhutanese`, `Bissau-Guinean`, `Bolivian`, `Bosnian or Herzegovinian`, `Brazilian`, `British`, `British Virgin Islander`, `Bruneian`, `Bulgarian`, `Burkinabé`, `Burmese`, `Burundian`, `Cambodian`, `Cameroonian`, `Canadian`, `Cape Verdean`, `Caribbean Dutch`, `Cayman Islander`, `Central African`, `Chadian`, `Chagossian`, `Chilean`, `Chinese`, `Christmas Islander`, `Cocos Islander`, `Colombian`, `Comoran`, `Congolese`, `Cook Islander`, `Costa Rican`, `Croatian`, `Cuban`, `Curaçaoan`, `Cypriot`, `Czech`, `Danish`, `Djiboutian`, `Dominican`, `Dominican (Dominica)`, `Dutch`, `Ecuadorian`, `Egyptian`, `Emirati`, `Equatorial Guinean`, `Eritrean`, `Estonian`, `Ethiopian`, `Falkland Islander`, `Faroese`, `Fijian`, `Filipino`, `Finnish`, `French`, `French Guianese`, `French Polynesian`, `Gabonese`, `Gambian`, `Georgian`, `German`, `Ghanaian`, `Gibraltarian`, `Greek`, `Greenlandic`, `Grenadian`, `Guadeloupean`, `Guamanian`, `Guatemalan`, `Guernsey`, `Guinean`, `Guyanese`, `Haitian`, `Heard Islander`, `Honduran`, `Hong Kong Chinese`, `Hungarian`, `I-Kiribati`, `Icelander`, `Indian`, `Indonesian`, `Iranian`, `Iraqi`, `Irish`, `Israeli`, `Italian`, `Ivorian`, `Jamaican`, `Japanese`, `Jersey`, `Jordanian`, `Kazakhstani`, `Kenyan`, `Kittitian or Nevisian`, `Kuwaiti`, `Kyrgyz`, `Lao`, `Latvian`, `Lebanese`, `Liberian`, `Libyan`, `Liechtensteiner`, `Lithuanian`, `Luxembourger`, `Macanese`, `Macedonian`, `Mahoran`, `Malagasy`, `Malawian`, `Malaysian`, `Maldivian`, `Malian`, `Maltese`, `Manx`, `Marshallese`, `Martiniquais`, `Mauritanian`, `Mauritian`, `Mexican`, `Micronesian`, `Moldovan`, `Mongolian`, `Montenegrin`, `Montserratian`, `Monégasque`, `Moroccan`, `Motswana`, `Mozambican`, `Namibian`, `Nauruan`, `Nepali`, `New Caledonian`, `New Zealander`, `Ni-Vanuatu`, `Nicaraguan`, `Nigerian`, `Nigerien`, `Niuean`, `Norfolk Islander`, `North Korean`, `Northern Marianan`, `Norwegian`, `Omani`, `Pakistani`, `Palauan`, `Palestinian`, `Panamanian`, `Papua New Guinean`, `Paraguayan`, `Peruvian`, `Pitcairn Islander`, `Polish`, `Portuguese`, `Puerto Rican`, `Qatari`, `Romanian`, `Russian`, `Rwandan`, `Réunionese`, `Sahrawi`, `Saint Helenian`, `Saint Lucian`, `Saint Vincentian`, `Saint-Martinois`, `Saint-Pierrais`, `Salvadoran`, `Sammarinese`, `Samoan`, `Saudi`, `Senegalese`, `Serbian`, `Seychellois`, `Sierra Leonean`, `Singaporean`, `Sint Maartener`, `Slovak`, `Slovenian`, `Solomon Islander`, `Somali`, `South African`, `South Georgian`, `South Korean`, `South Sudanese`, `Spanish`, `Sri Lankan`, `Sudanese`, `Surinamese`, `Svalbardian`, `Swazi`, `Swedish`, `Swiss`, `Syrian`, `São Toméan`, `Taiwanese`, `Tajikistani`, `Tanzanian`, `Thai`, `Timorese`, `Togolese`, `Tokelauan`, `Tongan`, `Trinidadian or Tobagonian`, `Tunisian`, `Turkish`, `Turkmen`, `Turks and Caicos Islander`, `Tuvaluan`, `U.S. Virgin Islander`, `Ugandan`, `Ukrainian`, `Uruguayan`, `Uzbek`, `Vatican`, `Venezuelan`, `Vietnamese`, `Wallisian and Futunan`, `Yemeni`, `Zambian`, `Zimbabwean`, `Åland Islander` ## Errors | Status | `error.code` | When | `details` | | - | - | - | - | | `401` | `ERR_AUTH_000`, `ERR_AUTH_001` | `X-Client-ID` or `X-Client-Secret` is missing or wrong | `{"authentication": "Missing credentials."}` or `{"authentication": "Invalid credentials."}` | | `403` | `ERR_AUTH_003` | Your account is not a PSP | `{}`. Only PSPs can manage sub-merchants | | `403` | `ERR_MERCHANT_017` | Your account is a PSP, but not set up for import collections | `{}`. Contact EximPe | ## OpenAPI ````yaml openapi/v3-partner-merchants.json GET /partners/merchants/options/ openapi: 3.0.0 info: title: EximPe Payment Gateway API — v3 Partner Merchants version: 3.0.0 description: Create and manage sub-merchants on the v3 partner API. servers: - url: https://api-pacb-uat.eximpe.com description: Payment Gateway Sandbox URL security: - clientAuth: [] clientSecretAuth: [] apiVersionHeader: [] tags: - name: Merchants paths: /partners/merchants/options/: get: tags: - Merchants summary: Get Merchant Options description: >- The values every dropdown field on a sub-merchant accepts, including the business categories you are approved for. operationId: v3_getMerchantOptions responses: '200': description: Supported values. content: application/json: schema: $ref: '#/components/schemas/v3_MerchantOptionsResponse' example: success: true message: Sub-merchant options retrieved successfully data: countries: - Afghanistan - Albania - India - United States nationalities: - Afghan - Albanian - Indian - American international_org_types: - Private Limited Company - Public Limited Company - Limited Liability Company - Joint Stock Company - Free Zone Company / Entity - Partnership / LLP - Sole Proprietorship - Other monthly_avg_transaction_volumes: - value: LESS_THAN_5_K label: Less than $5,000 - value: ABOVE_500_K label: $500,000 & above business_categories: - value: GOODS label: Goods (physical products shipped cross-border) requires_hs_codes: true - value: SOFTWARE_CONSULTING label: Software consulting & implementation requires_hs_codes: false '401': description: Missing or invalid credentials. content: application/json: schema: $ref: '#/components/schemas/v3_ErrorResponse' example: success: false error: code: ERR_AUTH_000 message: Missing credentials details: authentication: Missing credentials. '403': description: >- Your account is not a PSP (`ERR_AUTH_003`), or is a PSP not set up for import collections (`ERR_MERCHANT_017`). content: application/json: schema: $ref: '#/components/schemas/v3_ErrorResponse' example: success: false error: code: ERR_MERCHANT_017 message: >- Sub-Merchant endpoints are only available to IMPORT PSP accounts details: {} security: - clientAuth: [] clientSecretAuth: [] apiVersionHeader: [] components: schemas: v3_MerchantOptionsResponse: type: object required: - success - message - data properties: success: type: boolean message: type: string data: type: object properties: countries: type: array items: type: string description: For every country field. nationalities: type: array items: type: string description: For `beneficial_owners[].nationality`. international_org_types: type: array items: type: string monthly_avg_transaction_volumes: type: array items: type: object properties: value: type: string label: type: string business_categories: type: array items: $ref: '#/components/schemas/v3_BusinessCategory' description: Only the categories your account is approved for. v3_ErrorResponse: type: object required: - success - error properties: success: type: boolean enum: - false description: >- Indicates if the request was successful. Always false for error responses. error: $ref: '#/components/schemas/v3_ErrorDetails' v3_BusinessCategory: type: object properties: value: type: string description: Send this in `business_category`. label: type: string description: Display name. requires_hs_codes: type: boolean description: '`true` for goods categories, which need at least one HS code.' v3_ErrorDetails: type: object required: - code - message properties: code: type: string description: Error code (e.g., ERR_ORDER_002) message: type: string description: Error message details: description: >- More about the error. An object keyed by field name when fields fail validation, with nested objects for nested fields; a string when the error is about the request as a whole; or an empty object when there is nothing to add. oneOf: - type: object additionalProperties: true - type: string securitySchemes: clientAuth: type: apiKey name: X-Client-ID in: header description: >- **Client Application ID** - Your unique application identifier used to authenticate API requests. You can find your Client ID in the Developer Settings section of the merchant dashboard. x-displayName: Client ID x-example: your-client-id clientSecretAuth: type: apiKey name: X-Client-Secret in: header description: >- **Client Secret Key** - Your secret key used alongside the Client ID for secure authentication. Keep this confidential and never expose it in client-side code. Available in the Developer Settings section of the merchant dashboard. x-displayName: Client Secret x-example: your-client-secret apiVersionHeader: type: apiKey name: X-API-Version in: header description: >- **API Version** - Specifies which version of the API to use (e.g., '1.X.X', '2.X.X', or '3.X.X'). This header allows you to control which API version your integration uses. Default version information is available in the Developer Settings. x-displayName: API Version x-example: 3.0.0 ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.