Payment Information

Process Mileage Refund

post

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.

Header parameters

AuthorizationanyOptional

Access Token

Bodyobject · MileagePaymentRequest[]

Mileage Refund DTO

searchStartDtstring · dateOptional

Payment Date (Start)

Example: 2023-01-01

searchEndDtstring · dateOptional

Payment Date (End)

Example: 2023-01-31

ordNostringOptional

Order No.

Example: 20230808O007404

payGbCdstring · enumOptional

OM012 (Payment Type Code) 10: Payment ,20: Refund

Example: 10Possible values:

payStatCdstring · enumOptional

OM014 (Payment Status Code) 11: Payment Pending ,12: Payment Completed ,13: Payment Cancelled ,21: Refund Requested ,22: Refund Completed ,23: Refund Request Cancelled

Example: 11Possible values:

ordMediaCdstring · enumOptional

Order Channel Code (OM007) 10 : Phone Consultation (CC) , 20 : PC , 30 : Mobile Web , 40 : Android App , 50 : iOS App , 60 : Subscription Order

Example: 20Possible values:

payNostringOptional

Payment Number

Example: 2

uprPayNostringOptional

Parent Payment No.

Example: 1

ordDtlGbCdstring · enumOptional

OM003(Order Detail Type Code) 10: Regular Order , 11: Order Cancellation , 20: Regular Return , 21: Return Cancellation , 30: Exchange Order , 31: Exchange Cancellation , 40: Exchange Return

Example: 10Possible values:

claimNostringOptional

Claim No.

Example: 20230801C008072

rfdAmtinteger · int64Optional

Refund Request Amount

Example: 1000

payAmtinteger · int64Optional

Payment Amount

Example: 1000

mbrNostringOptional

Member No.

Example: 100001311

payWayCdstring · enumOptional

OM013 (Payment Method Code) 11: Credit Card ,12: Real-time Account Transfer ,13: Virtual Account (Bankless Deposit) ,14: Naver Pay ,15: Kakao Pay ,16: Payco ,17: Samsung Pay ,18: Apple Pay ,19: LPAY ,20: Toss Pay ,21: SSG Pay ,32: Mileage

Example: 11Possible values:

Responses

200

OK

No content

post/v1/payment/refundMileagePayment

POST /api/order/v1/payment/refundMileagePayment HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 272

[
  {
    "searchStartDt": "2023-01-01",
    "searchEndDt": "2023-01-31",
    "ordNo": "20230808O007404",
    "payGbCd": "10",
    "payStatCd": "11",
    "ordMediaCd": "20",
    "payNo": "2",
    "uprPayNo": "1",
    "ordDtlGbCd": "10",
    "claimNo": "20230801C008072",
    "rfdAmt": 1000,
    "payAmt": 1000,
    "mbrNo": "100001311",
    "payWayCd": "11"
  }
]

200

OK

No content

Retrieve Merchant Information

post

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

Header parameters

AuthorizationanyOptional

Access Token

Body

Search Merchant Info DTO

siteNostringOptional

Site No.

Example: 1

pgGbCdstring · enumRequired

OM030 (PG Type Code) 10: INICIS ,20: TOSS

Example: 10Possible values:

sysGbCdstringRequired

System Type Code (OM051)

Example: 20

mersEtcGbCdstringRequired

Merchant Other Type Code (OM052)

Example: 99

Responses

200

Merchant Retrieved Successfully

*/*

Search Merchant DTO

mersNostringOptional

Merchant Number

Example: 1

termlIdstringOptional

Terminal ID

Example: INIPayTest

pgGbCdstringOptional

PG Classification Code (OM030)

Example: 10

mersEtcGbCdstringOptional

Merchant Other Type Code (OM052)

Example: 99

pointUseYnstringOptional

Point Usage Status

Example: N

nintUseYnstringOptional

Interest-Free Installment Usage Status

Example: N

useYnstringOptional

Usage Status

Example: Y

sysGbCdstringOptional

System Type Code (OM051)

Example: 20

900

Business processing error details

*/*

post/v1/payment/pgMerchant

POST /api/order/v1/payment/pgMerchant HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 62

{
  "siteNo": "1",
  "pgGbCd": "10",
  "sysGbCd": "20",
  "mersEtcGbCd": "99"
}

{
  "mersNo": "1",
  "termlId": "INIPayTest",
  "pgGbCd": "10",
  "mersEtcGbCd": "99",
  "pointUseYn": "N",
  "nintUseYn": "N",
  "useYn": "Y",
  "sysGbCd": "20"
}

Generate Toss Billing Key Issuance Request Parameters

post

Function Description

• An API that generates the parameters required when requesting billing key issuance.

---

Detailed Description

• Generates timestamp and hashdata.

Header parameters

AuthorizationanyOptional

Access Token

Body

DTO for Generating Toss Billing Key Issuance Request Parameters

mbrNostringOptional

Member No.

Example: 10001234

termlIdstringOptional

Terminal ID

Example: TossPayTest

Responses

200

Success

*/*

Toss Billing Key Issuance Request Conversion Result DTO

timestampstringOptional

Timestamp [TimeInMillis (Long type)]

Example: 1697762894911

hashDatastringOptional

SHA256 Hash Value (Target: mid, orderid, timestamp)

Example: 422a0e78529b419d9412d6e344c6e138584d9174c691da6cd91d4330240b9192

900

Business processing error details

*/*

post/v1/payment/getTossAuthProperties

POST /api/order/v1/payment/getTossAuthProperties HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "mbrNo": "10001234",
  "termlId": "TossPayTest"
}

{
  "timestamp": "1697762894911",
  "hashData": "422a0e78529b419d9412d6e344c6e138584d9174c691da6cd91d4330240b9192"
}

Look Up PG Information

post

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

Header parameters

AuthorizationanyOptional

Access Token

Bodystring[]

string[]Optional

Responses

200

Success

*/*

pgGbCdstringOptional

payWayCdstringOptional

payWayCdNmstringOptional

900

Business processing error details

*/*

post/v1/payment/getPgInfo

POST /api/order/v1/payment/getPgInfo HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 8

[
  "text"
]

[
  {
    "pgGbCd": "text",
    "payWayCd": "text",
    "payWayCdNm": "text"
  }
]

Look Up PG Classification Code in Use by Site

post

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.

Header parameters

AuthorizationanyOptional

Access Token

Body

Search Merchant Info DTO

siteNostringOptional

Site No.

Example: 1

pgGbCdstring · enumRequired

OM030 (PG Type Code) 10: INICIS ,20: TOSS

Example: 10Possible values:

sysGbCdstringRequired

System Type Code (OM051)

Example: 20

mersEtcGbCdstringRequired

Merchant Other Type Code (OM052)

Example: 99

Responses

200

Success

*/*

stringOptional

900

Business processing error details

*/*

post/v1/payment/getPgGbCdBySiteNo

POST /api/order/v1/payment/getPgGbCdBySiteNo HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 62

{
  "siteNo": "1",
  "pgGbCd": "10",
  "sysGbCd": "20",
  "mersEtcGbCd": "99"
}

text

Look Up Payment Method Connection Status

post

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.

Header parameters

AuthorizationanyOptional

Access Token

Body

Search Payment Method Connection Status DTO

payWayCdstring · enumOptional

OM013 (Payment Method Code) 11: Credit Card ,12: Real-time Account Transfer ,13: Virtual Account (Bankless Deposit) ,14: Naver Pay ,15: Kakao Pay ,16: Payco ,17: Samsung Pay ,18: Apple Pay ,19: LPAY ,20: Toss Pay ,21: SSG Pay ,32: Mileage

Example: 11Possible values:

pgGbCdstring · enumOptional

OM030 (PG Type Code) 10: INICIS ,20: TOSS

Example: 10Possible values:

Responses

200

Success

*/*

Payment Method Connection Status DTO

payWayCdstring · enumOptional

OM013 (Payment Method Code) 11: Credit Card ,12: Real-time Account Transfer ,13: Virtual Account (Bankless Deposit) ,14: Naver Pay ,15: Kakao Pay ,16: Payco ,17: Samsung Pay ,18: Apple Pay ,19: LPAY ,20: Toss Pay ,21: SSG Pay ,32: Mileage

Example: 11Possible values:

payWayNmstringOptional

Payment Method Name

Example: 신용카드

pgGbCdstring · enumOptional

OM030 (PG Type Code) 10: INICIS ,20: TOSS

Example: 10Possible values:

linkYnstringOptional

Linked Status

Example: Y

900

Business processing error details

*/*

post/v1/payment/getPayWayLinkYn

POST /api/order/v1/payment/getPayWayLinkYn HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "payWayCd": "11",
  "pgGbCd": "10"
}

{
  "payWayCd": "11",
  "payWayNm": "신용카드",
  "pgGbCd": "10",
  "linkYn": "Y"
}

Payment Allocation

post

Function Description

• Creates payment allocation information.

---

Detailed Description

• Creates payment allocation information based on the total payment amount.

• The payment allocation point unit is 10 won.

Header parameters

AuthorizationanyOptional

Access Token

Body

adminOrdAmtProcTypCdstringOptional

totalAmtinteger · int64Optional

crdtCardAmtinteger · int64Optional

milgAmtinteger · int64Optional

rltmActnTrsfAmtinteger · int64Optional

virActnTrsfAmtinteger · int64Optional

addPaybooleanOptional

Responses

200

Success

*/*

payDivSeqstringOptional

Payment Allocation Sequence No.

Example: 1

ordNostringOptional

Order No.

Example: 20230809O007055

ordSeqinteger · int32Optional

Order Sequence No.

Example: 1

ordProcSeqinteger · int32Optional

Order Processing Sequence No.

Example: 1

uprPayDivSeqstringOptional

Parent Payment Allocation Sequence No.

Example: 1

divGbCdstringOptional

Allocation Type Code (OM073)

Example: 10

adtnOcurGbCdstringOptional

Additional Cost Occurrence Classification Code (OM017)

Example: 10

ordCostGbCdstringOptional

Order Cost Type Code (OM043)

Example: 10

deliPolcNostringOptional

Delivery Fee Policy No.

Example: 10000000

entrNostringOptional

Merchant No.

Example: 1000000

claimNostringOptional

Claim No.

Example: 20240812C000041

salePrcinteger · int64Optional

Selling Price

Example: 10000

ordQtyinteger · int32Optional

Order Quantity

Example: 1

cnclQtyinteger · int32Optional

Cancellation Quantity

Example: 0

ordAmtinteger · int64Optional

Order Amount

Example: 10000

crdtCardDivAmtinteger · int64Optional

Credit Card Allocation Amount

Example: 8000

milgDivAmtinteger · int64Optional

Point Allocation Amount

Example: 2000

rltmActnTrsfDivAmtinteger · int64Optional

Real-Time Account Transfer Allocation Amount

Example: 0

virActnTrsfDivAmtinteger · int64Optional

Virtual Account Transfer Allocation Amount

Example: 0

deliNostringOptional

Delivery No.

Example: 100000003

taxGbCdstringOptional

Tax/Duty-Free Classification Code (PR007)

Example: 01

addPayYnstringOptional

Additional Payment Status

Example: N

itemNmstringOptional

Item Name

Example: 상품A

taxGbCdNmstringOptional

Tax/Duty-Free Classification Code (PR007)

Example: 01

occurTaxFreebooleanOptional

cancelTaxFreebooleanOptional

addPayDeliFeebooleanOptional

900

Business processing error details

*/*

post/v1/payment/getPayDivInfo

POST /api/order/v1/payment/getPayDivInfo HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 1222

{
  "adminOrdAmtProcTypCd": "text",
  "totalAmt": 1,
  "crdtCardAmt": 1,
  "milgAmt": 1,
  "rltmActnTrsfAmt": 1,
  "virActnTrsfAmt": 1,
  "opOrdAdtnCostList": [
    {
      "ordAdtnSn": "100001315",
      "ordNo": "20231231O000001",
      "claimNo": "20231231C000001",
      "deliNo": "100000001",
      "uprOrdAdtnSn": "100000842",
      "entrNo": "1000002",
      "adtnOcurGbCd": "10",
      "ordCostGbCd": "10",
      "stdAdtnAmt": 100000,
      "aplyAdtnAmt": 0,
      "cnclAdtnAmt": 0,
      "fvrAdtnAmt": 0,
      "deliPolcNo": "10000431",
      "dlexTypCd": "30",
      "dlexCnclCausCd": "10",
      "dlexAmt": 3000,
      "adtnBassNo": "C1001182",
      "adtnDtlBassNo": "105962",
      "fvrPolcTypCd": "00",
      "fvrPolcAplyVal": 0,
      "fvrMinBuyAmt": 0,
      "fvrMaxDcAmt": 0,
      "entrChrgRate": 0,
      "entrChrgAmt": 0,
      "ourChrgRate": 100,
      "ourChrgAmt": 0,
      "promoNm": "무료배송쿠폰"
    }
  ],
  "opOrdPayDivInfoList": [
    {
      "payDivSeq": "1",
      "ordNo": "20230809O007055",
      "ordSeq": 1,
      "ordProcSeq": 1,
      "uprPayDivSeq": "1",
      "divGbCd": "10",
      "adtnOcurGbCd": "10",
      "ordCostGbCd": "10",
      "deliPolcNo": "10000000",
      "entrNo": "1000000",
      "claimNo": "20240812C000041",
      "salePrc": 10000,
      "ordQty": 1,
      "cnclQty": 0,
      "ordAmt": 10000,
      "crdtCardDivAmt": 8000,
      "milgDivAmt": 2000,
      "rltmActnTrsfDivAmt": 0,
      "virActnTrsfDivAmt": 0,
      "deliNo": "100000003",
      "taxGbCd": "01",
      "addPayYn": "N",
      "itemNm": "상품A",
      "taxGbCdNm": "01",
      "occurTaxFree": true,
      "cancelTaxFree": true,
      "addPayDeliFee": true
    }
  ],
  "addPay": true
}

[
  {
    "payDivSeq": "1",
    "ordNo": "20230809O007055",
    "ordSeq": 1,
    "ordProcSeq": 1,
    "uprPayDivSeq": "1",
    "divGbCd": "10",
    "adtnOcurGbCd": "10",
    "ordCostGbCd": "10",
    "deliPolcNo": "10000000",
    "entrNo": "1000000",
    "claimNo": "20240812C000041",
    "salePrc": 10000,
    "ordQty": 1,
    "cnclQty": 0,
    "ordAmt": 10000,
    "crdtCardDivAmt": 8000,
    "milgDivAmt": 2000,
    "rltmActnTrsfDivAmt": 0,
    "virActnTrsfDivAmt": 0,
    "deliNo": "100000003",
    "taxGbCd": "01",
    "addPayYn": "N",
    "itemNm": "상품A",
    "taxGbCdNm": "01",
    "occurTaxFree": true,
    "cancelTaxFree": true,
    "addPayDeliFee": true
  }
]

Generate Inicis PC Payment Request Parameters

post

Function Description

• An API that generates the parameters required when requesting an Inicis PC payment.

---

Detailed Description

• Generates timestamp, signature, verification, and mKey.

Header parameters

AuthorizationanyOptional

Access Token

Body

DTO for Generating INICIS PC Payment Authentication Parameters

ordNostringOptional

Order No.

Example: 20230101O000000

payAmtinteger · int64Optional

Order Amount

Example: 10000

Responses

200

Success

*/*

INICIS PC Payment Request Conversion Result DTO

timestampstringOptional

Timestamp [TimeInMillis (Long type)]

Example: 1697762894911

signaturestringOptional

SHA256 Hash Value (Target: oid, price, timestamp)

Example: 422a0e78529b419d9412d6e344c6e138584d9174c691da6cd91d4330240b9192

verificationstringOptional

SHA256 Hash Value (Target: oid, price, signKey, timestamp)

Example: 05c6b90795860660a8490afc659cc0bee4d5c771f2386e1cb272b90e02250bed

mkeystringOptional

900

Business processing error details

*/*

post/v1/payment/getInicisPcAuthProperties

POST /api/order/v1/payment/getInicisPcAuthProperties HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 42

{
  "ordNo": "20230101O000000",
  "payAmt": 10000
}

{
  "timestamp": "1697762894911",
  "signature": "422a0e78529b419d9412d6e344c6e138584d9174c691da6cd91d4330240b9192",
  "verification": "05c6b90795860660a8490afc659cc0bee4d5c771f2386e1cb272b90e02250bed",
  "mkey": "text"
}

Generate Inicis MO Billing Key Issuance Request Parameters

post

Function Description

• An API that generates the parameters required when requesting an Inicis MO billing key issuance.

---

Detailed Description

• Generates timestamp and hashdata.

Header parameters

AuthorizationanyOptional

Access Token

Body

DTO for Generating INICIS MO Billing Key Issuance Request Parameters

ordNostringOptional

Order No.

Example: 20230101O000000

termlIdstringOptional

Terminal ID

Example: INIPayTest

Responses

200

Success

*/*

INICIS MO Billing Key Issuance Request Conversion Result DTO

timestampstringOptional

Timestamp [TimeInMillis (Long type)]

Example: 1697762894911

hashDatastringOptional

SHA256 Hash Value (Target: mid, orderid, timestamp, INILitekey)

Example: 422a0e78529b419d9412d6e344c6e138584d9174c691da6cd91d4330240b9192

900

Business processing error details

*/*

post/v1/payment/getInicisMoAuthProperties

POST /api/order/v1/payment/getInicisMoAuthProperties HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 50

{
  "ordNo": "20230101O000000",
  "termlId": "INIPayTest"
}

{
  "timestamp": "1697762894911",
  "hashData": "422a0e78529b419d9412d6e344c6e138584d9174c691da6cd91d4330240b9192"
}

Search Interest-Free Installment Info List

get

Function Description

• Retrieves the list of interest-free installment info for credit cards.

---

Detailed Description

• Retrieves the data registered in BO's Order/Payment > Payment Method Management > Interest-Free Installment Info Management

Header parameters

AuthorizationanyOptional

Access Token

Responses

200

Success

*/*

nintInstGdNostringOptional

Interest-Free Installment Guide No.

Example: 242

acqrCdstringOptional

Purchasing Company Code (OM028)

Example: 121

acqrNmstringOptional

Acquirer Name

Example: 국민카드

aplyStrDtmstringOptional

Application Start Date/Time

Example: 2023-07-05 09:02:00

aplyEndDtmstringOptional

Application End Date/Time

Example: 2023-07-05 09:02:00

nintInstNmstringOptional

Interest-Free Installment Name

Example: 국민카드 무이자할부 안내

nintAplyTgtContstringOptional

Interest-Free Installment Eligible Details

Example: 적용대상내용

nintExcpTgtContstringOptional

Interest-Free Installment Excluded Details

Example: 제외대상내용

sctnNintYnstringOptional

Partial Interest-Free Status

Example: N

pgGbCdstringOptional

PG Type Code (OM030)

Example: 10

pgGbNmstringOptional

PG Company Name

Example: 이니시스

900

Business processing error details

*/*

get/v1/payment/getInterestFreeList

GET /api/order/v1/payment/getInterestFreeList HTTP/1.1
Host: api-order.x2bee.com/
Accept: */*

[
  {
    "nintInstGdNo": "242",
    "acqrCd": "121",
    "acqrNm": "국민카드",
    "aplyStrDtm": "2023-07-05 09:02:00",
    "aplyEndDtm": "2023-07-05 09:02:00",
    "nintInstNm": "국민카드 무이자할부 안내",
    "nintAplyTgtCont": "적용대상내용",
    "nintExcpTgtCont": "제외대상내용",
    "sctnNintYn": "N",
    "pgGbCd": "10",
    "pgGbNm": "이니시스",
    "monthList": [
      {
        "tgtAmt": 1000000,
        "nint1MonYn": "N",
        "nint2MonYn": "N",
        "nint3MonYn": "N",
        "nint4MonYn": "N",
        "nint5MonYn": "Y",
        "nint6MonYn": "N",
        "nint7MonYn": "N",
        "nint8MonYn": "N",
        "nint9MonYn": "N",
        "nint10MonYn": "N",
        "nint11MonYn": "N",
        "nint12MonYn": "N"
      }
    ]
  }
]

Search MID for Account Verification

get

Function Description

• API that retrieves the dedicated MID for account verification.

---

Detailed Description

• Retrieves the MID for account verification.

Header parameters

AuthorizationanyOptional

Access Token

Responses

200

Success

*/*

StringOptionalExample: TESTMID

900

Business processing error details

*/*

get/v1/payment/accountCertiMid

GET /api/order/v1/payment/accountCertiMid HTTP/1.1
Host: api-order.x2bee.com/
Accept: */*

TESTMID