Tool: create_merchant
Creates a new merchant with the authenticated account. You MUST ask the user to provide the required information for merchant creation. Do not call this tool until you have attempted to collect the required information for merchant creation. After the merchant is created, you MUST present the Business Console Terms of Service URL to the user and instruct them to accept it before they can perform any operations on this merchant.
The following sample demonstrate how to use curl to invoke the create_merchant MCP tool.
| Curl Request |
|---|
curl --location 'https://paydeveloper.googleapis.com/mcp' \ --header 'content-type: application/json' \ --header 'accept: application/json, text/event-stream' \ --data '{ "method": "tools/call", "params": { "name": "create_merchant", "arguments": { // provide these details according to the tool's MCP specification } }, "jsonrpc": "2.0", "id": 1 }' |
Input Schema
Request message for CreateMerchant.
CreateMerchantRequest
| JSON representation |
|---|
{
"merchant": {
object ( |
| Fields | |
|---|---|
merchant |
Required. The basic information of the merchant to create. |
Merchant
| JSON representation |
|---|
{ "merchantId": string, "displayName": string, "regionCode": string, "mcc": enum ( |
| Fields | |
|---|---|
merchantId |
Output only. The unique identifier of the merchant. |
displayName |
Required. The display name of the merchant. |
regionCode |
Required. The region code of the merchant's business location. The format is the Unicode CLDR region codes, e.g., "US". India ("IN") is not supported. |
mcc |
Required. The Merchant Category Code (MCC) of the merchant. |
corporateWebsiteUrl |
Required. The corporate website of the merchant. |
customerSupportWebsiteUrl |
Required. The customer support website of the merchant. |
customerSupportEmail |
Required. The customer support email of the merchant. |
customerSupportPhone |
Required. The customer support phone number of the merchant. |
state |
Output only. The state of the merchant. |
Mcc
The Merchant Category Code (MCC) of a merchant.
| Enums | |
|---|---|
OTHERS |
Others |
MISC_FOOD_STORES |
Miscellaneous Food Stores – Convenience Stores and Specialty Markets |
MISC_APPAREL |
Miscellaneous Apparel and Accessory Shops |
ARTISTS_SUPPLY |
Artist’s Supply and Craft Shops |
AUTOMOTIVE_PARTS |
Automotive Parts, Accessories Stores |
HEALTH_AND_BEAUTY |
Health and Beauty Shop |
BOOKS_PERIODICALS |
Books, Periodicals and Newspapers |
CAMERA_STORES |
Camera and Photographic Supply Stores |
COMPUTERS_EQUIPMENT |
Computers, Computer Peripheral Equipment, Software |
COMPUTER_SOFTWARE |
Computer Software Stores |
ELECTRONICS_SALES |
Electronics Sales |
GIFT_SHOPS |
Card Shops, Gift, Novelty, and Souvenir Shops |
EATING_PLACES |
Eating Places and Restaurants |
MISC_GENERAL_MERCHANDISE |
Misc. General Merchandise |
HOME_SUPPLY |
Home Supply Warehouse Stores |
COMPUTER_NETWORK_SERVICES |
Computer Network Services |
DIGITAL_GOODS_MEDIA |
Digital Goods: Books, Movies, Music |
DIGITAL_GOODS_GAMES |
Digital Goods: Games |
DIGITAL_GOODS_APPLICATIONS |
Digital Goods: Applications (Excludes Games) |
POLITICAL_ORGANIZATIONS |
Political Organizations |
CHARITABLE_ORGANIZATIONS |
Charitable and Social Service Organizations |
DRUG_STORES |
Drug Stores and Pharmacies |
REAL_ESTATE_RENTALS |
Real Estate Agents and Managers - Rentals |
MISC_PERSONAL_SERVICES |
Miscellaneous Personal Services, Not Elsewhere Classified |
SPORTING_GOODS |
Sporting Goods Stores |
STATIONERY_OFFICE_SUPPLIES |
Stationery, Office Supplies, Printing and Writing Paper |
THEATRICAL_TICKET_AGENCIES |
Theatrical Ticket Agencies |
TIMESHARES |
Timeshares |
TOURIST_ATTRACTIONS |
Tourist Attractions and Exhibits |
HOBBY_TOY_GAME_SHOPS |
Hobby, Toy, and Game Shops |
PET_SHOPS |
Pet Shops, Pet Foods and Supplies Stores |
OTHER_LODGING |
Other Lodging–Hotels, Motels, Resorts |
TELECOMMUNICATION_SERVICES |
Telecommunication Services |
TRANSPORTATION_SERVICES |
Transportation Services |
OTHER_AIRLINES |
Other Airlines |
TRAVEL_AGENCIES |
Travel Agencies and Tour Operators |
GOVERNMENT_OWNED_LOTTERIES_US |
Government-Owned Lotteries (US Region only) |
GOVERNMENT_LICENSED_CASINOS_US |
Government Licensed On-Line Casinos (On-Line Gambling) (US Region only) |
BETTING |
Betting (including Lottery Tickets, Casino Gaming Chips, Off-track Betting and Wagers) |
GOVERNMENT_OWNED_LOTTERIES_NON_US |
Government-Owned Lotteries (Non-U.S. region) |
State
The state of a merchant.
| Enums | |
|---|---|
STATE_UNSPECIFIED |
The merchant state is unspecified. |
VERIFIED |
The merchant is verified and approved. |
IN_REVIEW |
The merchant profile edit is under review. |
REJECTED |
The merchant profile edit is rejected. |
INCOMPLETE_SIGNUP |
The merchant profile is incomplete. |
SANCTIONS_HIT |
The merchant profile hits sanctions. |
READY_FOR_REVIEW |
The merchant profile is complete and ready for review. |
DISABLED |
The merchant profile is disabled/inactive. |
Output Schema
Response message for CreateMerchant.
CreateMerchantResponse
| JSON representation |
|---|
{
"merchantId": string,
"state": enum ( |
| Fields | |
|---|---|
merchantId |
The merchant id of the created merchant. |
state |
The state of the created merchant. |
businessConsoleTosUrl |
Output only. The Business Console ToS URL. The user must accept the Business Console Terms of Service before they can perform any operations on the merchant. |
State
The state of a merchant.
| Enums | |
|---|---|
STATE_UNSPECIFIED |
The merchant state is unspecified. |
VERIFIED |
The merchant is verified and approved. |
IN_REVIEW |
The merchant profile edit is under review. |
REJECTED |
The merchant profile edit is rejected. |
INCOMPLETE_SIGNUP |
The merchant profile is incomplete. |
SANCTIONS_HIT |
The merchant profile hits sanctions. |
READY_FOR_REVIEW |
The merchant profile is complete and ready for review. |
DISABLED |
The merchant profile is disabled/inactive. |
Tool Annotations
Destructive Hint: ❌ | Idempotent Hint: ❌ | Read Only Hint: ❌ | Open World Hint: ❌