Merchant Management

Register Merchant

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Merchant Info Entity

mersNostringOptional

Merchant Number

Example: 1

pgGbCdstringOptional

PG Type Code (OM030) 10: INICIS

Example: 10

mersEtcGbCdstringOptional

Merchant Other Classification Code (OM052) 99: Not Applicable

Example: 99

sysGbCdstringOptional

System Classification Code (OM051) 10: PC, 20: Mobile Web, 30: APP, 99: All

Example: 30

pointUseYnstringOptional

Point Usage Status

Example: Y

nintUseYnstringOptional

Interest-Free Installment Status

Example: Y

termlIdstringOptional

Terminal ID

Example: INIpayTest

useYnstringOptional

Usage Status

Example: Y

Responses

200

Merchant Registered Successfully

*/*

stringOptional

900

Business processing error details

*/*

post/v1/payment/franchiseeMgmt/registerFranchisee

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

Edit Merchant

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Merchant Info Entity

mersNostringOptional

Merchant Number

Example: 1

pgGbCdstringOptional

PG Type Code (OM030) 10: INICIS

Example: 10

mersEtcGbCdstringOptional

Merchant Other Classification Code (OM052) 99: Not Applicable

Example: 99

sysGbCdstringOptional

System Classification Code (OM051) 10: PC, 20: Mobile Web, 30: APP, 99: All

Example: 30

pointUseYnstringOptional

Point Usage Status

Example: Y

nintUseYnstringOptional

Interest-Free Installment Status

Example: Y

termlIdstringOptional

Terminal ID

Example: INIpayTest

useYnstringOptional

Usage Status

Example: Y

Responses

200

Merchant Modified Successfully

*/*

stringOptional

900

Business processing error details

*/*

post/v1/payment/franchiseeMgmt/modifyFranchisee

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

Check for Duplicate Merchant

get

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pgGbCdStringRequired

PG Classification Code

mersEtcGbCdStringRequired

Merchant Other Type Code

sysGbCdStringRequired

System Classification Code

mersNoStringOptional

Merchant Number

Responses

200

Duplicate Merchant Check Successful

*/*

booleanOptional

900

Business processing error details

*/*

get/v1/payment/franchiseeMgmt/getFranchiseeRegisterCheck

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

Search Merchant List

get

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

siteNoStringOptional

Site No.

mersNoStringOptional

Merchant Number

useYnStringOptional

Usage Status

nintUseYnStringOptional

Interest-Free Installment Status

pointUseYnStringOptional

Point Usage Status

Responses

200

Merchant Retrieved Successfully

*/*

totalCountinteger · int32Optional

900

Business processing error details

*/*

get/v1/payment/franchiseeMgmt/getFranchiseeList

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"
    }
  ]
}

Retrieve Merchant Information

get

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

mersNoStringRequired

Merchant Number

Responses

200

Search Merchant Info Successful

*/*

sysModDtmstring · date-timeOptional

System Modification Date/Time

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

mersNostringOptional

Merchant Number

Example: 1

pgGbCdstringOptional

PG Classification Code (OM030)

Example: 10

pgGbCdNmstringOptional

PG Type Code Name

Example: 이니시스

sysGbCdstringOptional

System Type Code (OM051)

Example: 20

sysGbCdNmstringOptional

System Type Code Name

Example: 모바일웹

mersEtcGbCdstringOptional

Merchant Other Type Code (OM052)

Example: 99

mersEtcGbCdNmstringOptional

Merchant Additional Classification Code Name

Example: 해당없음

nintUseYnstringOptional

Interest-Free Installment Usage Status

Example: Y

pointUseYnstringOptional

Point Usage Status

Example: Y

termlIdstringOptional

Terminal ID

Example: INIpayTest

useYnstringOptional

Usage Status

Example: Y

siteNmstringOptional

Site Name

Example: 플래티어

midstringOptional

Terminal ID

Example: toss119

900

Business processing error details

*/*

get/v1/payment/franchiseeMgmt/getFranchiseeInfo

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"
}

PreviousPayment History Lookup

NextAccount Verification Management

Last updated 2 months ago