> 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/back-office-api/payment-bo-api/undefined-4.md).
# 가맹점 관리
## 가맹점 등록
> \## 기능설명\
> \* 가맹점을 등록하는 API 입니다.\
> \---\
> \## 상세설명\
> \* \[BO] 주문/결제 > 결제수단 관리 > 가맹점 관리 > 등록 버튼 > 가맹점 등록 팝업 페이지에서 저장 버튼을 클릭하면 호출되는 API 입니다.\
> \---\
> \## 수정번호\
> \* Release v2.00\_240425: 가맹점 정보 사이트 번호 추가\
> \* Release v2.00\_260421: PG사 멀티사이트 적용에 따른 가맹점 정보 등록 시 회원자동결제정보 업데이트 로직 추가
```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":"가맹점정보 Entity","properties":{"mersNo":{"type":"string","description":"가맹점번호"},"pgGbCd":{"type":"string","description":"PG구분코드(OM030) 10:이니시스"},"mersEtcGbCd":{"type":"string","description":"가맹점기타구분코드(OM052) 99:해당없음"},"sysGbCd":{"type":"string","description":"시스템구분코드(OM051) 10:PC, 20:모바일웹, 30:APP, 99:전체"},"pointUseYn":{"type":"string","description":"포인트사용여부"},"nintUseYn":{"type":"string","description":"무이자할부여부"},"termlId":{"type":"string","description":"터미널id"},"useYn":{"type":"string","description":"사용여부"}}},"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":["가맹점 관리"],"summary":"가맹점 등록","description":"## 기능설명\n* 가맹점을 등록하는 API 입니다.\n---\n## 상세설명\n* [BO] 주문/결제 > 결제수단 관리 > 가맹점 관리 > 등록 버튼 > 가맹점 등록 팝업 페이지에서 저장 버튼을 클릭하면 호출되는 API 입니다.\n---\n## 수정번호\n* Release v2.00_240425: 가맹점 정보 사이트 번호 추가\n* Release v2.00_260421: PG사 멀티사이트 적용에 따른 가맹점 정보 등록 시 회원자동결제정보 업데이트 로직 추가\n","operationId":"registerFranchisee","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpMersInfo"}}},"required":true},"responses":{"200":{"description":"가맹점 등록 성공","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## 가맹점 수정
> \## 기능설명\
> \* 등록된 가맹점을 수정하는 API 입니다.\
> \---\
> \## 상세설명\
> \* \[BO] 주문/결제 > 결제수단 관리 > 가맹점 관리 > 가맹점번호 클릭 > 가맹점 수정 팝업 페이지에서 저장 버튼을 클릭하면 호출되는 API 입니다.\
> \---\
> \## 수정번호\
> \* Release v2.00\_240425: 가맹점 정보 사이트 번호 추가\
> \* Release v2.00\_260421: PG사 멀티사이트 적용에 따른 가맹점 정보 수정 시 회원자동결제정보 업데이트 로직 추가
```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":"가맹점정보 Entity","properties":{"mersNo":{"type":"string","description":"가맹점번호"},"pgGbCd":{"type":"string","description":"PG구분코드(OM030) 10:이니시스"},"mersEtcGbCd":{"type":"string","description":"가맹점기타구분코드(OM052) 99:해당없음"},"sysGbCd":{"type":"string","description":"시스템구분코드(OM051) 10:PC, 20:모바일웹, 30:APP, 99:전체"},"pointUseYn":{"type":"string","description":"포인트사용여부"},"nintUseYn":{"type":"string","description":"무이자할부여부"},"termlId":{"type":"string","description":"터미널id"},"useYn":{"type":"string","description":"사용여부"}}},"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":["가맹점 관리"],"summary":"가맹점 수정","description":"## 기능설명\n* 등록된 가맹점을 수정하는 API 입니다.\n---\n## 상세설명\n* [BO] 주문/결제 > 결제수단 관리 > 가맹점 관리 > 가맹점번호 클릭 > 가맹점 수정 팝업 페이지에서 저장 버튼을 클릭하면 호출되는 API 입니다.\n---\n## 수정번호\n* Release v2.00_240425: 가맹점 정보 사이트 번호 추가\n* Release v2.00_260421: PG사 멀티사이트 적용에 따른 가맹점 정보 수정 시 회원자동결제정보 업데이트 로직 추가\n","operationId":"modifyFranchisee","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpMersInfo"}}},"required":true},"responses":{"200":{"description":"가맹점 수정 성공","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## 가맹점 중복 확인
> \## 기능설명\
> \* 가맹점의 중복 등록을 확인하는 API 입니다.\
> \---\
> \## 상세설명\
> \* \[BO] 주문/결제 > 결제수단 관리 > 가맹점 관리 > 등록 버튼 > 가맹점 등록 팝업 페이지에서 저장 버튼을 클릭하면 호출되는 API 입니다.\
> \* 입력한 \*\*가맹점기타구분코드(OM052), 시스템구분코드(OM051)\*\* 의 정보로 등록된 가맹점이 있는지 확인합니다.\
> \## 수정번호\
> \* Release v2.00\_240613: 중복 조건 중 PG구분코드(OM030) 제거
```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":"가맹점 관리 DTO","properties":{"mersNo":{"type":"string","description":"가맹점번호"},"useYn":{"type":"string","description":"사용여부"},"nintUseYn":{"type":"string","description":"무이자할부여부"},"pointUseYn":{"type":"string","description":"포인트사용여부"},"pgGbCd":{"type":"string","description":"PG구분코드(OM030) 10:이니시스"},"sysGbCd":{"type":"string","description":"시스템구분코드(OM051) 10:PC, 20:모바일웹, 30:APP, 99:전체"},"mersEtcGbCd":{"type":"string","description":"가맹점기타구분코드(OM052) 99:해당없음"},"mid":{"type":"string","description":"터미널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":["가맹점 관리"],"summary":"가맹점 중복 확인","description":"## 기능설명\n* 가맹점의 중복 등록을 확인하는 API 입니다.\n---\n## 상세설명\n* [BO] 주문/결제 > 결제수단 관리 > 가맹점 관리 > 등록 버튼 > 가맹점 등록 팝업 페이지에서 저장 버튼을 클릭하면 호출되는 API 입니다.\n* 입력한 **가맹점기타구분코드(OM052), 시스템구분코드(OM051)** 의 정보로 등록된 가맹점이 있는지 확인합니다.\n## 수정번호\n* Release v2.00_240613: 중복 조건 중 PG구분코드(OM030) 제거\n","operationId":"getMersNoCheck","parameters":[{"name":"franchiseeRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/FranchiseeRequest"}},{"name":"pgGbCd","in":"query","description":"PG구분코드","required":true,"schema":{"type":"String"}},{"name":"mersEtcGbCd","in":"query","description":"가맹점기타구분코드","required":true,"schema":{"type":"String"}},{"name":"sysGbCd","in":"query","description":"시스템구분코드","required":true,"schema":{"type":"String"}},{"name":"mersNo","in":"query","description":"가맹점번호","schema":{"type":"String"}}],"responses":{"200":{"description":"가맹점 중복 여부 확인 성공","content":{"*/*":{"schema":{"type":"boolean"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## 가맹점 목록 조회
> \## 기능설명\
> \* 가맹점 목록 및 상세 정보를 조회하는 API 입니다.\
> \---\
> \## 상세설명\
> \* \[BO] 주문/결제 > 결제수단 관리 > 가맹점 관리 페이지에서 조회조건 입력 후 검색 버튼을 클릭하면 호출되는 API 입니다.\
> \* \*\*가맹점번호, 사용여부, 무이자 사용여부, 포인트 사용여부\*\*는 선택 조회 조건입니다.\
> \
> \## 수정번호\
> \* Release v2.00\_240425: 사이트 검색조건 및 결과컬럼 추가
```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":"가맹점 관리 DTO","properties":{"mersNo":{"type":"string","description":"가맹점번호"},"useYn":{"type":"string","description":"사용여부"},"nintUseYn":{"type":"string","description":"무이자할부여부"},"pointUseYn":{"type":"string","description":"포인트사용여부"},"pgGbCd":{"type":"string","description":"PG구분코드(OM030) 10:이니시스"},"sysGbCd":{"type":"string","description":"시스템구분코드(OM051) 10:PC, 20:모바일웹, 30:APP, 99:전체"},"mersEtcGbCd":{"type":"string","description":"가맹점기타구분코드(OM052) 99:해당없음"},"mid":{"type":"string","description":"터미널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":"시스템수정일시"},"mersNo":{"type":"string","description":"가맹점번호"},"pgGbCd":{"type":"string","description":"PG구분코드(OM030)"},"pgGbCdNm":{"type":"string","description":"PG구분코드명"},"sysGbCd":{"type":"string","description":"시스템구분코드(OM051)"},"sysGbCdNm":{"type":"string","description":"시스템구분코드명"},"mersEtcGbCd":{"type":"string","description":"가맹점기타구분코드(OM052)"},"mersEtcGbCdNm":{"type":"string","description":"가맹점기타구분코드명"},"nintUseYn":{"type":"string","description":"무이자사용여부"},"pointUseYn":{"type":"string","description":"포인트사용여부"},"termlId":{"type":"string","description":"터미널ID"},"useYn":{"type":"string","description":"사용여부"},"siteNm":{"type":"string","description":"사이트명"},"mid":{"type":"string","description":"터미널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":["가맹점 관리"],"summary":"가맹점 목록 조회","description":"## 기능설명\n* 가맹점 목록 및 상세 정보를 조회하는 API 입니다.\n---\n## 상세설명\n* [BO] 주문/결제 > 결제수단 관리 > 가맹점 관리 페이지에서 조회조건 입력 후 검색 버튼을 클릭하면 호출되는 API 입니다.\n* **가맹점번호, 사용여부, 무이자 사용여부, 포인트 사용여부**는 선택 조회 조건입니다.\n\n## 수정번호\n* Release v2.00_240425: 사이트 검색조건 및 결과컬럼 추가\n","operationId":"getFranchiseeList","parameters":[{"name":"franchiseeRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/FranchiseeRequest"}},{"name":"siteNo","in":"query","description":"사이트번호","schema":{"type":"String"}},{"name":"mersNo","in":"query","description":"가맹점번호","schema":{"type":"String"}},{"name":"useYn","in":"query","description":"사용여부","schema":{"type":"String"}},{"name":"nintUseYn","in":"query","description":"무이자할부여부","schema":{"type":"String"}},{"name":"pointUseYn","in":"query","description":"포인트사용여부","schema":{"type":"String"}}],"responses":{"200":{"description":"가맹점 조회 성공","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseFranchiseeResponse"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## 가맹점 정보 조회
> \## 기능설명\
> \* 가맹점 정보를 조회하는 API 입니다.\
> \---\
> \## 상세설명\
> \* \[BO] 주문/결제 > 결제수단 관리 > 가맹점 관리 > 가맹점번호 클릭하면 호출되는 API 입니다.\
> \* 해당 가맹점 번호에 저장되어있는 가맹점 정보를 조회합니다.\
> \---\
> \## 수정번호\
> \* Release v2.00\_240425: 가맹점 정보 결과에 사이트 추가
```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":"가맹점 관리 DTO","properties":{"mersNo":{"type":"string","description":"가맹점번호"},"useYn":{"type":"string","description":"사용여부"},"nintUseYn":{"type":"string","description":"무이자할부여부"},"pointUseYn":{"type":"string","description":"포인트사용여부"},"pgGbCd":{"type":"string","description":"PG구분코드(OM030) 10:이니시스"},"sysGbCd":{"type":"string","description":"시스템구분코드(OM051) 10:PC, 20:모바일웹, 30:APP, 99:전체"},"mersEtcGbCd":{"type":"string","description":"가맹점기타구분코드(OM052) 99:해당없음"},"mid":{"type":"string","description":"터미널ID"}}},"FranchiseeResponse":{"type":"object","properties":{"sysModDtm":{"type":"string","format":"date-time","description":"시스템수정일시"},"mersNo":{"type":"string","description":"가맹점번호"},"pgGbCd":{"type":"string","description":"PG구분코드(OM030)"},"pgGbCdNm":{"type":"string","description":"PG구분코드명"},"sysGbCd":{"type":"string","description":"시스템구분코드(OM051)"},"sysGbCdNm":{"type":"string","description":"시스템구분코드명"},"mersEtcGbCd":{"type":"string","description":"가맹점기타구분코드(OM052)"},"mersEtcGbCdNm":{"type":"string","description":"가맹점기타구분코드명"},"nintUseYn":{"type":"string","description":"무이자사용여부"},"pointUseYn":{"type":"string","description":"포인트사용여부"},"termlId":{"type":"string","description":"터미널ID"},"useYn":{"type":"string","description":"사용여부"},"siteNm":{"type":"string","description":"사이트명"},"mid":{"type":"string","description":"터미널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":["가맹점 관리"],"summary":"가맹점 정보 조회","description":"## 기능설명\n* 가맹점 정보를 조회하는 API 입니다.\n---\n## 상세설명\n* [BO] 주문/결제 > 결제수단 관리 > 가맹점 관리 > 가맹점번호 클릭하면 호출되는 API 입니다.\n* 해당 가맹점 번호에 저장되어있는 가맹점 정보를 조회합니다.\n---\n## 수정번호\n* Release v2.00_240425: 가맹점 정보 결과에 사이트 추가\n","operationId":"getFranchiseeInfo","parameters":[{"name":"franchiseeRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/FranchiseeRequest"}},{"name":"mersNo","in":"query","description":"가맹점번호","required":true,"schema":{"type":"String"}}],"responses":{"200":{"description":"가맹점 정보 조회 성공","content":{"*/*":{"schema":{"$ref":"#/components/schemas/FranchiseeResponse"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
---
# 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://tech.x2bee.com/api/back-office-api/payment-bo-api/undefined-4.md?ask=&goal=
```
`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.