> 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/payment-method-management.md).

# Payment Method Management

## Modify PG Company List

> \## 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).<br>

```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":{"StStdCd":{"type":"object","description":"Group Code Search/Register/Modify Request","properties":{"grpCd":{"type":"string","description":"Group Code"},"cd":{"type":"string","description":"Code"},"cdNm":{"type":"string","description":"Code Name"},"cdDesc":{"type":"string","description":"Code Description"},"useYn":{"type":"string","description":"Usage Status"},"sortSeq":{"type":"integer","format":"int32","description":"Sort Order"},"ref1Val":{"type":"string","description":"Reference Value 1 Description"},"ref2Val":{"type":"string","description":"Reference Value 2 Description"},"ref3Val":{"type":"string","description":"Reference Value 3 Description"},"ref4Val":{"type":"string","description":"Reference Value 4 Description"},"ref5Val":{"type":"string","description":"Reference Value 5 Description"},"ref6Val":{"type":"string","description":"Reference Value 6 Description"},"ref7Val":{"type":"string","description":"Reference Value 7 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/paymentMethodMgmt/savePgList":{"post":{"tags":["Payment Method Management"],"summary":"Modify PG Company List","description":"## Function Description\n* Function to modify PG company information.\n---\n## Detailed Description\n* 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.\n* Can modify the connection status of the payment method registered in the common code (PG Type Code).\n","operationId":"savePgList","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/StStdCd"}}}},"required":true},"responses":{"200":{"description":"PG Company List Modified Successfully","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Register/Modify Payment Method by PG Company

> \## 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.<br>

```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":{"PaymentMethodListRequest":{"type":"object","description":"Payment Method Management DTO","properties":{"createList":{"type":"array","description":"Payment Method New Registration List","items":{"$ref":"#/components/schemas/OpPgByPayMean"}},"updateList":{"type":"array","description":"Payment Method Modification List","items":{"$ref":"#/components/schemas/OpPgByPayMean"}}}},"OpPgByPayMean":{"type":"object","description":"Payment Method Table by PG Company Entity","properties":{"pgGbCd":{"type":"string","description":"PG Type Code (OM030) 10: INICIS"},"payWayCd":{"type":"string","description":"Payment Method Code (OM013) 11: Credit Card, 12: Real-time Account Transfer, 32: Mileage"},"linkYn":{"type":"string","description":"Linked 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/paymentMethodMgmt/savePaymentMethodList":{"post":{"tags":["Payment Method Management"],"summary":"Register/Modify Payment Method by PG Company","description":"## Function Description\n* Function to register a new payment method by PG company or modify an existing registered payment method.\n---\n## Detailed Description\n* 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.\n* Can register a new payment method by PG company or modify the connection status of an existing registered payment method.\n","operationId":"savePaymentMethodList","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentMethodListRequest"}}},"required":true},"responses":{"200":{"description":"Payment Method by PG Company Registered/Modified Successfully","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Search PG Company List

> \## 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).<br>

```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":{"BaseCommonEntity":{},"RealGridListResponsePaymentMethodResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethodResponse"}}}},"PaymentMethodResponse":{"type":"object","description":"Payment Method DTO","properties":{"cd":{"type":"string","description":"Code"},"cdNm":{"type":"string","description":"Code Name"},"useYn":{"type":"string","description":"Usage Status"},"pgGbCd":{"type":"string","description":"PG Classification Code (OM030)"},"pgGbCdNm":{"type":"string","description":"PG Type Code Name"},"payWayCd":{"type":"string","description":"Payment Method Code (OM013)"},"payWayCdNm":{"type":"string","description":"Payment Method Code Name"},"linkYn":{"type":"string","description":"Linked 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/paymentMethodMgmt/getPgList":{"get":{"tags":["Payment Method Management"],"summary":"Search PG Company List","description":"## Function Description\n* Retrieves the list of PG companies registered in the common codes.\n---\n### Detailed Description\n* Called when the PG company list is retrieved on the [BO] Order/Payment > Payment Method Management > Payment Method Management page.\n* Retrieves the **PG Type Code, PG Company Name, and Usage Status** registered in the common code PG Type Code (OM030).\n","operationId":"getPgList","parameters":[{"name":"pagination","in":"query","required":true,"schema":{"$ref":"#/components/schemas/BaseCommonEntity"}}],"responses":{"200":{"description":"PG Company List Retrieved Successfully","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponsePaymentMethodResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Search Payment Methods by PG Company

> \## 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).<br>

```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":{"PaymentMethodRequest":{"type":"object","description":"Payment Method Management DTO","properties":{"pgGbCd":{"type":"string","description":"PG Type Code (OM030) 10: INICIS"}}},"RealGridListResponsePaymentMethodResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethodResponse"}}}},"PaymentMethodResponse":{"type":"object","description":"Payment Method DTO","properties":{"cd":{"type":"string","description":"Code"},"cdNm":{"type":"string","description":"Code Name"},"useYn":{"type":"string","description":"Usage Status"},"pgGbCd":{"type":"string","description":"PG Classification Code (OM030)"},"pgGbCdNm":{"type":"string","description":"PG Type Code Name"},"payWayCd":{"type":"string","description":"Payment Method Code (OM013)"},"payWayCdNm":{"type":"string","description":"Payment Method Code Name"},"linkYn":{"type":"string","description":"Linked 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/paymentMethodMgmt/getPaymentMethodListByPg":{"get":{"tags":["Payment Method Management"],"summary":"Search Payment Methods by PG Company","description":"## Function Description\n* Retrieves the payment methods registered for the corresponding PG company.\n---\n## Detailed Description\n* Called when a PG company is selected from the PG company list on the [BO] Order/Payment > Payment Method Management > Payment Method Management page.\n* 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).\n","operationId":"getPaymentMethodListByPg","parameters":[{"name":"paymentMethodRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/PaymentMethodRequest"}},{"name":"pgGbCd","in":"query","description":"PG Classification Code","required":true,"schema":{"type":"String"}}],"responses":{"200":{"description":"Payment Methods by PG Company Retrieved Successfully","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponsePaymentMethodResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```