Payment Method Management

Modify PG Company List

post

Function Description

Function to modify PG company information.

Detailed Description

Called when the PG company list is modified and the Save button is clicked on the [BO] Order/Payment > Payment Method Management > Payment Method Management page.
Can modify the connection status of the payment method registered in the common code (PG Type Code).

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Bodyobject · StStdCd[]

Group Code Search/Register/Modify Request

grpCdstringOptional

Group Code

Example: ME001

cdstringOptional

Code

Example: 11

cdNmstringOptional

Code Name

Example: 상품즉시할인

cdDescstringOptional

Code Description

Example: 다국어 코드설명

useYnstringOptional

Usage Status

Example: Y

sortSeqinteger · int32Optional

Sort Order

Example: 1

ref1ValstringOptional

Reference Value 1 Description

Example: 기준코드 참조1값에 대한 설명

ref2ValstringOptional

Reference Value 2 Description

Example: 기준코드 참조2값에 대한 설명

ref3ValstringOptional

Reference Value 3 Description

Example: 기준코드 참조3값에 대한 설명

ref4ValstringOptional

Reference Value 4 Description

Example: 기준코드 참조4값에 대한 설명

ref5ValstringOptional

Reference Value 5 Description

Example: 기준코드 참조5값에 대한 설명

ref6ValstringOptional

Reference Value 6 Description

Example: 기준코드 참조6값에 대한 설명

ref7ValstringOptional

Reference Value 7 Description

Example: 기준코드 참조7값에 대한 설명

Responses

200

PG Company List Modified Successfully

*/*

stringOptional

900

Business processing error details

*/*

post/v1/payment/paymentMethodMgmt/savePgList

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

[
  {
    "grpCd": "ME001",
    "cd": 11,
    "cdNm": "상품즉시할인",
    "cdDesc": "다국어 코드설명",
    "useYn": "Y",
    "sortSeq": 1,
    "ref1Val": "기준코드 참조1값에 대한 설명",
    "ref2Val": "기준코드 참조2값에 대한 설명",
    "ref3Val": "기준코드 참조3값에 대한 설명",
    "ref4Val": "기준코드 참조4값에 대한 설명",
    "ref5Val": "기준코드 참조5값에 대한 설명",
    "ref6Val": "기준코드 참조6값에 대한 설명",
    "ref7Val": "기준코드 참조7값에 대한 설명"
  }
]

text

Register/Modify Payment Method by PG Company

post

Function Description

Function to register a new payment method by PG company or modify an existing registered payment method.

Detailed Description

Called when a new payment method is registered or an existing one is modified in the payment method list and the Save button is clicked on the [BO] Order/Payment > Payment Method Management > Payment Method Management page.
Can register a new payment method by PG company or modify the connection status of an existing registered payment method.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Payment Method Management DTO

Responses

200

Payment Method by PG Company Registered/Modified Successfully

*/*

stringOptional

900

Business processing error details

*/*

post/v1/payment/paymentMethodMgmt/savePaymentMethodList

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

{
  "createList": [
    {
      "pgGbCd": 10,
      "payWayCd": 11,
      "linkYn": "Y"
    }
  ],
  "updateList": [
    {
      "pgGbCd": 10,
      "payWayCd": 11,
      "linkYn": "Y"
    }
  ]
}

text

Search PG Company List

get

Function Description

Retrieves the list of PG companies registered in the common codes.

Detailed Description

Called when the PG company list is retrieved on the [BO] Order/Payment > Payment Method Management > Payment Method Management page.
Retrieves the PG Type Code, PG Company Name, and Usage Status registered in the common code PG Type Code (OM030).

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

paginationanyRequired

Responses

200

PG Company List Retrieved Successfully

*/*

totalCountinteger · int32Optional

900

Business processing error details

*/*

get/v1/payment/paymentMethodMgmt/getPgList

GET /api/bo/v1/payment/paymentMethodMgmt/getPgList?pagination=null HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalCount": 1,
  "payloads": [
    {
      "cd": 10,
      "cdNm": "이니시스",
      "useYn": "Y",
      "pgGbCd": 10,
      "pgGbCdNm": "이니시스",
      "payWayCd": 11,
      "payWayCdNm": "신용카드",
      "linkYn": "Y"
    }
  ]
}

Search Payment Methods by PG Company

get

Function Description

Retrieves the payment methods registered for the corresponding PG company.

Detailed Description

Called when a PG company is selected from the PG company list on the [BO] Order/Payment > Payment Method Management > Payment Method Management page.
Retrieves the full list of payment methods registered for the corresponding PG company and their details (payment method name, connection status, modifier, modification date/time).

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pgGbCdStringRequired

PG Classification Code

Responses

200

Payment Methods by PG Company Retrieved Successfully

*/*

totalCountinteger · int32Optional

900

Business processing error details

*/*

get/v1/payment/paymentMethodMgmt/getPaymentMethodListByPg

GET /api/bo/v1/payment/paymentMethodMgmt/getPaymentMethodListByPg?paymentMethodRequest=[object+Object]&pgGbCd=null HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalCount": 1,
  "payloads": [
    {
      "cd": 10,
      "cdNm": "이니시스",
      "useYn": "Y",
      "pgGbCd": 10,
      "pgGbCdNm": "이니시스",
      "payWayCd": 11,
      "payWayCdNm": "신용카드",
      "linkYn": "Y"
    }
  ]
}

PreviousInterest Free Installment Guide Management

NextPayment History Lookup

Last updated 2 months ago