| name | portone-guide |
| description | This skill should be used when the user asks about "포트원 연동", "PortOne integration", "결제 연동", "PG 연동", "billing key", "빌링키", "정기결제", "웹훅", "payment API", or needs guidance on implementing payment functionality with PortOne. Provides comprehensive guidance for V1 and V2 API integration. |
| version | 1.0.0 |
PortOne Integration Guide
포트원(PortOne) 결제 연동에 필요한 핵심 개념과 MCP 도구 활용법을 안내한다. 구현이 필요하면 payment-code-generator 에이전트를, 검증이 필요하면 integration-validator 에이전트를 사용한다.
Overview
포트원은 온라인 결제, 본인인증, 파트너 정산 자동화를 위한 API와 SDK를 제공하는 서비스이다. 다양한 PG사(결제대행사)를 하나의 통합 API로 연동할 수 있어 개발 복잡도를 크게 줄일 수 있다.
Critical: Do Not Trust Internal Knowledge
포트원에 대해 학습된 지식은 대부분 outdated 이거나 부정확하다. V1과 V2는 SDK 패키지명, 인증 스킴, 요청/응답 스키마가 모두 다르며 학습 데이터에는 두 버전이 자주 혼재되어 있다. PG사별 파라미터, 결제 수단 코드, 웹훅 페이로드 형식도 자주 바뀐다.
포트원 코드를 작성할 때:
- 메모리에서 코드를 쓰지 않는다. API 호출, SDK 사용법, 파라미터 이름은 반드시 MCP 도구로 확인한다.
- V2 코드는
mcp__portone__readPortoneV2FrontendCode / readPortoneV2BackendCode 로 공식 예시를 먼저 조회한다. 프레임워크/PG사/결제수단 조합별 최신 예시가 단일 출처다.
- API 스키마는
mcp__portone__readPortoneOpenapiSchema 로 확인한다. 필드명·필수 여부·타입을 추측하지 않는다.
- V1 코드는
mcp__portone__listPortoneDocs + readPortoneDoc 으로 V1 전용 문서를 조회한다. V2 패턴을 V1에 적용하지 않는다.
- V2 API 인증은
PortOne 스킴이 우선이다 (Authorization: PortOne <secret>). Bearer는 호환용일 뿐, 학습 데이터의 Bearer 예시를 그대로 따르지 않는다.
- 빌링키·웹훅·본인인증 등 부가 흐름도 매번 문서/스키마를 조회한다. 메모리상의 옛 필드명(
imp_uid, merchant_uid 등 V1 잔재)을 V2 코드에 섞지 않는다.
- 검증 단계에서
integration-validator 에이전트가 스키마와 대조할 수 있도록, 어떤 API/문서를 참조했는지 코멘트나 응답에 남긴다.
조회한 도구·문서로 뒷받침되지 않는 부분이 있으면 추측하지 말고 명시적으로 "확인 필요"라고 표기한다.
Version Selection: V1 vs V2
V2 (권장)
- 신규 프로젝트에 권장
- 최신 SDK와 API 설계
- 더 나은 타입 안전성
- Bearer/PortOne 인증 스킴 지원
- V2 API 호출 시
PortOne 인증 스킴 우선 사용
V1
- 레거시 프로젝트 지원
- 기존 연동 유지보수
- 일부 PG사 V1 전용 기능 존재
사용자가 버전을 지정하지 않은 경우, 신규 프로젝트면 V2를, 기존 코드가 있으면 해당 버전을 따른다.
Payment Types
결제 유형을 선택할 때 다음 설명을 참고하여 사용자에게 안내한다:
단건결제
- PG사 결제창을 통한 결제
- 카드, 계좌이체, 가상계좌, 휴대폰 결제 등
- 일회성 결제에 적합
- 사용 시점: 쇼핑몰, 단건 상품 구매
빌링결제
- 빌링키 발급 후 서버에서 원하는 시점에 결제 호출
- 구독 서비스, 월정액 서비스에 적합
- 사용 시점: SaaS, 구독 서비스, 정기 배송
본인인증
- 휴대폰 본인인증 또는 이니시스 통합인증
- 회원가입, 성인인증에 사용
- 사용 시점: 회원가입, 연령 제한 서비스
MCP Tools Usage
포트원 MCP 서버가 제공하는 도구들을 적극 활용한다.
코드 생성 시 필수 도구
V2 코드 작성 전 반드시 예시 코드 조회:
mcp__portone__readPortoneV2FrontendCode
- framework: react, html 중 선택
- pg: toss, nice, inicis 등
- pay_method: card, virtualAccount, easyPay 등
mcp__portone__readPortoneV2BackendCode
- framework: express, fastapi, flask, spring-kotlin 중 선택
- pg: 사용할 PG사
- pay_method: 결제 수단
문서 조회 도구
mcp__portone__listPortoneDocs
- 문서 목록 조회
- dev_docs, help_docs, release_notes 필터링
mcp__portone__readPortoneDoc
- 개별 문서 내용 조회
- path, fields 지정
mcp__portone__regexSearchPortoneDocs
- 정규식 기반 문서 검색
- 키워드로 관련 문서 찾기
API 스키마 조회
mcp__portone__readPortoneOpenapiSchemaSummary
- V1/V2 API 전체 요약
mcp__portone__readPortoneOpenapiSchema
- 특정 API 상세 스키마
- yaml_path로 경로 지정
상점/채널 정보
mcp__portone__listStores
- 연결된 상점 정보
mcp__portone__getChannelsOfStore
- 상점의 채널 목록
mcp__portone__listSharedTestChannels
- 테스트용 공유 채널
Integration Workflow
1. 환경 파악
- 프론트엔드/백엔드 프레임워크 확인
- 포트원 버전 결정 (V1/V2)
- 결제 유형 결정
2. 예시 코드 조회
- V2의 경우
readPortoneV2FrontendCode, readPortoneV2BackendCode 사용
- V1의 경우
readPortoneDoc으로 관련 문서 조회
3. 코드 생성
- 예시 코드를 프로젝트 구조에 맞게 수정
- 환경 변수로 API 키 관리
- 에러 핸들링 추가
4. 웹훅 연동
- 결제 상태 변경 알림 처리
- 가상계좌 입금 통보 등
Code Generation Guidelines
프론트엔드
SDK 로드 (V2):
import * as PortOne from "@portone/browser-sdk/v2";
결제 요청:
const response = await PortOne.requestPayment({
storeId: "store-id",
channelKey: "channel-key",
paymentId: `payment-${crypto.randomUUID()}`,
orderName: "주문명",
totalAmount: 1000,
currency: "KRW",
payMethod: "CARD",
});
백엔드
결제 검증 (V2 — 공식 Server SDK 사용 권장):
import * as PortOne from "@portone/server-sdk";
const portoneClient = PortOne.PortOneClient({
secret: process.env.PORTONE_API_SECRET,
});
const payment = await portoneClient.payment.getPayment({ paymentId });
SDK는 PortOne 인증 스킴을 자동으로 사용하며, PG별 응답 차이를 정규화한 타입 안전한 결과를 반환한다. 직접 fetch를 호출해야 하는 경우 Authorization: PortOne <SECRET> 헤더를 사용한다 (Bearer는 호환용일 뿐 V2에서는 PortOne 스킴이 우선).
Security Considerations
API 키 관리
- API Secret은 절대 클라이언트에 노출하지 않음
- 환경 변수로 관리 (
.env 파일)
- 커밋에서 제외 (
.gitignore)
결제 검증
- 프론트엔드 결제 완료 후 반드시 서버에서 검증
- 금액 일치 여부 확인
- 결제 상태 확인
웹훅 검증
- 웹훅 시그니처 검증
- 중복 처리 방지 (멱등성)
Error Handling
일반적인 에러 케이스
- 사용자 결제 취소
- 카드 한도 초과
- 네트워크 오류
- PG사 오류
에러 응답 처리
if (response.code) {
console.error(response.message);
}
Webhook Integration
웹훅 설정
- 포트원 콘솔에서 웹훅 URL 등록
- HTTPS 필수
- 타임아웃 고려
웹훅 처리
웹훅 페이로드를 처리하기 전에 반드시 시그니처를 검증한다. HMAC 검증은 파싱된 JSON이 아닌 원본 raw 바디에 대해 수행해야 하므로, JSON 파서보다 먼저 express.raw() 미들웨어를 적용한다.
import express from "express";
import * as PortOne from "@portone/server-sdk";
app.post(
"/webhook",
express.raw({ type: "application/json" }),
async (req, res, next) => {
try {
const payload =
req.body instanceof Buffer ? req.body.toString("utf8") : req.body;
const webhook = await PortOne.Webhook.verify(
process.env.PORTONE_WEBHOOK_SECRET,
payload,
req.headers,
);
res.status(200).send("OK");
} catch (e) {
if (e instanceof PortOne.Webhook.WebhookVerificationError) {
return res.status(401).send("Invalid webhook signature");
}
next(e);
}
},
);
주의: app.use(express.json())을 전역으로 사용하는 경우, 웹훅 라우트는 반드시 그 이전에 등록해야 한다. Express 바디 파서는 스트림 기반이라 전역 JSON 파서가 먼저 실행되면 바디가 이미 소비되어 라우트 단의 express.raw()로 원본 바이트를 다시 읽을 수 없다. 이 경우 HMAC 검증이 항상 실패한다.
Common Integration Patterns
일반결제 플로우
- 클라이언트: SDK로 결제창 호출
- 사용자: 결제 진행
- 클라이언트: 결제 결과 수신
- 서버: 결제 검증 API 호출
- 서버: 주문 상태 업데이트
정기결제 플로우
- 클라이언트: 빌링키 발급 창 호출
- 서버: 빌링키 저장
- 서버: 정기 스케줄에 따라 결제 API 호출
- 서버: 결제 결과 처리
Testing
테스트 환경
- 포트원 테스트 채널 사용
- 실제 결제 없이 연동 테스트
mcp__portone__listSharedTestChannels로 테스트 채널 조회
테스트 카드
- PG사별 테스트 카드 번호 사용
- 문서에서 테스트 정보 확인
Additional Resources
포트원 MCP 서버 도구를 통해 최신 문서와 API 스키마를 항상 조회할 수 있다. 코드 작성 전 반드시 예시 코드와 문서를 확인한다.
