가맹점 관리

가맹점 등록

post

기능설명

• 가맹점을 등록하는 API 입니다.

---

상세설명

• [BO] 주문/결제 > 결제수단 관리 > 가맹점 관리 > 등록 버튼 > 가맹점 등록 팝업 페이지에서 저장 버튼을 클릭하면 호출되는 API 입니다.

---

수정번호

• Release v2.00_240425: 가맹점 정보 사이트 번호 추가

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

가맹점정보 Entity

mersNostringOptional

가맹점번호

Example: 1

pgGbCdstringOptional

PG구분코드(OM030) 10:이니시스

Example: 10

mersEtcGbCdstringOptional

가맹점기타구분코드(OM052) 99:해당없음

Example: 99

sysGbCdstringOptional

시스템구분코드(OM051) 10:PC, 20:모바일웹, 30:APP, 99:전체

Example: 30

pointUseYnstringOptional

포인트사용여부

Example: Y

nintUseYnstringOptional

무이자할부여부

Example: Y

termlIdstringOptional

터미널id

Example: INIpayTest

useYnstringOptional

사용여부

Example: Y

Responses

200

가맹점 등록 성공

*/*

stringOptional

900

업무처리 오류 내용

*/*

post

/v1/payment/franchiseeMgmt/registerFranchisee

HTTPcURLJavaScriptPython

POST /api/bo/v1/payment/franchiseeMgmt/registerFranchisee HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 122

{
  "mersNo": 1,
  "pgGbCd": 10,
  "mersEtcGbCd": 99,
  "sysGbCd": 30,
  "pointUseYn": "Y",
  "nintUseYn": "Y",
  "termlId": "INIpayTest",
  "useYn": "Y"
}

text

가맹점 수정

post

기능설명

• 등록된 가맹점을 수정하는 API 입니다.

---

상세설명

• [BO] 주문/결제 > 결제수단 관리 > 가맹점 관리 > 가맹점번호 클릭 > 가맹점 수정 팝업 페이지에서 저장 버튼을 클릭하면 호출되는 API 입니다.

---

수정번호

• Release v2.00_240425: 가맹점 정보 사이트 번호 추가

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

가맹점정보 Entity

mersNostringOptional

가맹점번호

Example: 1

pgGbCdstringOptional

PG구분코드(OM030) 10:이니시스

Example: 10

mersEtcGbCdstringOptional

가맹점기타구분코드(OM052) 99:해당없음

Example: 99

sysGbCdstringOptional

시스템구분코드(OM051) 10:PC, 20:모바일웹, 30:APP, 99:전체

Example: 30

pointUseYnstringOptional

포인트사용여부

Example: Y

nintUseYnstringOptional

무이자할부여부

Example: Y

termlIdstringOptional

터미널id

Example: INIpayTest

useYnstringOptional

사용여부

Example: Y

Responses

200

가맹점 수정 성공

*/*

stringOptional

900

업무처리 오류 내용

*/*

post

/v1/payment/franchiseeMgmt/modifyFranchisee

HTTPcURLJavaScriptPython

POST /api/bo/v1/payment/franchiseeMgmt/modifyFranchisee HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 122

{
  "mersNo": 1,
  "pgGbCd": 10,
  "mersEtcGbCd": 99,
  "sysGbCd": 30,
  "pointUseYn": "Y",
  "nintUseYn": "Y",
  "termlId": "INIpayTest",
  "useYn": "Y"
}

text

가맹점 중복 확인

get

기능설명

• 가맹점의 중복 등록을 확인하는 API 입니다.

---

상세설명

• [BO] 주문/결제 > 결제수단 관리 > 가맹점 관리 > 등록 버튼 > 가맹점 등록 팝업 페이지에서 저장 버튼을 클릭하면 호출되는 API 입니다.

• 입력한 가맹점기타구분코드(OM052), 시스템구분코드(OM051) 의 정보로 등록된 가맹점이 있는지 확인합니다.

수정번호

• Release v2.00_240613: 중복 조건 중 PG구분코드(OM030) 제거

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pgGbCdStringRequired

PG구분코드

mersEtcGbCdStringRequired

가맹점기타구분코드

sysGbCdStringRequired

시스템구분코드

mersNoStringOptional

가맹점번호

Responses

200

가맹점 중복 여부 확인 성공

*/*

booleanOptional

900

업무처리 오류 내용

*/*

get

/v1/payment/franchiseeMgmt/getFranchiseeRegisterCheck

HTTPcURLJavaScriptPython

GET /api/bo/v1/payment/franchiseeMgmt/getFranchiseeRegisterCheck?franchiseeRequest=[object+Object]&pgGbCd=null&mersEtcGbCd=null&sysGbCd=null HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

true

가맹점 목록 조회

get

기능설명

• 가맹점 목록 및 상세 정보를 조회하는 API 입니다.

---

상세설명

• [BO] 주문/결제 > 결제수단 관리 > 가맹점 관리 페이지에서 조회조건 입력 후 검색 버튼을 클릭하면 호출되는 API 입니다.

• 가맹점번호, 사용여부, 무이자 사용여부, 포인트 사용여부는 선택 조회 조건입니다.

수정번호

• Release v2.00_240425: 사이트 검색조건 및 결과컬럼 추가

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

siteNoStringOptional

사이트번호

mersNoStringOptional

가맹점번호

useYnStringOptional

사용여부

nintUseYnStringOptional

무이자할부여부

pointUseYnStringOptional

포인트사용여부

Responses

200

가맹점 조회 성공

*/*

totalCountinteger · int32Optional

900

업무처리 오류 내용

*/*

get

/v1/payment/franchiseeMgmt/getFranchiseeList

HTTPcURLJavaScriptPython

GET /api/bo/v1/payment/franchiseeMgmt/getFranchiseeList?franchiseeRequest=[object+Object] HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalCount": 1,
  "payloads": [
    {
      "sysModDtm": "2023-07-20 10:42:14.697547",
      "mersNo": 1,
      "pgGbCd": 10,
      "pgGbCdNm": "이니시스",
      "sysGbCd": 20,
      "sysGbCdNm": "모바일웹",
      "mersEtcGbCd": 99,
      "mersEtcGbCdNm": "해당없음",
      "nintUseYn": "Y",
      "pointUseYn": "Y",
      "termlId": "INIpayTest",
      "useYn": "Y",
      "siteNm": "플래티어",
      "mid": "toss119"
    }
  ]
}

가맹점 정보 조회

get

기능설명

• 가맹점 정보를 조회하는 API 입니다.

---

상세설명

• [BO] 주문/결제 > 결제수단 관리 > 가맹점 관리 > 가맹점번호 클릭하면 호출되는 API 입니다.

• 해당 가맹점 번호에 저장되어있는 가맹점 정보를 조회합니다.

---

수정번호

• Release v2.00_240425: 가맹점 정보 결과에 사이트 추가

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

mersNoStringRequired

가맹점번호

Responses

200

가맹점 정보 조회 성공

*/*

sysModDtmstring · date-timeOptional

시스템수정일시

Example: 2023-07-20 10:42:14.697547

mersNostringOptional

가맹점번호

Example: 1

pgGbCdstringOptional

PG구분코드(OM030)

Example: 10

pgGbCdNmstringOptional

PG구분코드명

Example: 이니시스

sysGbCdstringOptional

시스템구분코드(OM051)

Example: 20

sysGbCdNmstringOptional

시스템구분코드명

Example: 모바일웹

mersEtcGbCdstringOptional

가맹점기타구분코드(OM052)

Example: 99

mersEtcGbCdNmstringOptional

가맹점기타구분코드명

Example: 해당없음

nintUseYnstringOptional

무이자사용여부

Example: Y

pointUseYnstringOptional

포인트사용여부

Example: Y

termlIdstringOptional

터미널ID

Example: INIpayTest

useYnstringOptional

사용여부

Example: Y

siteNmstringOptional

사이트명

Example: 플래티어

midstringOptional

터미널ID

Example: toss119

900

업무처리 오류 내용

*/*

get

/v1/payment/franchiseeMgmt/getFranchiseeInfo

HTTPcURLJavaScriptPython

GET /api/bo/v1/payment/franchiseeMgmt/getFranchiseeInfo?franchiseeRequest=[object+Object]&mersNo=null HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "sysModDtm": "2023-07-20 10:42:14.697547",
  "mersNo": 1,
  "pgGbCd": 10,
  "pgGbCdNm": "이니시스",
  "sysGbCd": 20,
  "sysGbCdNm": "모바일웹",
  "mersEtcGbCd": 99,
  "mersEtcGbCdNm": "해당없음",
  "nintUseYn": "Y",
  "pointUseYn": "Y",
  "termlId": "INIpayTest",
  "useYn": "Y",
  "siteNm": "플래티어",
  "mid": "toss119"
}