> 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/store-front-api-reference/order-api/payment-information.md).

# Payment Information

## Process Mileage Refund

> \## Function Description\
> \* \[BO-only] Processes refund completion for mileage payment cancellations in refund-received status.\
> \---\
> \## Detailed Description\
> \* A feature to request a re-refund for payments that failed to be refunded due to an error during the mileage refund process.\
> \* Applies to entries in refund-received status among the refund data in the base payment table.\
> \* \*\*Order No., order media code, payment No., parent payment No., claim No., requested refund amount, payment amount, member No., and payment method code\*\* are required request conditions.\
> \* Once the refund succeeds, the refund-received status is changed to refund-completed status.<br>

```json
{"openapi":"3.0.1","info":{"title":"X2BEE Order API","version":"v1"},"servers":[{"url":"https://api-order.x2bee.com/api/order/","description":"prd"}],"paths":{"/v1/payment/refundMileagePayment":{"post":{"tags":["Payment Information"],"summary":"Process Mileage Refund","description":"## Function Description\n* [BO-only] Processes refund completion for mileage payment cancellations in refund-received status.\n---\n## Detailed Description\n* A feature to request a re-refund for payments that failed to be refunded due to an error during the mileage refund process.\n* Applies to entries in refund-received status among the refund data in the base payment table.\n* **Order No., order media code, payment No., parent payment No., claim No., requested refund amount, payment amount, member No., and payment method code** are required request conditions.\n* Once the refund succeeds, the refund-received status is changed to refund-completed status.\n","operationId":"refundMileagePayment","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MileagePaymentRequest"}}}},"required":true},"responses":{"200":{"description":"OK"}}}}},"components":{"schemas":{"MileagePaymentRequest":{"type":"object","properties":{"searchStartDt":{"type":"string","description":"Payment Date (Start)","format":"date"},"searchEndDt":{"type":"string","description":"Payment Date (End)","format":"date"},"ordNo":{"type":"string","description":"Order No."},"payGbCd":{"type":"string","description":"OM012 (Payment Type Code)\n 10: Payment\n,20: Refund\n","enum":["PAYMENT","REFUND"]},"payStatCd":{"type":"string","description":"OM014 (Payment Status Code)\n11: Payment Pending\n,12: Payment Completed\n,13: Payment Cancelled\n,21: Refund Requested\n,22: Refund Completed\n,23: Refund Request Cancelled\n","enum":["PAY_WAIT","PAY_COMPLETE","PAY_CANCEL","REFUND_REQUEST","REFUND_COMPLETE","REFUND_REQUEST_CANCEL"]},"ordMediaCd":{"type":"string","description":"Order Channel Code (OM007)\n 10 : Phone Consultation (CC)\n, 20 : PC\n, 30 : Mobile Web\n, 40 : Android App\n, 50 : iOS App\n, 60 : Subscription Order\n","enum":["10","20","30","40","50","60"]},"payNo":{"type":"string","description":"Payment Number"},"uprPayNo":{"type":"string","description":"Parent Payment No."},"ordDtlGbCd":{"type":"string","description":"OM003(Order Detail Type Code)\n 10: Regular Order\n , 11: Order Cancellation\n , 20: Regular Return\n , 21: Return Cancellation\n , 30: Exchange Order\n , 31: Exchange Cancellation\n , 40: Exchange Return\n","enum":["ORDER_GENERAL","ORDER_CANCEL","RETURN_GENERAL","RETURN_WITHDRAWAL","EXCHANGE_ORDER","EXCHANGE_WITHDRAWAL","EXCHANGE_RETURN"]},"claimNo":{"type":"string","description":"Claim No."},"rfdAmt":{"type":"integer","description":"Refund Request Amount","format":"int64"},"payAmt":{"type":"integer","description":"Payment Amount","format":"int64"},"mbrNo":{"type":"string","description":"Member No."},"payWayCd":{"type":"string","description":"OM013 (Payment Method Code)\n 11: Credit Card\n,12: Real-time Account Transfer\n,13: Virtual Account (Bankless Deposit)\n,14: Naver Pay\n,15: Kakao Pay\n,16: Payco\n,17: Samsung Pay\n,18: Apple Pay\n,19: LPAY\n,20: Toss Pay\n,21: SSG Pay\n,32: Mileage\n","enum":["CREDIT_CARD","REAL_TIME_ACCOUNT_TRANSFER","VBANK","NAVER_PAY","KAKAO_PAY","PAYCO","SAMSUNG_PAY","APPLE_PAY","L_PAY","TOSS_PAY","SSG_PAY","MILEAGE"]}},"description":"Mileage Refund DTO"}}}}
```

## Retrieve Merchant Information

> \## Function Description\
> \* Looks up merchant information for PG payment.\
> \---\
> \## Detailed Description\
> \* PG classification code (OM030), system classification code (OM051), and merchant miscellaneous classification code (OM052) are required parameters.\
> \* Looks up merchants registered in BO admin > Payment Management > Payment Method Management > Merchant Management.\
> \* PG payment is not possible if no lookup result is found.\
> \---\
> \## Revision History\
> \* Release v2.00\_240425: Added site search condition for merchant information lookup<br>

```json
{"openapi":"3.0.1","info":{"title":"X2BEE Order API","version":"v1"},"servers":[{"url":"https://api-order.x2bee.com/api/order/","description":"prd"}],"paths":{"/v1/payment/pgMerchant":{"post":{"tags":["Payment Information"],"summary":"Retrieve Merchant Information","description":"## Function Description\n* Looks up merchant information for PG payment.\n---\n## Detailed Description\n* PG classification code (OM030), system classification code (OM051), and merchant miscellaneous classification code (OM052) are required parameters.\n* Looks up merchants registered in BO admin > Payment Management > Payment Method Management > Merchant Management.\n* PG payment is not possible if no lookup result is found.\n---\n## Revision History\n* Release v2.00_240425: Added site search condition for merchant information lookup\n","operationId":"getPgMerchant","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentMerchantRequest"}}},"required":true},"responses":{"200":{"description":"Merchant Retrieved Successfully","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PaymentMerchantResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"PaymentMerchantRequest":{"required":["mersEtcGbCd","pgGbCd","sysGbCd"],"type":"object","properties":{"siteNo":{"type":"string","description":"Site No."},"pgGbCd":{"type":"string","description":"OM030 (PG Type Code)\n 10: INICIS\n,20: TOSS\n","enum":["INICIS","TOSS"]},"sysGbCd":{"type":"string","description":"System Type Code (OM051)"},"mersEtcGbCd":{"type":"string","description":"Merchant Other Type Code (OM052)"}},"description":"Search Merchant Info DTO"},"PaymentMerchantResponse":{"type":"object","properties":{"mersNo":{"type":"string","description":"Merchant Number"},"termlId":{"type":"string","description":"Terminal ID"},"pgGbCd":{"type":"string","description":"PG Classification Code (OM030)"},"mersEtcGbCd":{"type":"string","description":"Merchant Other Type Code (OM052)"},"pointUseYn":{"type":"string","description":"Point Usage Status"},"nintUseYn":{"type":"string","description":"Interest-Free Installment Usage Status"},"useYn":{"type":"string","description":"Usage Status"},"sysGbCd":{"type":"string","description":"System Type Code (OM051)"}},"description":"Search Merchant DTO"},"Response":{"type":"object","properties":{"timestamp":{"type":"string","description":"result time","format":"date-time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"object","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"}},"description":"validation error list"}}}}
```

## Generate Toss Billing Key Issuance Request Parameters

> \## Function Description\
> \* An API that generates the parameters required when requesting billing key issuance.\
> \---\
> \## Detailed Description\
> \* Generates timestamp and hashdata.<br>

```json
{"openapi":"3.0.1","info":{"title":"X2BEE Order API","version":"v1"},"servers":[{"url":"https://api-order.x2bee.com/api/order/","description":"prd"}],"paths":{"/v1/payment/getTossAuthProperties":{"post":{"tags":["Payment Information"],"summary":"Generate Toss Billing Key Issuance Request Parameters","description":"## Function Description\n* An API that generates the parameters required when requesting billing key issuance.\n---\n## Detailed Description\n* Generates timestamp and hashdata.\n","operationId":"getTossAuthProperties","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TossAuthRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/TossAuthResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"TossAuthRequest":{"type":"object","properties":{"mbrNo":{"type":"string","description":"Member No."},"termlId":{"type":"string","description":"Terminal ID"}},"description":"DTO for Generating Toss Billing Key Issuance Request Parameters"},"TossAuthResponse":{"type":"object","properties":{"timestamp":{"type":"string","description":"Timestamp [TimeInMillis (Long type)]"},"hashData":{"type":"string","description":"SHA256 Hash Value (Target: mid, orderid, timestamp)"}},"description":"Toss Billing Key Issuance Request Conversion Result DTO"},"Response":{"type":"object","properties":{"timestamp":{"type":"string","description":"result time","format":"date-time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"object","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"}},"description":"validation error list"}}}}
```

## Look Up PG Information

> \## Function Description\
> \* Looks up PG information using the payment method code.\
> \---\
> \## Detailed Description\
> \* Looks up PG information where the connection status matching the payment method code is Y and the usage status is Y.\
> \---\
> \## Revision History\
> \* Release v2.00\_240627: Added site condition to look up the payment method matching the site and payment method code<br>

```json
{"openapi":"3.0.1","info":{"title":"X2BEE Order API","version":"v1"},"servers":[{"url":"https://api-order.x2bee.com/api/order/","description":"prd"}],"paths":{"/v1/payment/getPgInfo":{"post":{"tags":["Payment Information"],"summary":"Look Up PG Information","description":"## Function Description\n* Looks up PG information using the payment method code.\n---\n## Detailed Description\n* Looks up PG information where the connection status matching the payment method code is Y and the usage status is Y.\n---\n## Revision History\n* Release v2.00_240627: Added site condition to look up the payment method matching the site and payment method code\n","operationId":"getPgInfo","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PgInfoResponse"}}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"PgInfoResponse":{"type":"object","properties":{"pgGbCd":{"type":"string"},"payWayCd":{"type":"string"},"payWayCdNm":{"type":"string"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","description":"result time","format":"date-time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"object","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"}},"description":"validation error list"}}}}
```

## Look Up PG Classification Code in Use by Site

> \## Function Description\
> \* An API that looks up the classification code of the PG company in use for each site.\
> \---\
> \## Detailed Description\
> \* Looks up the PG classification code with usage status 'Y' using the site number, system classification, and merchant miscellaneous classification code.<br>

```json
{"openapi":"3.0.1","info":{"title":"X2BEE Order API","version":"v1"},"servers":[{"url":"https://api-order.x2bee.com/api/order/","description":"prd"}],"paths":{"/v1/payment/getPgGbCdBySiteNo":{"post":{"tags":["Payment Information"],"summary":"Look Up PG Classification Code in Use by Site","description":"## Function Description\n* An API that looks up the classification code of the PG company in use for each site.\n---\n## Detailed Description\n* Looks up the PG classification code with usage status 'Y' using the site number, system classification, and merchant miscellaneous classification code.\n","operationId":"getPgGbCdBySiteNo","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentMerchantRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"PaymentMerchantRequest":{"required":["mersEtcGbCd","pgGbCd","sysGbCd"],"type":"object","properties":{"siteNo":{"type":"string","description":"Site No."},"pgGbCd":{"type":"string","description":"OM030 (PG Type Code)\n 10: INICIS\n,20: TOSS\n","enum":["INICIS","TOSS"]},"sysGbCd":{"type":"string","description":"System Type Code (OM051)"},"mersEtcGbCd":{"type":"string","description":"Merchant Other Type Code (OM052)"}},"description":"Search Merchant Info DTO"},"Response":{"type":"object","properties":{"timestamp":{"type":"string","description":"result time","format":"date-time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"object","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"}},"description":"validation error list"}}}}
```

## Look Up Payment Method Connection Status

> \## Function Description\
> \* An API that looks up the payment method connection status.\
> \---\
> \## Detailed Description\
> \* Looks up the connection status of the payment method registered for the PG company selected in Order/Payment > Payment Method Management > Payment Method Management.<br>

```json
{"openapi":"3.0.1","info":{"title":"X2BEE Order API","version":"v1"},"servers":[{"url":"https://api-order.x2bee.com/api/order/","description":"prd"}],"paths":{"/v1/payment/getPayWayLinkYn":{"post":{"tags":["Payment Information"],"summary":"Look Up Payment Method Connection Status","description":"## Function Description\n* An API that looks up the payment method connection status.\n---\n## Detailed Description\n* Looks up the connection status of the payment method registered for the PG company selected in Order/Payment > Payment Method Management > Payment Method Management.\n","operationId":"getPayWayLinkYn","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentMethodRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PaymentMethodResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"PaymentMethodRequest":{"type":"object","properties":{"payWayCd":{"type":"string","description":"OM013 (Payment Method Code)\n 11: Credit Card\n,12: Real-time Account Transfer\n,13: Virtual Account (Bankless Deposit)\n,14: Naver Pay\n,15: Kakao Pay\n,16: Payco\n,17: Samsung Pay\n,18: Apple Pay\n,19: LPAY\n,20: Toss Pay\n,21: SSG Pay\n,32: Mileage\n","enum":["CREDIT_CARD","REAL_TIME_ACCOUNT_TRANSFER","VBANK","NAVER_PAY","KAKAO_PAY","PAYCO","SAMSUNG_PAY","APPLE_PAY","L_PAY","TOSS_PAY","SSG_PAY","MILEAGE"]},"pgGbCd":{"type":"string","description":"OM030 (PG Type Code)\n 10: INICIS\n,20: TOSS\n","enum":["INICIS","TOSS"]}},"description":"Search Payment Method Connection Status DTO"},"PaymentMethodResponse":{"type":"object","properties":{"payWayCd":{"type":"string","description":"OM013 (Payment Method Code)\n 11: Credit Card\n,12: Real-time Account Transfer\n,13: Virtual Account (Bankless Deposit)\n,14: Naver Pay\n,15: Kakao Pay\n,16: Payco\n,17: Samsung Pay\n,18: Apple Pay\n,19: LPAY\n,20: Toss Pay\n,21: SSG Pay\n,32: Mileage\n","enum":["CREDIT_CARD","REAL_TIME_ACCOUNT_TRANSFER","VBANK","NAVER_PAY","KAKAO_PAY","PAYCO","SAMSUNG_PAY","APPLE_PAY","L_PAY","TOSS_PAY","SSG_PAY","MILEAGE"]},"payWayNm":{"type":"string","description":"Payment Method Name"},"pgGbCd":{"type":"string","description":"OM030 (PG Type Code)\n 10: INICIS\n,20: TOSS\n","enum":["INICIS","TOSS"]},"linkYn":{"type":"string","description":"Linked Status"}},"description":"Payment Method Connection Status DTO"},"Response":{"type":"object","properties":{"timestamp":{"type":"string","description":"result time","format":"date-time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"object","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"}},"description":"validation error list"}}}}
```

## Payment Allocation

> &#x20; \## Function Description\
> &#x20; \* Creates payment allocation information.\
> &#x20; \---\
> &#x20; \## Detailed Description\
> &#x20; \* Creates payment allocation information based on the total payment amount.\
> &#x20; \* The payment allocation point unit is 10 won.<br>

```json
{"openapi":"3.0.1","info":{"title":"X2BEE Order API","version":"v1"},"servers":[{"url":"https://api-order.x2bee.com/api/order/","description":"prd"}],"paths":{"/v1/payment/getPayDivInfo":{"post":{"tags":["Payment Information"],"summary":"Payment Allocation","description":"  ## Function Description\n  * Creates payment allocation information.\n  ---\n  ## Detailed Description\n  * Creates payment allocation information based on the total payment amount.\n  * The payment allocation point unit is 10 won.\n","operationId":"getPayDivInfo","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentDivRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OpOrdPayDivInfo"}}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"PaymentDivRequest":{"type":"object","properties":{"adminOrdAmtProcTypCd":{"type":"string"},"totalAmt":{"type":"integer","format":"int64"},"crdtCardAmt":{"type":"integer","format":"int64"},"milgAmt":{"type":"integer","format":"int64"},"rltmActnTrsfAmt":{"type":"integer","format":"int64"},"virActnTrsfAmt":{"type":"integer","format":"int64"},"opOrdAdtnCostList":{"type":"array","items":{"$ref":"#/components/schemas/OpOrdAdtnCost"}},"opOrdPayDivInfoList":{"type":"array","items":{"$ref":"#/components/schemas/OpOrdPayDivInfo"}},"addPay":{"type":"boolean"}}},"OpOrdAdtnCost":{"type":"object","properties":{"ordAdtnSn":{"type":"string","description":"Order Additional Cost Sequence No."},"ordNo":{"type":"string","description":"Order No."},"claimNo":{"type":"string","description":"Claim No."},"deliNo":{"type":"string","description":"Delivery No."},"uprOrdAdtnSn":{"type":"string","description":"Parent Additional Cost Sequence No."},"entrNo":{"type":"string","description":"Vendor No."},"adtnOcurGbCd":{"type":"string","description":"OM017 (Additional Cost Occurrence Classification Code)\n 10: Occurred\n , 20: Cancelled\n","enum":["OCCURRNECE","CANCEL"]},"ordCostGbCd":{"type":"string","description":"OM043(Order Cost Type Code)\n 10: Delivery Fee\n , 20: Return Pickup Fee\n , 30: Exchange Delivery Fee\n , 40: Additional Delivery Fee\n","enum":["DELIVERY_FEE","RETURN_FEE","EXCHANGE_FEE","EXTRA_FEE"]},"stdAdtnAmt":{"type":"integer","description":"Base Additional Cost Amount","format":"int64"},"aplyAdtnAmt":{"type":"integer","description":"Applied Additional Cost Amount","format":"int64"},"cnclAdtnAmt":{"type":"integer","description":"Cancelled Additional Cost Amount","format":"int64"},"fvrAdtnAmt":{"type":"integer","description":"Benefit Additional Cost Amount","format":"int64"},"deliPolcNo":{"type":"string","description":"Delivery Policy No."},"dlexTypCd":{"type":"string","description":"Delivery Fee Type Code","enum":["FREE","CHARGED","CONDITIONAL_FREE"]},"dlexCnclCausCd":{"type":"string","description":"OM022 (Shipping Fee Cancellation Reason Code)\n 10: N/A\n , 20: Free Shipping Voucher\n , 30: Customer Claim\n , 40: Company Fault\n","enum":["NOT_APPLICABLE","FREE_DELIVERY_COUPON","CUSTOMER_CLAIM","COMPANY_FALUT"]},"dlexAmt":{"type":"integer","description":"Delivery Fee Amount","format":"int64"},"adtnBassNo":{"type":"string","description":"Additional Cost Basis No."},"adtnDtlBassNo":{"type":"string","description":"Additional Cost Detail Basis No."},"fvrPolcTypCd":{"type":"string","description":"OM020 (Benefit Policy Type Code)\n 00: Not Used\n , 11: Fixed Amount Discount\n , 12: Fixed Rate Discount\n , 21: Fixed Amount Accrual\n , 22: Fixed Rate Accrual\n","enum":["NOT_AVAILABLE","DISCOUNT_PRICE","DISCOUNT_RATE","ACCUMULATE_PRICE","ACCUMULATE_RATE"]},"fvrPolcAplyVal":{"type":"integer","description":"Benefit Policy Applied Value","format":"int64"},"fvrMinBuyAmt":{"type":"integer","description":"Benefit Minimum Purchase Amount","format":"int64"},"fvrMaxDcAmt":{"type":"integer","description":"Benefit Maximum Discount Amount","format":"int64"},"entrChrgRate":{"type":"integer","description":"Vendor Cost-Sharing Rate","format":"int32"},"entrChrgAmt":{"type":"integer","description":"Vendor-Borne Amount","format":"int64"},"ourChrgRate":{"type":"integer","description":"Company Cost-Sharing Rate","format":"int32"},"ourChrgAmt":{"type":"integer","description":"Company-Borne Amount","format":"int64"},"promoNm":{"type":"string","description":"Promotion Name"}},"description":"Order Additional Cost Info DTO"},"OpOrdPayDivInfo":{"type":"object","properties":{"payDivSeq":{"type":"string","description":"Payment Allocation Sequence No."},"ordNo":{"type":"string","description":"Order No."},"ordSeq":{"type":"integer","description":"Order Sequence No.","format":"int32"},"ordProcSeq":{"type":"integer","description":"Order Processing Sequence No.","format":"int32"},"uprPayDivSeq":{"type":"string","description":"Parent Payment Allocation Sequence No."},"divGbCd":{"type":"string","description":"Allocation Type Code (OM073)"},"adtnOcurGbCd":{"type":"string","description":"Additional Cost Occurrence Classification Code (OM017)"},"ordCostGbCd":{"type":"string","description":"Order Cost Type Code (OM043)"},"deliPolcNo":{"type":"string","description":"Delivery Fee Policy No."},"entrNo":{"type":"string","description":"Merchant No."},"claimNo":{"type":"string","description":"Claim No."},"salePrc":{"type":"integer","description":"Selling Price","format":"int64"},"ordQty":{"type":"integer","description":"Order Quantity","format":"int32"},"cnclQty":{"type":"integer","description":"Cancellation Quantity","format":"int32"},"ordAmt":{"type":"integer","description":"Order Amount","format":"int64"},"crdtCardDivAmt":{"type":"integer","description":"Credit Card Allocation Amount","format":"int64"},"milgDivAmt":{"type":"integer","description":"Point Allocation Amount","format":"int64"},"rltmActnTrsfDivAmt":{"type":"integer","description":"Real-Time Account Transfer Allocation Amount","format":"int64"},"virActnTrsfDivAmt":{"type":"integer","description":"Virtual Account Transfer Allocation Amount","format":"int64"},"deliNo":{"type":"string","description":"Delivery No."},"taxGbCd":{"type":"string","description":"Tax/Duty-Free Classification Code (PR007)"},"addPayYn":{"type":"string","description":"Additional Payment Status"},"itemNm":{"type":"string","description":"Item Name"},"taxGbCdNm":{"type":"string","description":"Tax/Duty-Free Classification Code (PR007)"},"occurTaxFree":{"type":"boolean"},"cancelTaxFree":{"type":"boolean"},"addPayDeliFee":{"type":"boolean"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","description":"result time","format":"date-time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"object","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"}},"description":"validation error list"}}}}
```

## Generate Inicis PC Payment Request Parameters

> \## Function Description\
> \* An API that generates the parameters required when requesting an Inicis PC payment.\
> \---\
> \## Detailed Description\
> \* Generates timestamp, signature, verification, and mKey.<br>

```json
{"openapi":"3.0.1","info":{"title":"X2BEE Order API","version":"v1"},"servers":[{"url":"https://api-order.x2bee.com/api/order/","description":"prd"}],"paths":{"/v1/payment/getInicisPcAuthProperties":{"post":{"tags":["Payment Information"],"summary":"Generate Inicis PC Payment Request Parameters","description":"## Function Description\n* An API that generates the parameters required when requesting an Inicis PC payment.\n---\n## Detailed Description\n* Generates timestamp, signature, verification, and mKey.\n","operationId":"getInicisPcAuthProperties","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InicisPcAuthRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/InicisPcAuthResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"InicisPcAuthRequest":{"type":"object","properties":{"ordNo":{"type":"string","description":"Order No."},"payAmt":{"type":"integer","description":"Order Amount","format":"int64"}},"description":"DTO for Generating INICIS PC Payment Authentication Parameters"},"InicisPcAuthResponse":{"type":"object","properties":{"timestamp":{"type":"string","description":"Timestamp [TimeInMillis (Long type)]"},"signature":{"type":"string","description":"SHA256 Hash Value (Target: oid, price, timestamp)"},"verification":{"type":"string","description":"SHA256 Hash Value (Target: oid, price, signKey, timestamp)"},"mkey":{"type":"string"}},"description":"INICIS PC Payment Request Conversion Result DTO"},"Response":{"type":"object","properties":{"timestamp":{"type":"string","description":"result time","format":"date-time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"object","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"}},"description":"validation error list"}}}}
```

## Generate Inicis MO Billing Key Issuance Request Parameters

> \## Function Description\
> \* An API that generates the parameters required when requesting an Inicis MO billing key issuance.\
> \---\
> \## Detailed Description\
> \* Generates timestamp and hashdata.<br>

```json
{"openapi":"3.0.1","info":{"title":"X2BEE Order API","version":"v1"},"servers":[{"url":"https://api-order.x2bee.com/api/order/","description":"prd"}],"paths":{"/v1/payment/getInicisMoAuthProperties":{"post":{"tags":["Payment Information"],"summary":"Generate Inicis MO Billing Key Issuance Request Parameters","description":"## Function Description\n* An API that generates the parameters required when requesting an Inicis MO billing key issuance.\n---\n## Detailed Description\n* Generates timestamp and hashdata.\n","operationId":"getInicisMoAuthProperties","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InicisMoAuthRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/InicisMoAuthResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"InicisMoAuthRequest":{"type":"object","properties":{"ordNo":{"type":"string","description":"Order No."},"termlId":{"type":"string","description":"Terminal ID"}},"description":"DTO for Generating INICIS MO Billing Key Issuance Request Parameters"},"InicisMoAuthResponse":{"type":"object","properties":{"timestamp":{"type":"string","description":"Timestamp [TimeInMillis (Long type)]"},"hashData":{"type":"string","description":"SHA256 Hash Value (Target: mid, orderid, timestamp, INILitekey)"}},"description":"INICIS MO Billing Key Issuance Request Conversion Result DTO"},"Response":{"type":"object","properties":{"timestamp":{"type":"string","description":"result time","format":"date-time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"object","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"}},"description":"validation error list"}}}}
```

## Search Interest-Free Installment Info List

> &#x20; \## Function Description\
> &#x20; \* Retrieves the list of interest-free installment info for credit cards.\
> &#x20; \---\
> &#x20; \## Detailed Description\
> &#x20; \* Retrieves the data registered in BO's Order/Payment > Payment Method Management > Interest-Free Installment Info Management<br>

```json
{"openapi":"3.0.1","info":{"title":"X2BEE Order API","version":"v1"},"servers":[{"url":"https://api-order.x2bee.com/api/order/","description":"prd"}],"paths":{"/v1/payment/getInterestFreeList":{"get":{"tags":["Payment Information"],"summary":"Search Interest-Free Installment Info List","description":"  ## Function Description\n  * Retrieves the list of interest-free installment info for credit cards.\n  ---\n  ## Detailed Description\n  * Retrieves the data registered in BO's Order/Payment > Payment Method Management > Interest-Free Installment Info Management\n","operationId":"getInterestFreeList","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InterestFreeResponse"}}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"InterestFreeResponse":{"type":"object","properties":{"nintInstGdNo":{"type":"string","description":"Interest-Free Installment Guide No."},"acqrCd":{"type":"string","description":"Purchasing Company Code (OM028)"},"acqrNm":{"type":"string","description":"Acquirer Name"},"aplyStrDtm":{"type":"string","description":"Application Start Date/Time"},"aplyEndDtm":{"type":"string","description":"Application End Date/Time"},"nintInstNm":{"type":"string","description":"Interest-Free Installment Name"},"nintAplyTgtCont":{"type":"string","description":"Interest-Free Installment Eligible Details"},"nintExcpTgtCont":{"type":"string","description":"Interest-Free Installment Excluded Details"},"sctnNintYn":{"type":"string","description":"Partial Interest-Free Status"},"pgGbCd":{"type":"string","description":"PG Type Code (OM030)"},"pgGbNm":{"type":"string","description":"PG Company Name"},"monthList":{"type":"array","description":"List of Interest-Free Status by Month","items":{"$ref":"#/components/schemas/InterestFreeMonth"}}}},"InterestFreeMonth":{"type":"object","properties":{"tgtAmt":{"type":"number","description":"Target Amount","format":"double"},"nint1MonYn":{"type":"string","description":"Interest-Free 1-Month Status"},"nint2MonYn":{"type":"string","description":"Interest-Free 2-Month Status"},"nint3MonYn":{"type":"string","description":"Interest-Free 3-Month Status"},"nint4MonYn":{"type":"string","description":"Interest-Free 4-Month Status"},"nint5MonYn":{"type":"string","description":"Interest-Free 5-Month Status"},"nint6MonYn":{"type":"string","description":"Interest-Free 6-Month Status"},"nint7MonYn":{"type":"string","description":"Interest-Free 7-Month Status"},"nint8MonYn":{"type":"string","description":"Interest-Free 8-Month Status"},"nint9MonYn":{"type":"string","description":"Interest-Free 9-Month Status"},"nint10MonYn":{"type":"string","description":"Interest-Free 10-Month Status"},"nint11MonYn":{"type":"string","description":"Interest-Free 11-Month Status"},"nint12MonYn":{"type":"string","description":"Interest-Free 12-Month Status"}},"description":"List of Interest-Free Status by Month"},"Response":{"type":"object","properties":{"timestamp":{"type":"string","description":"result time","format":"date-time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"object","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"}},"description":"validation error list"}}}}
```

## Search MID for Account Verification

> \## Function Description\
> \* API that retrieves the dedicated MID for account verification.\
> \---\
> \## Detailed Description\
> \* Retrieves the MID for account verification.<br>

```json
{"openapi":"3.0.1","info":{"title":"X2BEE Order API","version":"v1"},"servers":[{"url":"https://api-order.x2bee.com/api/order/","description":"prd"}],"paths":{"/v1/payment/accountCertiMid":{"get":{"tags":["Payment Information"],"summary":"Search MID for Account Verification","description":"## Function Description\n* API that retrieves the dedicated MID for account verification.\n---\n## Detailed Description\n* Retrieves the MID for account verification.\n","operationId":"getAcoountCertiMid","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"String"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"Response":{"type":"object","properties":{"timestamp":{"type":"string","description":"result time","format":"date-time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"object","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"}},"description":"validation error list"}}}}
```