@nhnpayco-dev/mcp-devcenter 1.0.0

package/dist/data/guides/membership-api.md

@@ -0,0 +1,967 @@
+# ② POS, KIOSK
+
+> **원본:** https://devcenter.payco.com/guide/membership/api/pos?id=220401036
+> **카테고리:** `membership-api`
+> **포함 단계 (LNB):**
+> - ② POS, KIOSK (`/guide/membership/api/pos?id=220401036`)
+> - API 연동하기 (`/guide/membership/api/web?id=220401035`)
+
+---
+
+## API 연동하기 POS , KIOSK
+
+1. #### 데이터 포맷
+
+   JSON (JavaScript Object Notation) 은 언어 독립적인 Data Format입니다.  
+    더 많은 정보를 위해서는 [json.org](https://www.json.org/json-en.html) 사이트를 참조해 주세요.
+   - ##### Request
+
+     PAYCO가 제공하는 전문 요청 및 응답은 공인 UTF-8로 이루어집니다.  
+      전문의 모든 Request의 정보에는 아래의 Headers 값이 포함되어야 합니다.  
+      membershipTid값은 POS와 제휴사를 식별하기 위한 Unique한 Key 값으로 반드시 Headers에 포함되어야 합니다.
+
+     Headers 정보 설명 테이블
+
+     | Headers | 내용 |
+     | --- | --- |
+     | Content-Type | application/json |
+     | membershipTid | POS 멤버십 식별키 |
+   - ##### Response
+
+     Response Body의 Content-Type 또한 application/json 형태로 전달됩니다.  
+      HTTP Status가 200 / resultCode가 0일때 정상적인 응답으로 이 경우 원하는 리소스를 획득 가능합니다.
+
+     Response 정보 설명 테이블
+
+     | 파라미터 | 타입 | 설명 |
+     | --- | --- | --- |
+     | Result | object | 전문 결과에 대한 결과 Object |
+     | resultCode | integer | 전문 응답에 대한 결과코드 |
+     | Message | string | 전문의 응답 또는 에러에 대한 상세한 정보 |
+2. #### PAYCO 도메인
+
+   도메인 하위 주소는 각 API 명세를 확인하세요.
+
+   PAYCO 도메인 주소
+
+   |  |  |
+   | --- | --- |
+   | 개발환경 | https://alpha-api-pos-membership.payco.com |
+   | 운영환경 | https://api-pos-membership.payco.com |
+3. #### 연동 프로세스 이해하기 – POS(KIOSK) , 회원
+
+   ![멤버십 POS, KIOSK flow 이미지](/img/@membership_pos_kiosk_flow.8125c08c.png)
+4. #### 연동 프로세스 이해하기 - 주문
+
+   ![멤버십 POS, KIOSK flow 이미지](/img/@membership_pos_kiosk_order_flow.4fb55798.png)
+5. #### API 목록
+
+   PAYCO결제 연동에 필요한 각 API를 확인하고 개발해 주세요.
+
+   API 목록에 관한 설명 테이블
+
+   | API 명 | URL | 설명 |
+   | --- | --- | --- |
+   | POS 등록 | /terminal/register | POS 연동시, 최초 1회 실행하여 POS 정보 인증 |
+   | 회원 조회 | /member/search | 멤버십 회원 조회 |
+   | 사용가능 멤버십 조회 | /order/getMembershipInfo | 주문에서 사용가능한 멤버십 재화 응답 |
+   | 쿠폰 사용 예약 | /coupon/useReserveV3 | 쿠폰 사용 검증 및 사용 예약 |
+   | 적립 포인트 사용 예약 | /point/useReserveSavePoint | 적립포인트 사용 검증 및 사용예약 |
+   | 주문 승인 | /order/approvalV2 | 사용 예약된 건들을 승인하여 실제 사용처리 |
+   | 주문 완료 | /order/complete | 주문 상품 정보 전달 및 포인트 적립 처리 |
+   | 주문 취소 | /order/cancel | 주문 취소 및 사용된 멤버십재화 취소 처리 |
+
+   **잠깐만요!**
+
+   쿠폰 및 포인트 모두 사용 하는 경우라면 , 포인트 사용 예약 이전 쿠폰 사용 예약 호출이 먼저 필요합니다.
+
+   - ##### POS 등록
+
+     POS 단말기를 등록합니다. POS 단말기 등록 전 멤버십 관리자 센터에 가맹점 관련 단말기 정보등록이 필요합니다.
+
+     POS 등록 API 주소
+
+     |  |  |
+     | --- | --- |
+     | URL | /user/v1/search |
+     | Method | POST |
+
+     POS 등록 – RESPONSE
+
+     POS 등록 – RESPONSE 파라미터 정보
+
+     | No. | 파라미터 | 설명 |
+     | --- | --- | --- |
+     | 1 | membershipTid(필수 / string) | POS 멤버십 식별 키 |
+     | 2 | membershipPosSeq(필수 / string) | POS 일련번호 |
+     | 3 | encryptKey(string) | 본문 암호화 키  * POS 통신시 본문 암호화 처리를 하지 않는 제휴사라면 미응답 |
+     | 4 | merchantName(필수 / string) | 매장 명 |
+
+     **POS 등록 API – RESPONSE Sample 코드**
+
+     ```
+     {
+         "code": 0,
+         "message": "SUCCESS",
+         "result": {
+             "membershipTid": "Xn4HfaYsKbqfOa46",
+             "membershipPosSeq": "0001"
+         }
+     }
+     ```- ##### 회원 조회
+
+     적립 대상 및 회원정보를 조회합니다. 멤버십 카드번호(무기명카드 포함) 또는 휴대폰 번호를  
+      통해 정보를 조회합니다. 탈퇴 / 휴면 회원정보는 응답되지 않습니다.
+
+     회원 조회 API 주소
+
+     |  |  |
+     | --- | --- |
+     | URL | /member/search |
+     | Method | POST |
+
+     회원 조회 – REQUEST
+
+     회원 조회 – REQUEST 파라미터 정보
+
+     | No. | 파라미터 | 설명 |
+     | --- | --- | --- |
+     | 1 | phoneNo(필수 / string) | 휴대폰 번호 |
+     | 2 | cardNo(필수 / string) | 카드번호 |
+     | 3 | memberNo(필수 / string) | 회원번호 |
+
+     **회원 조회 API – REQUEST Sample 코드**
+
+     ```
+     {
+       "phoneNo": "01011112222",
+       "cardNo": "",
+       "memberNo": ""
+     }
+     ```회원 조회 – RESPONSE
+
+     회원 조회 – RESPONSE 파라미터 정보
+
+     | No. | 파라미터 | 설명 |
+     | --- | --- | --- |
+     | 1 | memberYn(필수 / string) | 회원가입 여부 |
+     | 2 | memberNo(string) | 회원 번호 |
+     | 3 | memberName(string) | 회원 명 |
+     | 4 | gradeName(string) | 회원 등급 명 |
+     | 5 | savePoint(필수 / string) | 적립포인트 잔액 |
+     | 6 | saveCount(필수 / string) | 적립 횟수 |
+     | 7 | dormantYn(필수 / string) | 휴면 여부 |
+     | 8 | nickname(string) | 닉네임 |
+
+     **회원 조회 API – RESPONSE Sample 코드**
+
+     ```
+     {
+         "code": 0,
+         "message": "SUCCESS",
+         "result": [{
+               "memberYn": "Y",
+               "memberNo": "10004004103667004",
+               "memberName": "홍길동",
+               "gradeName": "아티지엔",
+               "savePoint": 63872,
+               "saveCount": 78,
+               "dormantYn": "N"
+           },
+           {
+               "memberYn": "Y",
+               "memberNo": "10006000822929003",
+               "memberName": "김김김",
+               "gradeName": "바니",
+               "savePoint": 0,
+               "saveCount": 0,
+               "dormantYn": "N"
+           }
+         ]
+     }
+     ```- ##### 사용가능 멤버십 조회
+
+     오프라인 주문 시 회원 별 사용가능한 멤버십 재화 ( 쿠폰 , 포인트 , 충전금 )를 조회합니다.  
+      사용가능 여부를 응답합니다.
+
+     회원 조회 API 주소
+
+     |  |  |
+     | --- | --- |
+     | URL | /order/getMembershipInfo |
+     | Method | POST |
+
+     사용가능 멤버십 조회 – REQUEST
+
+     사용가능 멤버십 조회 – REQUEST 파라미터 정보
+
+     | No. | 파라미터 | 설명 |
+     | --- | --- | --- |
+     | 1 | memberNo(필수 / string) | 회원번호 |
+     | 2 | orderAmount(필수 / integer) | 총 주문 금액 |
+     | 3 | accountTypeCode(string) | 조회대상 재화 타입 코드  ALL : 전체 ( Default ) / COUPON : 쿠폰 / POINT : 충전, 적립 포인트 |
+     | 4 | orderProducts(Array<string>) | 주문 상품 리스트 |
+
+     orderProducts 상세
+
+     orderProducts 상세 파라미터 정보
+
+     | No. | 파라미터 | 설명 |
+     | --- | --- | --- |
+     | 1 | productClassCd(필수 / string) | 상품분류 코드 |
+     | 2 | productCd(필수 / string) | 상품 코드 |
+     | 3 | targetUnitPrice(필수 / number) | 할인 / 적립 대상단가  * 멤버십과 무관한 자체 할인 등의 금액을 제외한 실제 멤버십을 위한 금액 전달이 필요합니다. |
+     | 4 | unitPrice(필수 / number) | 단가 – 실 상품결제 금액 |
+     | 5 | productCount(필수 / integer) | 수량 |
+
+     **사용가능 멤버십 조회 API – REQUEST Sample 코드**
+
+     ```
+     {
+       "memberNo" : "10001004161547003",
+       "orderProducts" : [{
+         "productClassCd" : "151100000213",
+         "productCd" : "00090",
+         "targetUnitPrice" : 1000,
+         "unitPrice" : 1000,
+         "productCount" : 6
+       }],
+       "orderAmount" : 6000,
+       "accountTypeCode" : "ALL"
+     }
+     ```사용가능 멤버십 조회 API – RESPONSE
+
+     사용가능 멤버십 조회 API – RESPONSE 파라미터 정보
+
+     | No. | 파라미터 | 설명 |
+     | --- | --- | --- |
+     | 1 | memberNo(필수 / string) | 회원번호 |
+     | 2 | memberName(필수 / string) | 회원 명 |
+     | 3 | phoneNo(string) | 휴대폰 번호 |
+     | 4 | couponList(Array<string>) | 보유 쿠폰 리스트 |
+     | 5 | pointList(Array<string>) | 보유 적립 / 충전 포인트 리스트 |
+
+     couponList 상세
+
+     couponList 상세 파라미터 정보
+
+     | No. | 파라미터 | 설명 |
+     | --- | --- | --- |
+     | 1 | couponNo(필수 / string) | 쿠폰 번호 |
+     | 2 | couponId(필수 / string) | 쿠폰 ID |
+     | 3 | couponName(필수 / string) | 쿠폰 명 |
+     | 4 | validStartYmdt(필수 / string) | 유효시작일시 |
+     | 5 | validEndYmdt(필수 / string) | 유효종료일시 |
+     | 6 | useableCoupon(필수 / string) | 쿠폰사용 가능여부 |
+     | 7 | unUsableReason(string) | 쿠폰사용 불가 사유 |
+     | 8 | discountExpectAmount(integer) | 예상 할인 금액 |
+
+     pointList 상세
+
+     pointList 상세 파라미터 정보
+
+     | No. | 파라미터 | 설명 |
+     | --- | --- | --- |
+     | 1 | accountTypeCode(필수 / string) | 계좌타입코드  PAY : 충전 / SAVE : 적립 |
+     | 2 | accountTypeName(필수 / string) | 계좌타입 명  충전금 / 적립포인트 |
+     | 3 | cardNo(string) | 카드번호 |
+     | 4 | restPoint(필수 / integer) | 잔여포인트 |
+     | 5 | useMinSavePoint(필수 / integer) | 사용가능 최소 적립 포인트 |
+     | 6 | useMaxSavePoint(필수 / integer) | 사용가능 최대 적립 포인트 |
+     | 7 | useSavePointUnit(필수 / integer) | 적립포인트 사용 단위 |
+     | 8 | cardNickName(string) | 카드 닉네임 |
+
+     **사용가능 멤버십 조회 API – RESPONSE Sample 코드**
+
+     ```
+     {
+       "code": 0,
+       "message": "SUCCESS",
+       "result": {
+         "memberNo": "10001004161547003",
+         "memberName": "이현세",
+         "phoneNo": "01098765432",
+         "couponList": [{
+             "couponNo": "8355810045410504",
+             "couponId": "CP00004541",
+             "couponName": "EqualDivision",
+             "validStartYmdt": "20211201145406",
+             "validEndYmdt": "99991231235959",
+             "usableCoupon": true,
+             "discountExpectAmount": 180
+           },
+           {
+             "couponNo": "6798050045457894",
+             "couponId": "CP00004545",
+             "couponName": "증정쿠폰 조건 금액설정",
+             "validStartYmdt": "20211201145406",
+             "validEndYmdt": "99991231235959",
+             "usableCoupon": false,
+             "unUsableReason": "쿠폰 증정 상품 미포함",
+             "discountExpectAmount": 0
+           },
+           {
+             "couponNo": "8959370045475573",
+             "couponId": "CP00004547",
+             "couponName": "세트 테스트 쿠폰",
+             "validStartYmdt": "20211201145406",
+             "validEndYmdt": "20211224235959",
+             "usableCoupon": false,
+             "unUsableReason": "쿠폰 할인 적용 대상 금액 없음",
+             "discountExpectAmount": 0
+           }
+         ],
+         "pointList": [{
+             "accountTypeCode": "PAY",
+             "accountTypeName": "충전포인트",
+             "cardNo": "778100011000070455",
+             "restPoint": 110000
+           },
+           {
+             "accountTypeCode": "PAY",
+             "accountTypeName": "충전포인트",
+             "cardNo": "777100014590562847",
+             "restPoint": 20000
+           },
+           {
+             "accountTypeCode": "SAVE",
+             "accountTypeName": "적립포인트",
+             "cardNo": "",
+             "restPoint": 0
+           }
+         ]
+       }
+     }
+     ```- ##### 쿠폰 사용 예약
+
+     주문에 사용할 쿠폰을 예약합니다. 사용 예약단계로 실제로 사용된 것은 아니며, 제휴사 별 쿠폰 특징 및 설정 값에 맞게 응답됩니다.
+
+     쿠폰 사용 예약 API 주소
+
+     |  |  |
+     | --- | --- |
+     | URL | /coupon/useReserveV3 |
+     | Method | POST |
+
+     쿠폰 사용 예약 – REQUEST
+
+     쿠폰 사용 예약 – REQUEST 파라미터 정보
+
+     | No. | 파라미터 | 설명 |
+     | --- | --- | --- |
+     | 1 | couponNo(필수 / string) | 쿠폰번호 |
+     | 2 | memberNo(string) | 회원번호 |
+     | 3 | posOrderNo(string) | POS 주문번호 |
+     | 4 | membershipReserveNo(string) | 멤버십 예약번호 |
+     | 5 | orderProducts(Array<string>) | 주문 상품 |
+
+     orderProducts 상세
+
+     orderProducts 상세 파라미터 정보
+
+     | No. | 파라미터 | 설명 |
+     | --- | --- | --- |
+     | 1 | productClassCd(필수 / string) | 상품분류 코드 |
+     | 2 | productCd(필수 / string) | 상품 코드 |
+     | 3 | targetUnitPrice(필수 / number) | 할인 / 적립 대상단가  * 멤버십과 무관한 자체 할인 등의 금액을 제외한 실제 멤버십을 위한 금액 전달이 필요합니다. |
+     | 4 | unitPrice(필수 / number) | 단가 – 실 상품결제 금액 |
+     | 5 | productCount(필수 / integer) | 수량 |
+
+     **사용가능 멤버십 조회 API – REQUEST Sample 코드**
+
+     ```
+     {
+       "couponNo": "5002605000000019",
+       "posOrderNo": "2019093011111",
+       "orderProducts": [{
+           "productCd": "1003",
+           "productClassCd": "10",
+           "productCount": "1",
+           "targetUnitPrice": "10000",
+           "unitPrice": "10000",
+           "productNm": "자장면"
+         },
+         {
+           "productCd": "1007",
+           "productClassCd": "20",
+           "productCount": "1",
+           "targetUnitPrice": "0",
+           "unitPrice": "10000",
+           "productNm": "라조기"
+         }
+
+       ],
+       "memberNo": "10006004205055003"
+     }
+     ```쿠폰 사용 예약 API – RESPONSE
+
+     쿠폰 사용 예약 API – RESPONSE 파라미터 정보
+
+     | No. | 파라미터 | 설명 |
+     | --- | --- | --- |
+     | 1 | membershipReserveNo(필수 / string) | 멤버십 예약번호 |
+     | 2 | memberNo(string) | 회원번호 |
+     | 3 | memberName(string) | 회원명 |
+     | 4 | gradeName(string) | 회원 등급 명 |
+     | 5 | couponName(필수 / string) | 쿠폰 명 |
+     | 6 | couponType(필수 / string) | 쿠폰 구분 코드 |
+     | 7 | savePoint(number) | 적립 예정 금액 |
+     | 8 | totalDiscountAmount(number) | 총 할인 금액 |
+     | 9 | conditionOrderAmount(number) | 사용 필요 주문 금액 |
+     | 10 | giftProducts(Array<string>) | 증정상품 |
+     | 11 | discountProducts(Array<string>) | 할인 적용 상품 |
+     | 12 | applyProducts(Array<string>) | 조건 상품 |
+     | 13 | conditionProductsAmount(number) | 사용 필요 적용상품 금액 |
+     | 14 | eachApplicationYn(string) | 개별적용 여부 |
+
+     giftProductList 상세
+
+     giftProductList 상세 파라미터 정보
+
+     | No. | 파라미터 | 설명 |
+     | --- | --- | --- |
+     | 1 | productClassCode(string) | 증정상품 분류코드 |
+     | 2 | productClassName(string) | 증정상품 분류명 |
+     | 3 | productCode(string) | 증정상품 코드 |
+     | 4 | productName(string) | 증정상품 명 |
+
+     discountProducts 상세
+
+     discountProducts 상세 파라미터 정보
+
+     | No. | 파라미터 | 설명 |
+     | --- | --- | --- |
+     | 1 | productClassCd(string) | 할인상품분류 코드 |
+     | 2 | productCd(string) | 할인상품 코드 |
+     | 3 | discountAmount(string) | 혜택 금액 |
+
+     applyProducts 상세
+
+     applyProducts 상세 파라미터 정보
+
+     | No. | 파라미터 | 설명 |
+     | --- | --- | --- |
+     | 1 | productClassCode(string) | 적용상품 분류코드 |
+     | 2 | productClassName(string) | 적용상품 분류명 |
+     | 3 | productCode(string) | 적용상품 코드 |
+     | 4 | productName(string) | 적용상품 명 |
+
+     **쿠폰 사용 예약 API – RESPONSE Sample 코드**
+
+     ```
+     {
+       "code": 0,
+       "message": "SUCCESS",
+       "result": {
+         "membershipReserveNo": "20190930db8d25f413561d3e4c",
+         "memberNo": "10006004205055003",
+         "memberName": "박철우",
+         "gradeName": "보니",
+         "couponName": "10퍼할인",
+         "couponType": "DISCOUNT",
+         "savePoint": 0,
+         "totalDiscountAmount": 1000,
+         "discountProducts": [{
+             "productClassCd": "10",
+             "productCd": "1003",
+             "discountAmount": 1000
+           },
+           {
+             "productClassCd": "20",
+             "productCd": "1007",
+             "discountAmount": 0
+           }
+         ],
+         "giftProducts": [],
+         "applyProducts": [],
+         "conditionProductsAmount": 0
+       }
+     }
+     ```- ##### 적립포인트 사용 예약
+
+     적립포인트 사용 예약을 합니다. 포인트 사용은 멤버십 카드 번호로만 가능하며, 사용 예약으로 실제 적립포인트가 차감되지 않습니다.
+
+     적립포인트 사용 예약 API 주소
+
+     |  |  |
+     | --- | --- |
+     | URL | /point/useReserveSavePoint |
+     | Method | POST |
+
+     적립포인트 사용 예약 – REQUEST
+
+     적립포인트 사용 예약 – REQUEST 파라미터 정보
+
+     | No. | 파라미터 | 설명 |
+     | --- | --- | --- |
+     | 1 | cardNo(필수 / string) | 카드번호 |
+     | 2 | memberNo(string) | 회원번호 |
+     | 3 | posOrderNo(string) | POS 주문번호 |
+     | 4 | membershipReserveNo(string) | 멤버십 예약번호 |
+     | 5 | pointUseKey(string) | 적립포인트 사용확인번호 |
+     | 6 | usePoint(number) | 사용 적립 포인트 |
+     | 7 | orderProducts(Array<string>) | 주문 상품 |
+
+     orderProducts 상세
+
+     orderProducts 상세
+
+     | No. | 파라미터 | 설명 |
+     | --- | --- | --- |
+     | 1 | productClassCd(필수 / string) | 상품분류 코드 |
+     | 2 | productCd(필수 / string) | 상품 코드 |
+     | 3 | targetUnitPrice(필수 / number) | 할인 / 적립 대상단가  * 멤버십과 무관한 자체 할인 등의 금액을 제외한 실제 멤버십을 위한 금액 전달이 필요합니다. |
+     | 4 | unitPrice(필수 / number) | 단가 – 실 상품결제 금액 |
+     | 5 | productCount(필수 / integer) | 수량 |
+
+     **적립포인트 사용 예약 API – REQUEST Sample 코드**
+
+     ```
+     {
+         "cardNo": "777100036616196140",
+         "usePoint": "150",
+         "posOrderNo": "20180509-01-123822",
+         "orderProducts": [{
+             "productCd": "P25",
+             "productClassCd": "PCC02",
+             "productClassNm": "음료류",
+             "productNm": "콜라",
+             "unitPrice": 2000,
+             "targetUnitPrice": 2000,
+             "productCount": 4
+         }, {
+             "productCd": "P15",
+             "productClassCd": "PCC01",
+             "productClassNm": "스낵류",
+             "productNm": "홈런왕",
+             "unitPrice": 2000,
+             "targetUnitPrice": 2000,
+             "productCount": 2
+         }],
+         "membershipReserveNo": "20180509949d1f64ab77bce8bb"
+     }
+     ```적립포인트 사용 예약 API – RESPONSE
+
+     적립포인트 사용 예약 API – RESPONSE
+
+     | No. | 파라미터 | 설명 |
+     | --- | --- | --- |
+     | 1 | membershipReserveNo(필수 / string) | 멤버십 예약번호 |
+     | 2 | usedSavePoint(number) | 차감 적립 포인트 |
+     | 3 | savePoint(number) | 적립 포인트 잔액 |
+
+     **적립포인트 사용 예약 API – RESPONSE Sample 코드**
+
+     ```
+     {
+       "code": 0,
+       "message": "SUCCESS",
+       "result": {
+         "membershipReserveNo": "20180509949d1f64ab77bce8bb",
+         "usedSavePoint": 150,
+         "savePoint": 298
+       }
+      }
+     ```- ##### 주문승인
+
+     멤버십 결제를 통한 승인처리 또는 멤버십 주문 거래번호를 생성합니다.  
+      멤버십 승인요청 ( 사용 멤버십 재화가 있을 경우 ) 과 멤버십 거래번호 생성  
+      ( 사용 멤버십 재화가 없을 경우)은 requestType을 통해서 구분합니다.
+
+     주문승인 API 주소
+
+     |  |  |
+     | --- | --- |
+     | URL | /order/approvalV2 |
+     | Method | POST |
+
+     주문 승인 – REQUEST
+
+     주문 승인 – REQUEST 파라미터 정보
+
+     | No. | 파라미터 | 설명 |
+     | --- | --- | --- |
+     | 1 | requestType(필수 / string) | 요청 구분  MAKE_ORDER : 멤버십 거래번호 생성 / APPROVAL : 멤버십 승인요청 |
+     | 2 | posOrderNo(string) | POS 주문번호 |
+     | 3 | membershipReserveNo(string) | 멤버십 예약번호 |
+     | 4 | orderProducts(Array<string>) | 주문 상품 |
+     | 5 | cashReceipt(Array<string>) | 충전금 결제가 있을 경우 충전금 결제에 대한 현금영수증 정보 |
+
+     orderProducts 상세
+
+     orderProducts 상세 파라미터 정보
+
+     | No. | 파라미터 | 설명 |
+     | --- | --- | --- |
+     | 1 | productClassCd(필수 / string) | 상품분류 코드 |
+     | 2 | productClassNm(필수 / string) | 상품분류 명 |
+     | 3 | productCd(필수 / string) | 상품 코드 |
+     | 4 | productNm(필수 / string) | 상품명 |
+     | 5 | targetUnitPrice(필수 / integer) | 할인 / 적립을 위한 대상 금액  * 멤버십과 무관한 자체 할인 등의 금액을 제외한 실제 멤버십을 위한 금액 전달이 필요합니다 |
+     | 6 | unitPrice(필수 / integer) | 상품 단가 – 실 상품결제금액 |
+     | 7 | productCount(필수 / integer) | 상품주문 수량 |
+
+     cashReceipt 상세
+
+     cashReceipt 상세 파라미터 정보
+
+     | No. | 파라미터 | 설명 |
+     | --- | --- | --- |
+     | 1 | cashReceiptNoTypeCode(필수 / string) | 현금영수증 구분  개인소득공제용 : 0 / 사업자지출증빙용 : 1 |
+     | 2 | cashReceiptNo(필수 / integer) | 현금영수증 발급번호  개인소득공제용 : 휴대폰 번호 / 사업자지출증빙용 : 사업자번호 |
+
+     **주문 승인 API – REQUEST Sample 코드**
+
+     ```
+     {
+         "requestType": "APPROVAL",
+         "posOrderNo": "20211130009",
+         "membershipReserveNo": "20211130209756fd83a303eed8",
+         "orderProducts": [{
+               "productClassCd": "A",
+               "productCd": "a1",
+               "productClassNm": "커피",
+               "productNm": "아이스라떼",
+               "targetUnitPrice": 10000,
+               "unitPrice": 10000,
+               "productCount": 1
+           },
+           {
+               "productClassCd": "A",
+               "productCd": "a2",
+               "productClassNm": "커피",
+               "productNm": "아이스초코",
+               "targetUnitPrice": 10000,
+               "unitPrice": 10000,
+               "productCount": 1
+           }
+         ],
+         "cashReceipt": {
+             "cashReceiptNoTypeCode": "0",
+             "cashReceiptNo": "01099999999"
+         }
+     }
+     ```주문 승인 API – RESPONSE
+
+     주문 승인 API – RESPONSE 파라미터 정보
+
+     | No. | 파라미터 | 설명 |
+     | --- | --- | --- |
+     | 1 | membershipReserveNo(필수 / string) | 멤버십 예약번호 |
+     | 2 | savePointUseApprovalNo(number) | 적립포인트 사용 승인번호 |
+     | 3 | usedSavePoint(number) | 사용적립포인트 |
+     | 4 | couponType(string) | 쿠폰구분 코드  DISCOUNT , SAVE , PRODUCT |
+     | 5 | couponName(string) | 사용한 쿠폰 명 |
+     | 6 | couponId(string) | 사용한 쿠폰 ID |
+     | 7 | couponNo(string) | 사용한 쿠폰번호 |
+     | 8 | couponApprovalNo(string) | 쿠폰사용 승인번호 |
+     | 9 | dueSavePoint(number) | 적립예정 금액 |
+     | 10 | totalDiscountAmount(number) | 총 할인금액 |
+     | 11 | discountProducts(Array<string>) | 할인적용 상품 |
+     | 12 | payPointUseInfos(Array<string>) | 충전포인트 사용 결과 |
+
+     discountProducts 상세
+
+     discountProducts 상세 파라미터 정보
+
+     | No. | 파라미터 | 설명 |
+     | --- | --- | --- |
+     | 1 | productClassCode(string) | 상품분류 코드 |
+     | 2 | productCode(string) | 상품 코드 |
+     | 3 | discountAmount(integer) | 할인 적용 금액 |
+
+     payPointUseInfos 상세
+
+     payPointUseInfos 상세 파라미터 정보
+
+     | No. | 파라미터 | 설명 |
+     | --- | --- | --- |
+     | 1 | cardNo(string) | 카드번호 |
+     | 2 | payPointUseApprovalNo(string) | 충전포인트 사용 승인번호 |
+     | 3 | usedPayPoint(number) | 사용 충전 포인트 |
+     | 4 | restPayPoint(number) | 차감 후 충전포인트 잔액 |
+     | 5 | cashReceipt(Array<string>) | 충전금에 대한 현금영수증 정보 |
+
+     cashReceipt 상세
+
+     cashReceipt 상세 파라미터 정보
+
+     | No. | 파라미터 | 설명 |
+     | --- | --- | --- |
+     | 1 | cashReceiptNoTypeCode(필수 / string) | 현금영수증 구분  개인소득공제용 : 0 / 사업자지출증빙용 : 1 |
+     | 2 | cashReceiptNo(필수 / integer) | 현금영수증 발급번호  개인소득공제용 : 휴대폰 번호 / 사업자지출증빙용 : 사업자번호 |
+     | 3 | approvalAmt(integer) | 현금영수증 금액 |
+
+     **주문 승인 API – RESPONSE Sample 코드**
+
+     ```
+     {
+       "code": 0,
+       "message": "SUCCESS",
+       "result": {
+         "membershipOrderNo": "2021113000329234",
+         "usedSavePoint": 0,
+         "dueSavePoint": 0,
+         "totalDiscountAmount": 0,
+         "discountProducts": [],
+         "payPointUseInfos": [{
+           "cardNo": "777100284120502657",
+           "payPointUseApprovalNo": "2021113000242907",
+           "usedPayPoint": 20000,
+           "restPayPoint": 60000,
+           "cashReceipt": {
+             "cashReceiptNoTypeCode": "0",
+             "cashReceiptNo": "01099999999",
+             "approvalAmt": 20000
+           }
+         }]
+       }
+     }
+     ```- ##### 주문완료
+
+     외부 결제들에 대한 적립처리와 결제 정보를 전달합니다.  
+      주문 완료 전 회원 또는 카드 조회를 통해 적립대상의 유효성 체크가 필요합니다
+
+     주문승인 API 주소
+
+     |  |  |
+     | --- | --- |
+     | URL | /order/complete |
+     | Method | POST |
+
+     주문 완료 – REQUEST
+
+     주문 완료 – REQUEST 파라미터 정보
+
+     | No. | 파라미터 | 설명 |
+     | --- | --- | --- |
+     | 1 | memberNo(string) | 회원번호 |
+     | 2 | cardNo(string) | 카드번호 |
+     | 3 | phoneNo(string) | 휴대폰 번호 |
+     | 4 | membershipOrderNo(필수 / string) | 멤버십 거래주문 번호 |
+     | 5 | posOrderNo(필수 / string) | POS 주문 번호 |
+     | 6 | saveYn(string) | 포인트 적립여부 |
+     | 7 | orderStampSaveYn(string) | 스탬프 적립 여부 |
+     | 8 | afterSaveYn(string) | 추후적립 여부 |
+     | 9 | mediaType(필수 / string) | 적립매체 구분  CARD : 카드 / PHONE : 휴대폰 / AUTO_SAVE : 자동적립 / NONE : 비회원 주문 |
+     | 10 | mediaNo(string) | 적립매체 번호 |
+     | 11 | outerPayMethods(Array<string>) | 외부결제 수단 |
+     | 12 | orderProducts(Array<string>) | 상품 정보 |
+
+     outerPayMethods
+
+     outerPayMethods 파라미터 정보
+
+     | No. | 파라미터 | 설명 |
+     | --- | --- | --- |
+     | 1 | code(string) | [외부결제 수단 코드](/guide/membership/code/start?id=220401037) |
+     | 2 | payAmount(number) | 결제 금액 |
+     | 3 | approvalNo(string) | 승인번호 |
+
+     orderProducts 상세
+
+     orderProducts 상세 파라미터 정보
+
+     | No. | 파라미터 | 설명 |
+     | --- | --- | --- |
+     | 1 | productClassCd(필수 / string) | 상품분류 코드 |
+     | 2 | productClassNm(필수 / string) | 상품분류 명 |
+     | 3 | productCd(필수 / string) | 상품 코드 |
+     | 4 | productNm(필수 / string) | 상품명 |
+     | 5 | targetUnitPrice(필수 / integer) | 할인 / 적립을 위한 대상 금액  * 멤버십과 무관한 자체 할인 등의 금액을 제외한 실제 멤버십을 위한 금액 전달이 필요합니다. |
+     | 6 | unitPrice(필수 / integer) | 상품 단가 – 실 상품결제금액 |
+     | 7 | productCount(필수 / integer) | 상품주문 수량 |
+     | 8 | stampSaveYn(필수 / string) | 스탬프 적립 여부 |
+
+     **주문 완료 API – REQUEST Sample 코드**
+
+     ```
+     {
+       "cardNo": "",
+       "memberNo": "10004004103667004",
+       "membershipOrderNo": "2019082700255312 ",
+       "posOrderNo": "20190222-01",
+       "saveYn": "Y",
+       "afterSaveYn": "N",
+       "mediaType": "PHONE",
+       "mediaNo": "",
+       "outerPayMethods": [{
+         "code": "21",
+         "payAmount": 20000
+       }],
+       "orderProducts": [{
+         "productClassCd": "0000",
+         "productCd": "0000002",
+         "productClassNm": "상품분류명",
+         "productNm": "상품명",
+         "productCount": 1,
+         "unitPrice": 20000,
+         "targetUnitPrice": 20000
+       }]
+     }
+     ```주문 완료 API – RESPONSE
+
+     주문 완료 API – RESPONSE 파라미터 정보
+
+     | No. | 파라미터 | 설명 |
+     | --- | --- | --- |
+     | 1 | membershipOrderNo(필수 / string) | 멤버십 주문거래 번호 |
+     | 2 | saveTargetMemberNo(string) | 적립 대상 회원번호 |
+     | 3 | saveTagetCardNo(string) | 적립대상 카드번호 |
+     | 4 | saveTargetPhoneNo(string) | 적립대상 휴대폰번호 |
+     | 5 | memberName(string) | 회원 명 |
+     | 6 | generatedSavePoint(number) | 발생한 적립 포인트 |
+     | 7 | saveImpossibleCause(string) | 포인트 적립 불가 사유 |
+     | 8 | stampSaveImpossibleCause(string) | 스탬프 적립 불가 사유 |
+     | 9 | savePoint(number) | 적립 포인트 잔액 |
+     | 10 | saveCount(number) | 적립 횟수 |
+     | 11 | savedStamps(Array<string>) | 적립 스탬프 |
+
+     savedStamps 상세
+
+     savedStamps 상세 파라미터 정보
+
+     | No. | 파라미터 | 설명 |
+     | --- | --- | --- |
+     | 1 | stampId(string) | 스탬프 ID |
+     | 2 | stampName(string) | 스탬프 명 |
+     | 3 | generatedCount(number) | 발생한 스탬프 개수 |
+     | 4 | accumulatedCount(number) | 현재 스탬프 개수 |
+     | 5 | couponIssueYn(string) | 쿠폰 발급 여부 |
+     | 6 | stampFinishCount(number) | 1판당 스탬프 수 |
+     | 7 | rewardPointYn(string) | 보상포인트 발급 여부 |
+
+     **주문 완료 API – RESPONSE Sample 코드**
+
+     ```
+     {
+       "code": 0,
+       "message": "SUCCESS",
+       "result": {
+         "membershipOrderNo": "2019022200248126",
+         "saveTargetMemberNo": "10004004103667004",
+         "memberName": "홍길동",
+         "generatedSavePoint": 1000,
+         "savePoint": 64872,
+         "saveCount": 79,
+         "savedStamps": []
+       }
+     }
+     ```- ##### 주문취소
+
+     주문을 취소합니다. 전체 주문만 취소가 가능하며, 주문과 관련된 멤버십 재화 전체 거래를 취소합니다.
+
+     주문승인 API 주소
+
+     |  |  |
+     | --- | --- |
+     | URL | /order/cancel |
+     | Method | POST |
+
+     주문 취소 – REQUEST
+
+     주문 취소 – REQUEST 파라미터 정보
+
+     | No. | 파라미터 | 설명 |
+     | --- | --- | --- |
+     | 1 | membershipOrderNo(필수 / string) | 멤버십 거래주문 번호 |
+     | 2 | posOrderCancelNo(string) | POS 취소 주문 번호 |
+     | 3 | outerPayMethods(Array<string>) | 외부결제 수단 |
+
+     outerPayMethods 상세
+
+     outerPayMethods 상세 파라미터 정보
+
+     | No. | 파라미터 | 설명 |
+     | --- | --- | --- |
+     | 1 | code(string) | 외부결제 수단 코드 |
+     | 2 | payAmount(number) | 결제 금액 |
+     | 3 | originApprovalNo(string) | 원 승인번호 |
+     | 4 | cancelApprovalNo(string) | 취소 승인번호 |
+
+     **주문 취소 API – REQUEST Sample 코드**
+
+     ```
+     {
+       "membershipOrderNo" : "2019061800252809",
+       "posOrderCancelNo" : "20190618999999111112",
+       "outerPayMethods":[{"code":"21","payAmount":0,"approvalNo":"21361835"}]
+     }
+     ```주문 취소 API – RESPONSE
+
+     주문 취소 API – RESPONSE 파라미터 정보
+
+     | No. | 파라미터 | 설명 |
+     | --- | --- | --- |
+     | 1 | cancelMembershipOrderNo(string) | 멤버십 취소 주문거래번호 |
+     | 2 | cancelSavePoint(number) | 차감 적립포인트 |
+     | 3 | savePoint(number) | 적립포인트 잔액 |
+     | 4 | cancelPayMethods(Array<string>) | 취소 결제 수단 |
+     | 5 | cancelStamps(Array<string>) | 취소 스탬프 |
+     | 6 | cashReceiptList(Array<string>) | 충전금에 대한 현금영수증 정보 |
+
+     savedStamps 상세
+
+     savedStamps 상세 파라미터 정보
+
+     | No. | 파라미터 | 설명 |
+     | --- | --- | --- |
+     | 1 | code(필수 / string) | 결제수단 코드 |
+     | 2 | Name(필수 / string) | 결제수단 명 |
+     | 3 | payInfo(string) | 매체 정보 |
+     | 4 | cancelAmount(number) | 취소 금액 |
+     | 5 | restPoint(number) | 취소 후 충전금 잔액 |
+     | 6 | originApprovalNo(string) | 원 승인번호 |
+     | 7 | cancelApproveNo(string) | 취소 승인번호 |
+
+     cancelStamps 상세
+
+     cancelStamps 상세 파라미터 정보
+
+     | No. | 파라미터 | 설명 |
+     | --- | --- | --- |
+     | 1 | stampName(string) | 스탬프 명 |
+     | 2 | cancelCount(number) | 취소 스탬프 개수 |
+     | 3 | accumulatedCount(number) | 현재 스탬프 개수 |
+     | 4 | stampFinishCount(number) | 1판당 스탬프 수 |
+     | 5 | couponIssueCancelYn(string) | 쿠폰발급 취소여부 |
+     | 6 | rewardPointCancelYn(string) | 보상포인트 발급 여부 |
+
+     cashReceiptList 상세
+
+     cashReceiptList 상세 파라미터 정보
+
+     | No. | 파라미터 | 설명 |
+     | --- | --- | --- |
+     | 1 | cashReceiptNoTypeCode(필수 / string) | 현금영수증 구분  개인소득공제용 : 0 / 사업자지출증빙용 : 1 |
+     | 2 | cashReceiptNo(필수 / string) | 현금영수증 발급 번호  개인소득공제용 : 휴대폰 번호 / 사업자지출증빙용 : 사업자번호 |
+     | 3 | approvalAmt(필수 / number) | 현금영수증 금액 |
+
+     **주문 취소 API – RESPONSE Sample 코드**
+
+     ```
+     {
+       "code": 0,
+       "message": "SUCCESS",
+       "result": {
+         "cancelMembershipOrderNo": "2021112500329115",
+         "cancelSavePoint": 0,
+         "savePoint": 0,
+         "cancelPayMethods": [{
+           "code": "11",
+           "name": "충전포인트 사용",
+           "payInfo": "777100284449487481",
+           "cancelAmount": 20000,
+           "restPoint": 53000,
+           "originApproveNo": "2021112500242629",
+           "cancelApproveNo": "2021112500242630"
+         }],
+         "cancelStamps": [],
+         "cashReceiptList": [{
+           "cashReceiptNoTypeCode": "0",
+           "cashReceiptNo": "01099999999",
+           "approvalAmt": 20000
+         }]
+       }
+     }
+     ```