@portone/mcp-server 0.13.0

package/assets/docs/opi/ko/integration/pg/v1/settle/readme.md

@@ -0,0 +1,185 @@
+---
+title: 헥토파이낸셜
+description: 헥토파이낸셜 결제 연동 방법을 안내합니다.
+targetVersions:
+  - v1
+---
+
+## 1. 헥토파이낸셜 채널 설정하기
+
+[결제대행사 채널 설정하기](https://developers.portone.io/opi/ko/integration/ready/readme#3-결제대행사-채널-설정하기) 페이지의 내용을 참고하여 채널 설정을 진행합니다.
+
+(관련 이미지 첨부)
+
+## 2.결제 요청하기
+
+[JavaScript SDK](https://developers.portone.io/sdk/ko/v1-sdk/javascript-sdk-old/readme) `IMP.request_pay(param, callback)`을
+호출하여 헥토파이낸셜 결제창을 호출할 수 있습니다. **결제결과**는 PC의 경우 `IMP.request_pay(param, callback)`
+호출 후 **`callback`** 으로 수신되며
+모바일의 경우 **`m_redirect_url`** 로 리디렉션됩니다.
+
+<div class="tabs-container">
+
+<div class="tabs-content" data-title="인증결제창 요청">
+
+```ts title="Javascript SDK"
+IMP.request_pay(
+  {
+    channelKey: "{콘솔 내 연동 정보의 채널키}",
+    pay_method: "card",
+    merchant_uid: "order_no_0001", // 상점에서 생성한 고유 주문번호
+    name: "주문명:결제테스트",
+    amount: 1004,
+    buyer_email: "test@portone.io",
+    buyer_name: "구매자이름",
+    buyer_tel: "010-1234-5678", // 누락시 오류 발생
+    buyer_addr: "서울특별시 강남구 삼성동",
+    company: "포트원", // 가상계좌 발급시 권고사항
+    buyer_postcode: "123-456",
+    m_redirect_url: "{모바일에서 결제 완료 후 리디렉션 될 URL}",
+  },
+  function (rsp) {
+    // callback 로직
+    /* ...중략... */
+  },
+);
+```
+
+**주요 파라미터 설명**
+
+- channelKey: string
+
+  **채널키**
+
+  결제를 진행할 채널을 지정합니다.
+
+  포트원 콘솔 내 \[결제 연동] - \[연동 정보] - \[채널 관리] 에서 확인 가능합니다.
+
+  (최신 JavaScript SDK 버전부터 사용 가능합니다.)
+
+- pg(deprecated)?: string
+
+  **PG사 구분코드**
+
+  `settle` 로 지정하면 됩니다.
+
+  <div class="hint" data-style="warning">
+
+  `pg` 파라미터는 지원 중단 예정입니다.
+
+  JS SDK를 가장 최신 버전으로 업그레이드 후 `channelKey` 파라미터로 채널 설정(PG사 구분)을 대체해주세요.
+
+  </div>
+
+- pay\_method: string
+
+  **결제수단 구분코드**
+
+  - card (신용카드)
+  - trans (실시간 계좌이체)
+  - vbank(가상계좌)
+  - phone (휴대폰소액결제)
+
+- merchant\_uid: string
+
+  **고객사 고유주문번호**
+
+  매번 고유하게 채번되어야 합니다.
+
+- buyer\_tel: string
+
+  **구매자 연락처**
+
+  필수 파라미터 입니다.
+
+- amount: number
+
+  **결제금액**
+
+  **string** 이 아닌점에 유의하세요
+
+- name?: string
+
+  **상품명**
+
+  **휴대폰** 결제 요청인 경우 필수 파라미터
+
+- company?: string
+
+  **회사명**
+
+  **휴대폰, 가상계좌** 결제 요청인 경우 필수 파라미터
+
+- company\_en?: string
+
+  **회사명(영문)**
+
+  **휴대폰** 결제 요청인 경우 필수 파라미터
+
+</div>
+
+<div class="tabs-content" data-title="비인증 결제창 요청">
+
+**세틀뱅크는 비 인증 결제창을 지원하지 않습니다.**
+
+</div>
+
+<div class="tabs-content" data-title="비인증 API  결제요청">
+
+**API 방식으로 결제요청,예약결제를 구현할수 있습니다.**
+
+**일회성 결제 요청하기**
+
+REST [**API POST /subscribe/payments/onetime**](https://developers.portone.io/api/rest-v1/nonAuthPayment?v=v1#post%20%2Fsubscribe%2Fpayments%2Fonetime)을 호출하여 일회성 결제를 요청합니다. 요청 시 전달된 카드는 포트원에 등록되지 않습니다.
+
+```sh
+curl -H "Content-Type: application/json" \
+     -X POST -d '{"merchant_uid":"order_id_8237352", "card_number":"1234-1234-1234-1234", "expiry":"2019-01", "birth":"123456", "amount":3000}' \
+     https://api.iamport.kr/subscribe/payments/onetime
+```
+
+**빌링키 발급 요청하기**
+
+REST [**API POST /subscribe/customers/{customer\_uid}**](https://developers.portone.io/api/rest-v1/billingkey?v=v1#post%20%2Fsubscribe%2Fcustomers%2F%7Bcustomer_uid%7D)를 호출하여 빌링키 발급을 요청합니다.
+
+```sh
+curl -H "Content-Type: application/json" \
+     -X POST -d '{"card_number":"1234-1234-1234-1234", "expiry":"2025-12", "birth":"820213", "pwd_2digit":"00"}' \
+     https://api.iamport.kr/subscribe/customers/your-customer-unique-id
+```
+
+<div class="hint" data-style="info">
+
+**세틀뱅크** [**빌링키 단독 발급 API**](https://developers.portone.io/api/rest-v1/billingkey?v=v1#post%20%2Fsubscribe%2Fcustomers%2F%7Bcustomer_uid%7D)**는 별도 계약 후 사용가능합니다..**
+
+</div>
+
+**빌링키 발급 및 최초 결제 요청하기**
+
+REST [**API POST /subscribe/payments/onetime**](https://developers.portone.io/api/rest-v1/nonAuthPayment?v=v1#post%20%2Fsubscribe%2Fpayments%2Fonetime)을 호출하여 빌링키 발급과 최초 결제를 요청합니다.
+
+- **`customer_uid`** : 빌링키 등록을 위해서 지정해야 합니다.
+
+```sh
+curl -H "Content-Type: application/json" \
+     -X POST -d '{"customer_uid":"your-customer-unique-id", "merchant_uid":"order_id_8237352", "card_number":"1234-1234-1234-1234", "expiry":"2019-01", "birth":"123456", "amount":3000}' \
+     https://api.iamport.kr/subscribe/payments/onetime
+```
+
+**빌링키로 결제 요청하기**
+
+빌링키 발급과 최초 결제가 성공하면 빌링키는 전달된 `customer_uid` 와 1:1 매칭되어 포트원에 저장됩니다. 보안상의 이유로 서버는 빌링키에 직접 접근할 수 없기 때문에 `customer_uid`를 이용해서 재결제([**POST /subscribe/payments/again**](https://developers.portone.io/api/rest-v1/nonAuthPayment?v=v1#post%20%2Fsubscribe%2Fpayments%2Fagain)) REST API를 다음과 같이 호출합니다.
+
+```sh
+curl -H "Content-Type: application/json" \
+     -X POST -d '{"customer_uid":"your-customer-unique-id", "merchant_uid":"order_id_8237352", "amount":3000}' \
+     https://api.iamport.kr/subscribe/payments/again
+```
+
+**자세한 비 인증 결제 가이드는 아래 링크를 참조하세요**
+
+[비인증결제 연동하기](https://developers.portone.io/opi/ko/integration/start/v1/non-auth)
+
+</div>
+
+</div>

package/assets/docs/opi/ko/integration/pg/v1/smartro-v2/api.md

@@ -0,0 +1,197 @@
+---
+title: API 연동
+description: 스마트로 API 연동 방법을 안내합니다.
+targetVersions:
+  - v1
+---
+
+## 지원 기능
+
+- 빌링키 결제
+- 예약 결제
+- 에스크로 등록, 조회
+- 가상계좌 발급 ,회수
+- 결제건 환불
+- 현금영수증 발급, 조회, 취소
+- 외부 결제건 현금영수증 발급, 조회, 취소
+
+## 추가된 파라미터
+
+### `product_count` 파라미터 추가
+
+- 결제 상품의 개수를 설정하는 파라미터 `product_count` 가 추가되었습니다. 설정을 하지 않을 경우 디폴트로 1개가 설정됩니다.
+
+- 사용가능한 API
+  - 빌링키 결제 API, 예약결제 API, 가상계좌 발급 API
+
+### `formed_address` 파라미터 추가
+
+에스크로 배송 정보 등록시 지번주소/도로명 주소 와 상세주소를 입력받는 파라미터 `formed_address`가 추가되었습니다.
+스마트로의 경우 기존 파라미터인 `addr`가 아닌 해당 파라미터를 이용한 주소 설정이 필요합니다.
+
+```json
+{
+  "formed_address": {
+    "address_line_1": "지번주소 또는 도로명주소(스마트로 신모듈의 경우 필수)",
+    "address_line_2": "상세주소(스마트로 신모듈의 경우 필수)"
+  }
+}
+```
+
+## API 별 상세 설명
+
+### 빌링키 결제
+
+- 요청 URL: `https://api.iamport.kr/subscribe/again`
+
+- 요청 메소드: `POST`
+
+- **스마트로 필수 파라미터**
+  - `customer_uid`
+  - `merchant_uid`
+  - `amount`
+  - `buyer_name`
+  - `buyer_email`
+  - `buyer_tel`
+
+- 주의사항
+  - `smartro_v2`는 `merchant_uid` 파라미터에 특수문자 포함이 불가능합니다.
+
+### 예약 결제
+
+- 요청 URL: `https://api.iamport.kr/subscribe/schedule`
+
+- 요청 메소드: `POST`
+
+- **스마트로 필수 파라미터**
+  - `customer_uid`
+  - `schedules.merchant_uid`
+  - `schedules.amount`
+  - `schedules.buyer_name`
+  - `schedules.buyer_email`
+  - `schedules.buyer_tel`
+
+- 주의 사항
+  - `smartro_v2`는 API 방식으로 빌링키 발급을 지원하지 않기 때문에, 예약결제시 새로운 빌링키 발급은 지원하지 않습니다.
+  - `smartro_v2`는 **`merchant_uid`** 파라미터에 특수문자 포함이 불가능합니다.
+
+### 가상계좌 발급
+
+- 요청 URL: `https://api.iamport.kr/vbanks`
+
+- 요청 메소드: `POST`
+
+- **스마트로 필수 파라미터**
+  - `merchant_uid`
+  - `amount`
+  - `vbank_code`
+  - `vbank_due`
+  - `vbank_holder`
+  - `buyer_name`
+  - `buyer_email`
+  - `buyer_tel`
+
+- 주의 사항
+  - `smartro_v2`는 **`merchant_uid`** 파라미터에 특수문자 포함이 불가능합니다.
+
+  - 계좌 발급 받거나 환불금액을 입금받을 수 있는 은행 목록과 코드는
+    [https://api.iamport.kr/#vbank\_codes](http://api.iamport.kr/#vbank_codes)에서 확인 가능합니다.
+
+### 에스크로 배송 정보 등록
+
+- 요청 URL: `https://api.iamport.kr/escrows/logis/{imp_uid}`
+
+- 요청 메소드: `POST`
+
+- **스마트로 필수 파라미터**
+  - `imp_uid`
+  - `sender.name`
+  - `sender.tel`
+  - `sender.postcode`
+  - `sender.formed_address`
+  - `receiver.name`
+  - `receiver.tel`
+  - `receiver.postcode`
+  - `receiver.formed_address`
+  - `logis.company`
+  - `logis.invoice`
+  - `logis.sent_at`
+
+- 주의 사항
+  - `smartro_v2`는 배송수정시, 지번주소/도로명주소와 상세주소를 구분하여 받고있기 때문에, 발신자의
+    주소와 수신자의 주소 정보를 기존의 `sender.addr`와 `receiver.addr` 파라미터 대신 새로 추가된
+    파라미터 **`formed_address`** 의 `address_line_1`(지번주소 또는 도로명주소)와
+    `address_line_2`(상제주소)에 설정해야 합니다.
+
+### 에스크로 배송 정보 수정
+
+- 요청 URL: `https://api.iamport.kr/escrows/logis/{imp_uid}`
+  - 요청 메소드: `PUT`
+
+- **스마트로 필수 파라미터**
+  - `imp_uid`
+  - `logis.company`
+  - `logis.invoice`
+  - `logis.sent_at`
+
+- 주의 사항
+  - `smartro_v2`는 배송 정보 수정시, 지번주소/도로명주소와 상세주소를 구분하여 받고 있기 때문에,
+    발신자의 주소와 수신자의 주소 정보를 기존의 `sender.addr`와 `receiver.addr` 파라미터 대신
+    새로 추가된 파라미터 **`formed_address`** 의 `address_line_1`(지번주소 또는 도로명주소)와
+    `address_line_2`(상세주소)에 설정해야 합니다.
+
+### 현금영수증 발급 (포트원 결제건)
+
+- 요청 URL: `https://api.iamport.kr/receipts/{imp_uid}`
+
+- 요청 메소드: `POST`
+
+- **스마트로 필수 파라미터**
+  - `imp_uid`
+  - `identifier`
+  - `type`
+  - `buyer_name`
+  - `buyer_tel`
+
+- 주의사항
+  - 스마트로 신모듈은 현금영수증 발급 API를 통해 발급받은 경우는 현금영수증을 발급 받은 거래건 취소
+    시 현금영수증 자동 발급 취소를 지원하지 않기 때문에, 따로 현금영수증 발급 취소 API를 통해
+    취소해야 합니다.
+
+### 현금영수증 발급 (외부 결제건)
+
+- 요청 URL: `https://api.iamport.kr/receipts/external/{imp_uid}`
+
+- 요청 메소드: `POST`
+
+- **스마트로 필수 파라미터**
+  - `merchant_uid`
+  - `name`
+  - `amount`
+  - `identifier`
+  - `type`
+  - `buyer_name`
+  - `buyer_tel`
+
+### 결제 취소
+
+- 요청 URL: `https://api.iamport.kr/payments/cancel`
+
+- 요청 메소드: `POST`
+
+- **스마트로 필수 파라미터**
+  - `imp_uid`
+  - `refund_holder` (가상계좌, 계좌이체 거래건)
+  - `refund_account` (가상계좌, 계좌이체 거래건)
+  - `refund_bank` (가상계좌, 계좌이체 거래건)
+  - `refund_tel` (가상계좌, 계좌이체 거래건)
+
+- 주의 사항
+  - 부분취소시 면세 금액이 포함된 경우 반드시 취소 면세금액(`tax_free`)을 포함하여 요청해야합니다.
+
+  - 가상 계좌 결제건 취소에 한해 스마트로에 취소 요청이후 즉시 환불 처리가 되는 것이 아니라,
+    스마트로에서 입력한 환불계좌로 최종 환불 처리하면 결과를 핑백(웹훅)으로 고객사에 내리면 고객사는
+    해당 핑백을 응답받은 뒤 최종 취소완료처리를 해주셔야 합니다.
+
+  - 현금영수증 미발행 가상 계좌 결제건은 스마트로에서 면세금액에 대한 검증을 따로 지원하지 않기
+    때문에, 취소시 정확한 취소 면세금액을 요청해야합니다.