결제정보

마일리지 환불 처리

post

기능 설명

• [BO전용] 환불접수 상태 마일리지 결제 취소 건들을 환불완료 처리합니다.

---

상세 설명

• 마일리지 환불 도중 에러가 발생하여 환불이 안된 결제건들을 재환불 요청하는 기능입니다.

• 결제기본테이블에 환불데이터들 중, 환불접수 상태인 건들이 대상입니다.

• 주문번호, 주문매체코드, 결제번호, 상위결제번호, 클레임번호, 환불요청금액, 결제금액, 회원번호, 결제수단코드는 필수 요청 조건입니다.

• 정상적으로 환불이 되면, 환불접수 상태가 환불완료 상태로 변경됩니다.

Header parameters

AuthorizationanyOptional

Access Token

Bodyobject[]

application/json

마일리지 환불 DTO

searchStartDtstring · dateOptional

결제일자(시작)

Example: 2023-01-01

searchEndDtstring · dateOptional

결제일자(끝)

Example: 2023-01-31

ordNostringOptional

주문번호

Example: 20230808O007404

payGbCdstring · enumOptional

OM012(결제구분코드) 10: 결제 ,20: 환불

Example: 10Possible values:

payStatCdstring · enumOptional

OM014(결제상태코드) 11: 결제대기 ,12: 결제완료 ,13: 결제취소 ,21: 환불접수 ,22: 환불완료 ,23: 환불접수취소

Example: 11Possible values:

ordMediaCdstring · enumOptional

주문매체 코드(OM007) 10 : 전화상담(CC) , 20 : PC , 30 : 모바일웹 , 40 : 안드로이드앱 , 50 : IOS앱 , 60 : 정기주문

Example: 20Possible values:

payNostringOptional

결제번호

Example: 2

uprPayNostringOptional

상위결제번호

Example: 1

ordDtlGbCdstring · enumOptional

OM003(주문내역구분코드) 10: 주문일반 , 11: 주문취소 , 20: 반품일반 , 21: 반품취소 , 30: 교환주문 , 31: 교환취소 , 40: 교환반품

Example: 10Possible values:

claimNostringOptional

클레임번호

Example: 20230801C008072

rfdAmtinteger · int64Optional

환불요청금액

Example: 1000

payAmtinteger · int64Optional

결제금액

Example: 1000

mbrNostringOptional

회원번호

Example: 100001311

payWayCdstring · enumOptional

OM013(결제수단코드) 11: 신용카드 ,12: 실시간계좌이체 ,13: 가상계좌(무통장입금) ,14: 네이버페이 ,15: 카카오페이 ,16: 페이코 ,17: 삼성페이 ,18: 애플페이 ,19: LPAY ,20: 토스페이 ,21: SSG페이 ,32: 마일리지

Example: 11Possible values:

Responses

200

OK

No content

post

/v1/payment/refundMileagePayment

HTTPcURLJavaScriptPython

POST /api/order/v1/payment/refundMileagePayment HTTP/1.1
Host: localhost:8092/
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

가맹점 정보 조회

post

기능 설명

• PG 결제를 위해 가맹점 정보를 조회합니다.

---

상세 설명

• PG 구분코드(OM030), 시스템구분코드(OM051), 가맹점기타구분코드(OM052)는 필수 파라미터입니다.

• BO admin > 결제관리 > 결제수단관리 > 가맹점관리에 등록된 가맹점을 조회합니다.

• 조회 내역이 없을 경우 PG결제가 불가능합니다.

---

수정번호

• Release v2.00_240425: 가맹점 정보 조회 사이트 검색조건 추가

Header parameters

AuthorizationanyOptional

Access Token

Body

application/json

가맹점 정보 조회 DTO

siteNostringOptional

사이트번호

Example: 1

pgGbCdstring · enumRequired

OM030(PG구분코드) 10: 이니시스(INICIS) ,20: 토스(TOSS)

Example: 10Possible values:

sysGbCdstringRequired

시스템구분코드(OM051)

Example: 20

mersEtcGbCdstringRequired

가맹점기타구분코드(OM052)

Example: 99

Responses

200

가맹점 조회 성공

*/*

가맹점 조회 DTO

mersNostringOptional

가맹점번호

Example: 1

termlIdstringOptional

터미널ID

Example: INIPayTest

pgGbCdstringOptional

PG구분코드(OM030)

Example: 10

mersEtcGbCdstringOptional

가맹점기타구분코드(OM052)

Example: 99

pointUseYnstringOptional

포인트사용여부

Example: N

nintUseYnstringOptional

무이자사용여부

Example: N

useYnstringOptional

사용여부

Example: Y

sysGbCdstringOptional

시스템구분코드(OM051)

Example: 20

900

업무처리 오류 내용

*/*

post

/v1/payment/pgMerchant

HTTPcURLJavaScriptPython

POST /api/order/v1/payment/pgMerchant HTTP/1.1
Host: localhost:8092/
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"
}

토스 빌링키 발급 요청 파라미터 생성

post

기능설명

• 빌키발급요청할 때 필요한 파라미터를 생성하는 API입니다.

---

상세설명

• timestamp, hashdata를 생성합니다.

Header parameters

AuthorizationanyOptional

Access Token

Body

application/json

토스 빌링키 발급 요청 Parameter 생성용 DTO

mbrNostringOptional

회원번호

Example: 10001234

termlIdstringOptional

터미널ID

Example: TossPayTest

Responses

200

성공

*/*

토스 빌링키 발급 요청 변환 결과 DTO

timestampstringOptional

타임스템프 [TimeInMillis(Long형)]

Example: 1697762894911

hashDatastringOptional

SHA256 Hash값(대상: mid, orderid, timestamp)

Example: 422a0e78529b419d9412d6e344c6e138584d9174c691da6cd91d4330240b9192

900

업무처리 오류 내용

*/*

post

/v1/payment/getTossAuthProperties

HTTPcURLJavaScriptPython

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

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

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

PG 정보 조회

post

기능설명

• 결제수단 코드를 이용하여 PG 정보를 조회합니다.

---

상세설명

• 결제수단 코드에 맞는 현재 결제수단 연결여부가 Y 이고, 사용여부가 Y 인 PG 정보를 조회합니다.

---

수정 번호

• Release v2.00_240627: 사이트 조건 추가하여 사이트, 결제수단 코드에 맞는 결제수단 조회

Header parameters

AuthorizationanyOptional

Access Token

Bodystring[]

application/json

string[]Optional

Responses

200

성공

*/*

pgGbCdstringOptional

payWayCdstringOptional

payWayCdNmstringOptional

900

업무처리 오류 내용

*/*

post

/v1/payment/getPgInfo

HTTPcURLJavaScriptPython

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

[
  "text"
]

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

사이트 별 사용 중인 PG 구분코드 조회

post

기능설명

• 사이트 별로 사용 중인 PG 사의 구분코드를 조회하는 API입니다.

---

상세설명

• 사이트 번호, 시스템 구분, 가맹점 기타구분 코드로 사용여부 'Y'인 PG 구분코드를 조회합니다.

Header parameters

AuthorizationanyOptional

Access Token

Body

application/json

가맹점 정보 조회 DTO

siteNostringOptional

사이트번호

Example: 1

pgGbCdstring · enumRequired

OM030(PG구분코드) 10: 이니시스(INICIS) ,20: 토스(TOSS)

Example: 10Possible values:

sysGbCdstringRequired

시스템구분코드(OM051)

Example: 20

mersEtcGbCdstringRequired

가맹점기타구분코드(OM052)

Example: 99

Responses

200

성공

*/*

stringOptional

900

업무처리 오류 내용

*/*

post

/v1/payment/getPgGbCdBySiteNo

HTTPcURLJavaScriptPython

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

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

text

결제수단 연결여부 조회

post

기능설명

• 결제수단 연결여부를 조회하는 API 입니다.

---

상세설명

• 주문/결제 > 결제수단 관리 > 결제수단 관리에서 선택한 PG사에 등록된 결제수단의 연결여부를 조회합니다.

Header parameters

AuthorizationanyOptional

Access Token

Body

application/json

결제수단 연결여부 조회 DTO

payWayCdstring · enumOptional

OM013(결제수단코드) 11: 신용카드 ,12: 실시간계좌이체 ,13: 가상계좌(무통장입금) ,14: 네이버페이 ,15: 카카오페이 ,16: 페이코 ,17: 삼성페이 ,18: 애플페이 ,19: LPAY ,20: 토스페이 ,21: SSG페이 ,32: 마일리지

Example: 11Possible values:

pgGbCdstring · enumOptional

OM030(PG구분코드) 10: 이니시스(INICIS) ,20: 토스(TOSS)

Example: 10Possible values:

Responses

200

성공

*/*

결제수단 연결여부 DTO

payWayCdstring · enumOptional

OM013(결제수단코드) 11: 신용카드 ,12: 실시간계좌이체 ,13: 가상계좌(무통장입금) ,14: 네이버페이 ,15: 카카오페이 ,16: 페이코 ,17: 삼성페이 ,18: 애플페이 ,19: LPAY ,20: 토스페이 ,21: SSG페이 ,32: 마일리지

Example: 11Possible values:

payWayNmstringOptional

결제수단명

Example: 신용카드

pgGbCdstring · enumOptional

OM030(PG구분코드) 10: 이니시스(INICIS) ,20: 토스(TOSS)

Example: 10Possible values:

linkYnstringOptional

연결여부

Example: Y

900

업무처리 오류 내용

*/*

post

/v1/payment/getPayWayLinkYn

HTTPcURLJavaScriptPython

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

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

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

결제 배분

post

기능 설명

• 결제 배분 정보를 생성합니다.

---

상세 설명

• 총 결제금액 기준으로 결제 배분 정보를 생성합니다.

• 결제 배분 포인트는 10원 단위입니다.

Header parameters

AuthorizationanyOptional

Access Token

Body

application/json

adminOrdAmtProcTypCdstringOptional

totalAmtinteger · int64Optional

crdtCardAmtinteger · int64Optional

milgAmtinteger · int64Optional

rltmActnTrsfAmtinteger · int64Optional

virActnTrsfAmtinteger · int64Optional

addPaybooleanOptional

Responses

200

성공

*/*

payDivSeqstringOptional

결제배분순번

Example: 1

ordNostringOptional

주문번호

Example: 20230809O007055

ordSeqinteger · int32Optional

주문순번

Example: 1

ordProcSeqinteger · int32Optional

주문처리순번

Example: 1

uprPayDivSeqstringOptional

상위결제배분순번

Example: 1

divGbCdstringOptional

배분구분코드(OM073)

Example: 10

adtnOcurGbCdstringOptional

부가비용발생구분코드(OM017)

Example: 10

ordCostGbCdstringOptional

주문비용구분코드(OM043)

Example: 10

deliPolcNostringOptional

배송비정책번호

Example: 10000000

entrNostringOptional

입점사번호

Example: 1000000

claimNostringOptional

클레임번호

Example: 20240812C000041

salePrcinteger · int64Optional

판매가

Example: 10000

ordQtyinteger · int32Optional

주문수량

Example: 1

cnclQtyinteger · int32Optional

취소수량

Example: 0

ordAmtinteger · int64Optional

주문금액

Example: 10000

crdtCardDivAmtinteger · int64Optional

신용카드배분금액

Example: 8000

milgDivAmtinteger · int64Optional

포인트배분금액

Example: 2000

rltmActnTrsfDivAmtinteger · int64Optional

실시간계좌이체배분금액

Example: 0

virActnTrsfDivAmtinteger · int64Optional

가상계좌이체배분금액

Example: 0

deliNostringOptional

배송번호

Example: 100000003

taxGbCdstringOptional

과면세구분코드(PR007)

Example: 01

addPayYnstringOptional

추가결제여부

Example: N

itemNmstringOptional

품목명

Example: 상품A

taxGbCdNmstringOptional

과면세구분코드(PR007)

Example: 01

occurTaxFreebooleanOptional

cancelTaxFreebooleanOptional

addPayDeliFeebooleanOptional

900

업무처리 오류 내용

*/*

post

/v1/payment/getPayDivInfo

HTTPcURLJavaScriptPython

POST /api/order/v1/payment/getPayDivInfo HTTP/1.1
Host: localhost:8092/
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
  }
]

이니시스 PC 결제요청 파라미터 생성

post

기능설명

• 이니시스 PC 결제요청할 때 필요한 파라미터를 생성하는 API입니다.

---

상세설명

• timestamp, signature, verification, mKey를 생성합니다.

Header parameters

AuthorizationanyOptional

Access Token

Body

application/json

이니시스 PC결제 인증 Parameter 생성용 DTO

ordNostringOptional

주문번호

Example: 20230101O000000

payAmtinteger · int64Optional

주문금액

Example: 10000

Responses

200

성공

*/*

이니시스 PC 결제요청 변환 결과 DTO

timestampstringOptional

타임스템프 [TimeInMillis(Long형)]

Example: 1697762894911

signaturestringOptional

SHA256 Hash값(대상: oid, price, timestamp)

Example: 422a0e78529b419d9412d6e344c6e138584d9174c691da6cd91d4330240b9192

verificationstringOptional

SHA256 Hash값(대상: oid, price, signKey, timestamp)

Example: 05c6b90795860660a8490afc659cc0bee4d5c771f2386e1cb272b90e02250bed

mkeystringOptional

900

업무처리 오류 내용

*/*

post

/v1/payment/getInicisPcAuthProperties

HTTPcURLJavaScriptPython

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

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

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

이니시스 MO 빌키발급요청 파라미터 생성

post

기능설명

• 이니시스 MO 빌키발급요청할 때 필요한 파라미터를 생성하는 API입니다.

---

상세설명

• timestamp, hashdata를 생성합니다.

Header parameters

AuthorizationanyOptional

Access Token

Body

application/json

이니시스 MO 빌키발급요청 Parameter 생성용 DTO

ordNostringOptional

주문번호

Example: 20230101O000000

termlIdstringOptional

터미널ID

Example: INIPayTest

Responses

200

성공

*/*

이니시스 MO 빌키발급요청 변환 결과 DTO

timestampstringOptional

타임스템프 [TimeInMillis(Long형)]

Example: 1697762894911

hashDatastringOptional

SHA256 Hash값(대상: mid, orderid, timestamp, INILitekey)

Example: 422a0e78529b419d9412d6e344c6e138584d9174c691da6cd91d4330240b9192

900

업무처리 오류 내용

*/*

post

/v1/payment/getInicisMoAuthProperties

HTTPcURLJavaScriptPython

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

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

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

무이자할부 안내 목록 조회

get

기능 설명

• 신용카드의 무이자할부 안내 목록을 조회합니다.

---

상세 설명

• BO의 주문/결제 > 결제수단 관리 > 무이자할부 안내 관리에서 등록한 데이터 조회

Header parameters

AuthorizationanyOptional

Access Token

Responses

200

성공

*/*

nintInstGdNostringOptional

무이자할부안내번호

Example: 242

acqrCdstringOptional

매입사코드(OM028)

Example: 121

acqrNmstringOptional

매입사명

Example: 국민카드

aplyStrDtmstringOptional

적용시작일시

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

aplyEndDtmstringOptional

적용종료일시

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

nintInstNmstringOptional

무이자할부명

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

nintAplyTgtContstringOptional

무이자적용대상내용

Example: 적용대상내용

nintExcpTgtContstringOptional

무이자제외대상내용

Example: 제외대상내용

sctnNintYnstringOptional

부분무이자여부

Example: N

pgGbCdstringOptional

pg구분코드(OM030)

Example: 10

pgGbNmstringOptional

pg사명

Example: 이니시스

900

업무처리 오류 내용

*/*

get

/v1/payment/getInterestFreeList

HTTPcURLJavaScriptPython

GET /api/order/v1/payment/getInterestFreeList HTTP/1.1
Host: localhost:8092/
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"
      }
    ]
  }
]

계좌인증용 MID 조회

get

기능설명

• 계좌인증 전용 MID를 조회하는 API입니다.

---

상세설명

• 계좌인증용 MID를 조회합니다.

Header parameters

AuthorizationanyOptional

Access Token

Responses

200

성공

*/*

StringOptionalExample: TESTMID

900

업무처리 오류 내용

*/*

get

/v1/payment/accountCertiMid

HTTPcURLJavaScriptPython

GET /api/order/v1/payment/accountCertiMid HTTP/1.1
Host: localhost:8092/
Accept: */*

TESTMID