> For the complete documentation index, see [llms.txt](https://tech.x2bee.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://tech.x2bee.com/api/api-en/back-office-api-reference/payment-bo-api/merchant-management.md).
# Merchant Management
## Register Merchant
> \## Function Description\
> \* API that registers a merchant.\
> \---\
> \## Detailed Description\
> \* API called when the Save button is clicked on the \[BO] Order/Payment > Payment Method Management > Merchant Management > Register button > Merchant Registration popup page.\
> \---\
> \## Revision History\
> \* Release v2.00\_240425: Added site number to merchant information\
> \* Release v2.00\_260421: Added logic to update member auto-payment info when registering merchant information, in line with multi-site PG support
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"OpMersInfo":{"type":"object","description":"Merchant Info Entity","properties":{"mersNo":{"type":"string","description":"Merchant Number"},"pgGbCd":{"type":"string","description":"PG Type Code (OM030) 10: INICIS"},"mersEtcGbCd":{"type":"string","description":"Merchant Other Classification Code (OM052) 99: Not Applicable"},"sysGbCd":{"type":"string","description":"System Classification Code (OM051) 10: PC, 20: Mobile Web, 30: APP, 99: All"},"pointUseYn":{"type":"string","description":"Point Usage Status"},"nintUseYn":{"type":"string","description":"Interest-Free Installment Status"},"termlId":{"type":"string","description":"Terminal ID"},"useYn":{"type":"string","description":"Usage Status"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/payment/franchiseeMgmt/registerFranchisee":{"post":{"tags":["Merchant Management"],"summary":"Register Merchant","description":"## Function Description\n* API that registers a merchant.\n---\n## Detailed Description\n* API called when the Save button is clicked on the [BO] Order/Payment > Payment Method Management > Merchant Management > Register button > Merchant Registration popup page.\n---\n## Revision History\n* Release v2.00_240425: Added site number to merchant information\n* Release v2.00_260421: Added logic to update member auto-payment info when registering merchant information, in line with multi-site PG support\n","operationId":"registerFranchisee","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpMersInfo"}}},"required":true},"responses":{"200":{"description":"Merchant Registered Successfully","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Edit Merchant
> \## Function Description\
> \* API that modifies a registered merchant.\
> \---\
> \## Detailed Description\
> \* API called when the Save button is clicked on the \[BO] Order/Payment > Payment Method Management > Merchant Management > click merchant number > Merchant Modification popup page.\
> \---\
> \## Revision History\
> \* Release v2.00\_240425: Added site number to merchant information\
> \* Release v2.00\_260421: Added logic to update member auto-payment info when modifying merchant information, in line with multi-site PG support
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"OpMersInfo":{"type":"object","description":"Merchant Info Entity","properties":{"mersNo":{"type":"string","description":"Merchant Number"},"pgGbCd":{"type":"string","description":"PG Type Code (OM030) 10: INICIS"},"mersEtcGbCd":{"type":"string","description":"Merchant Other Classification Code (OM052) 99: Not Applicable"},"sysGbCd":{"type":"string","description":"System Classification Code (OM051) 10: PC, 20: Mobile Web, 30: APP, 99: All"},"pointUseYn":{"type":"string","description":"Point Usage Status"},"nintUseYn":{"type":"string","description":"Interest-Free Installment Status"},"termlId":{"type":"string","description":"Terminal ID"},"useYn":{"type":"string","description":"Usage Status"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/payment/franchiseeMgmt/modifyFranchisee":{"post":{"tags":["Merchant Management"],"summary":"Edit Merchant","description":"## Function Description\n* API that modifies a registered merchant.\n---\n## Detailed Description\n* API called when the Save button is clicked on the [BO] Order/Payment > Payment Method Management > Merchant Management > click merchant number > Merchant Modification popup page.\n---\n## Revision History\n* Release v2.00_240425: Added site number to merchant information\n* Release v2.00_260421: Added logic to update member auto-payment info when modifying merchant information, in line with multi-site PG support\n","operationId":"modifyFranchisee","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpMersInfo"}}},"required":true},"responses":{"200":{"description":"Merchant Modified Successfully","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Check for Duplicate Merchant
> \## Function Description\
> \* API that checks for duplicate merchant registration.\
> \---\
> \## Detailed Description\
> \* API called when the Save button is clicked on the \[BO] Order/Payment > Payment Method Management > Merchant Management > Register button > Merchant Registration popup page.\
> \* Checks whether a merchant is already registered with the entered \*\*Merchant Other Type Code (OM052), System Type Code (OM051)\*\* information.\
> \## Revision History\
> \* Release v2.00\_240613: Removed PG Type Code (OM030) from the duplicate check conditions
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"FranchiseeRequest":{"type":"object","description":"Merchant Management DTO","properties":{"mersNo":{"type":"string","description":"Merchant Number"},"useYn":{"type":"string","description":"Usage Status"},"nintUseYn":{"type":"string","description":"Interest-Free Installment Status"},"pointUseYn":{"type":"string","description":"Point Usage Status"},"pgGbCd":{"type":"string","description":"PG Type Code (OM030) 10: INICIS"},"sysGbCd":{"type":"string","description":"System Classification Code (OM051) 10: PC, 20: Mobile Web, 30: APP, 99: All"},"mersEtcGbCd":{"type":"string","description":"Merchant Other Classification Code (OM052) 99: Not Applicable"},"mid":{"type":"string","description":"Terminal ID"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/payment/franchiseeMgmt/getFranchiseeRegisterCheck":{"get":{"tags":["Merchant Management"],"summary":"Check for Duplicate Merchant","description":"## Function Description\n* API that checks for duplicate merchant registration.\n---\n## Detailed Description\n* API called when the Save button is clicked on the [BO] Order/Payment > Payment Method Management > Merchant Management > Register button > Merchant Registration popup page.\n* Checks whether a merchant is already registered with the entered **Merchant Other Type Code (OM052), System Type Code (OM051)** information.\n## Revision History\n* Release v2.00_240613: Removed PG Type Code (OM030) from the duplicate check conditions\n","operationId":"getMersNoCheck","parameters":[{"name":"franchiseeRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/FranchiseeRequest"}},{"name":"pgGbCd","in":"query","description":"PG Classification Code","required":true,"schema":{"type":"String"}},{"name":"mersEtcGbCd","in":"query","description":"Merchant Other Type Code","required":true,"schema":{"type":"String"}},{"name":"sysGbCd","in":"query","description":"System Classification Code","required":true,"schema":{"type":"String"}},{"name":"mersNo","in":"query","description":"Merchant Number","schema":{"type":"String"}}],"responses":{"200":{"description":"Duplicate Merchant Check Successful","content":{"*/*":{"schema":{"type":"boolean"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Search Merchant List
> \## Function Description\
> \* API that retrieves the merchant list and detail info.\
> \---\
> \## Detailed Description\
> \* API called when the Search button is clicked after entering search conditions on the \[BO] Order/Payment > Payment Method Management > Merchant Management page.\
> \* \*\*Merchant No., Usage Status, Interest-Free Usage Status, Point Usage Status\*\* are optional search conditions.\
> \
> \## Revision History\
> \* Release v2.00\_240425: Added site search condition and result columns
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"FranchiseeRequest":{"type":"object","description":"Merchant Management DTO","properties":{"mersNo":{"type":"string","description":"Merchant Number"},"useYn":{"type":"string","description":"Usage Status"},"nintUseYn":{"type":"string","description":"Interest-Free Installment Status"},"pointUseYn":{"type":"string","description":"Point Usage Status"},"pgGbCd":{"type":"string","description":"PG Type Code (OM030) 10: INICIS"},"sysGbCd":{"type":"string","description":"System Classification Code (OM051) 10: PC, 20: Mobile Web, 30: APP, 99: All"},"mersEtcGbCd":{"type":"string","description":"Merchant Other Classification Code (OM052) 99: Not Applicable"},"mid":{"type":"string","description":"Terminal ID"}}},"RealGridListResponseFranchiseeResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/FranchiseeResponse"}}}},"FranchiseeResponse":{"type":"object","properties":{"sysModDtm":{"type":"string","format":"date-time","description":"System Modification Date/Time"},"mersNo":{"type":"string","description":"Merchant Number"},"pgGbCd":{"type":"string","description":"PG Classification Code (OM030)"},"pgGbCdNm":{"type":"string","description":"PG Type Code Name"},"sysGbCd":{"type":"string","description":"System Type Code (OM051)"},"sysGbCdNm":{"type":"string","description":"System Type Code Name"},"mersEtcGbCd":{"type":"string","description":"Merchant Other Type Code (OM052)"},"mersEtcGbCdNm":{"type":"string","description":"Merchant Additional Classification Code Name"},"nintUseYn":{"type":"string","description":"Interest-Free Installment Usage Status"},"pointUseYn":{"type":"string","description":"Point Usage Status"},"termlId":{"type":"string","description":"Terminal ID"},"useYn":{"type":"string","description":"Usage Status"},"siteNm":{"type":"string","description":"Site Name"},"mid":{"type":"string","description":"Terminal ID"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/payment/franchiseeMgmt/getFranchiseeList":{"get":{"tags":["Merchant Management"],"summary":"Search Merchant List","description":"## Function Description\n* API that retrieves the merchant list and detail info.\n---\n## Detailed Description\n* API called when the Search button is clicked after entering search conditions on the [BO] Order/Payment > Payment Method Management > Merchant Management page.\n* **Merchant No., Usage Status, Interest-Free Usage Status, Point Usage Status** are optional search conditions.\n\n## Revision History\n* Release v2.00_240425: Added site search condition and result columns\n","operationId":"getFranchiseeList","parameters":[{"name":"franchiseeRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/FranchiseeRequest"}},{"name":"siteNo","in":"query","description":"Site No.","schema":{"type":"String"}},{"name":"mersNo","in":"query","description":"Merchant Number","schema":{"type":"String"}},{"name":"useYn","in":"query","description":"Usage Status","schema":{"type":"String"}},{"name":"nintUseYn","in":"query","description":"Interest-Free Installment Status","schema":{"type":"String"}},{"name":"pointUseYn","in":"query","description":"Point Usage Status","schema":{"type":"String"}}],"responses":{"200":{"description":"Merchant Retrieved Successfully","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseFranchiseeResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Retrieve Merchant Information
> \## Function Description\
> \* API that retrieves merchant information.\
> \---\
> \## Detailed Description\
> \* API called when the merchant number is clicked on the \[BO] Order/Payment > Payment Method Management > Merchant Management page.\
> \* Retrieves the merchant information stored under the corresponding merchant number.\
> \---\
> \## Revision History\
> \* Release v2.00\_240425: Added site to the merchant information result
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"FranchiseeRequest":{"type":"object","description":"Merchant Management DTO","properties":{"mersNo":{"type":"string","description":"Merchant Number"},"useYn":{"type":"string","description":"Usage Status"},"nintUseYn":{"type":"string","description":"Interest-Free Installment Status"},"pointUseYn":{"type":"string","description":"Point Usage Status"},"pgGbCd":{"type":"string","description":"PG Type Code (OM030) 10: INICIS"},"sysGbCd":{"type":"string","description":"System Classification Code (OM051) 10: PC, 20: Mobile Web, 30: APP, 99: All"},"mersEtcGbCd":{"type":"string","description":"Merchant Other Classification Code (OM052) 99: Not Applicable"},"mid":{"type":"string","description":"Terminal ID"}}},"FranchiseeResponse":{"type":"object","properties":{"sysModDtm":{"type":"string","format":"date-time","description":"System Modification Date/Time"},"mersNo":{"type":"string","description":"Merchant Number"},"pgGbCd":{"type":"string","description":"PG Classification Code (OM030)"},"pgGbCdNm":{"type":"string","description":"PG Type Code Name"},"sysGbCd":{"type":"string","description":"System Type Code (OM051)"},"sysGbCdNm":{"type":"string","description":"System Type Code Name"},"mersEtcGbCd":{"type":"string","description":"Merchant Other Type Code (OM052)"},"mersEtcGbCdNm":{"type":"string","description":"Merchant Additional Classification Code Name"},"nintUseYn":{"type":"string","description":"Interest-Free Installment Usage Status"},"pointUseYn":{"type":"string","description":"Point Usage Status"},"termlId":{"type":"string","description":"Terminal ID"},"useYn":{"type":"string","description":"Usage Status"},"siteNm":{"type":"string","description":"Site Name"},"mid":{"type":"string","description":"Terminal ID"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/payment/franchiseeMgmt/getFranchiseeInfo":{"get":{"tags":["Merchant Management"],"summary":"Retrieve Merchant Information","description":"## Function Description\n* API that retrieves merchant information.\n---\n## Detailed Description\n* API called when the merchant number is clicked on the [BO] Order/Payment > Payment Method Management > Merchant Management page.\n* Retrieves the merchant information stored under the corresponding merchant number.\n---\n## Revision History\n* Release v2.00_240425: Added site to the merchant information result\n","operationId":"getFranchiseeInfo","parameters":[{"name":"franchiseeRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/FranchiseeRequest"}},{"name":"mersNo","in":"query","description":"Merchant Number","required":true,"schema":{"type":"String"}}],"responses":{"200":{"description":"Search Merchant Info Successful","content":{"*/*":{"schema":{"$ref":"#/components/schemas/FranchiseeResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```