> For the complete documentation index, see [llms.txt](https://docs.optty.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.optty.com/partner-onboarding-docs/onboarding-api/onboarding/post-merchants-create.md).

# POST /merchants/create

## POST /merchants/create

> Create Merchant ---- \[auth scope:  admin, grandparent, parent]

```json
{"openapi":"3.0.0","info":{"title":"Merchant API","version":"1.0"},"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"CreateMerchantDto":{"type":"object","properties":{"redirectUrl":{"type":"string","description":"The new merchant URL"},"merchantName":{"type":"string","description":"The new merchant name"},"status":{"type":"object","description":"The new merchant status"},"isAllOptIn":{"type":"object","description":"Do you want to opt in for all payment providers as paren"},"parentId":{"type":"string","description":"The new merchant parent"},"theme":{"description":"The new merchant theme","allOf":[{"$ref":"#/components/schemas/ThemeDto"}]},"preferredDisplayMode":{"type":"string","description":"The new merchant Preferred display mode for payment"},"popupOverlayConfig":{"description":"Configuration for popup overlay content","allOf":[{"$ref":"#/components/schemas/PopupOverlayConfigDto"}]},"Country":{"type":"string","description":"The country in which you want to store data of merchant in spanner"}},"required":["redirectUrl","merchantName","status","isAllOptIn","parentId","theme","preferredDisplayMode"]},"ThemeDto":{"type":"object","properties":{"logo":{"type":"string","description":"The merchant logo"},"leftSidebarBgColor":{"type":"string","description":"The left sidebar background color"},"leftSidebarActiveColor":{"type":"string","description":"The left sidebar active color"},"leftSidebarHoverColor":{"type":"string","description":"The left sidebar hover color"},"leftSidebarTextColor":{"type":"string","description":"The left sidebar text color"},"topBarTextColor":{"type":"string","description":"The top bar text color"},"topBarBgColor":{"type":"string","description":"The top bar background color"},"paymentLinkMenuAlias":{"type":"string","description":"The alias for \"Optty Direct\" label on UPP"}},"required":["logo","leftSidebarBgColor","leftSidebarActiveColor","leftSidebarHoverColor","leftSidebarTextColor","topBarTextColor","topBarBgColor","paymentLinkMenuAlias"]},"PopupOverlayConfigDto":{"type":"object","properties":{"title":{"type":"string","description":"Title displayed in the popup overlay"},"message":{"type":"string","description":"Message displayed in the popup overlay"}},"required":["title","message"]},"CreateMerchantResponse":{"type":"object","properties":{"merchantId":{"type":"string","description":"The merchant ID"},"redirectUrl":{"type":"string","description":"The merchant redirect url"},"merchantName":{"type":"string","description":"The merchant name"},"status":{"type":"boolean","description":"The merchant status"},"parentId":{"type":"string","description":"The parent ID"},"authClientId":{"type":"string","description":"The merchant client ID"},"authClientSecret":{"type":"string","description":"The merchant client secret"},"hmacKey":{"type":"string","description":"The merchant hmac key"},"theme":{"description":"The merchant theme","allOf":[{"$ref":"#/components/schemas/ThemeDto"}]},"partnerMerchantId":{"type":"string","description":"The partner's merchant id"},"isAllOptIn":{"type":"boolean","description":"opted in status for all payment providers as parent"}},"required":["merchantId","redirectUrl","merchantName","status","parentId","authClientId","authClientSecret","hmacKey","theme","partnerMerchantId","isAllOptIn"]}}},"paths":{"/merchants/create":{"post":{"operationId":"MerchantsController_create","summary":"Create Merchant ---- [auth scope:  admin, grandparent, parent]","deprecated":false,"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateMerchantDto"}}}},"responses":{"200":{"description":"Merchant created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateMerchantResponse"}}}}},"tags":["merchants"]}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.optty.com/partner-onboarding-docs/onboarding-api/onboarding/post-merchants-create.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.