개발자센터
V1
V2

웹훅 연동하기

웹훅 알림을 받아 결제 정보를 동기화할 수 있습니다.

웹훅(Webhook) 이란?

결제 완료 등 이벤트가 발생했을 때 고객사의 서버에 HTTP 요청으로 알려 드리는 시스템입니다.

이벤트가 발생하면 등록된 웹훅 URL로 포트원에서 HTTP POST 요청을 보냅니다. 이 요청을 받았을 때 결제 정보를 확인 후 동기화할 수 있도록 구현하시면 됩니다.

웹훅 연동이 꼭 필요한가요?

안정적인 결제 처리를 위해 웹훅 연동을 강력히 권장합니다. 인터넷 연결 끊김, 브라우저 자동 새로고침 등의 이유로 브라우저에서 결제 완료 요청이 오지 않는 경우에 웹훅을 받으면 누락 없이 결제 정보를 동기화할 수 있습니다.

웹훅 발생 이벤트

포트원 웹훅은 다음과 같은 이벤트에 발생됩니다.

  • 결제(예약 결제 포함)가 승인되었을 때 (모든 결제 수단) - (status : Paid)
  • 가상계좌가 발급되었을 때 - (status : VirtualAccountIssued)
  • 가상계좌에 결제 금액이 입금되었을 때 - (status : Paid)
  • 결제가 부분 취소되었을 때 - (status : PartialCancelled)
  • 결제가 완전 취소되었을 때 - (status : Cancelled)
  • 결제(예약 결제 포함)가 실패했을 때 - (status: Failed)

웹훅 URL 설정

웹훅 URL을 설정하면 포트원에서 웹훅을 보냅니다. URL은 관리자 콘솔에서 일괄적으로 설정하거나, 결제시에 파라미터로 지정할 수 있습니다.

1. 관리자 콘솔 설정

웹훅을 통해 결제 정보를 통보받을 URL을 설정하려면 포트원 관리자 콘솔 내 결제 연동->결제알림(Webhook) 관리 탭을 선택합니다. Endpoint URL에 웹훅으로 전송될 데이터를 수신할 URL을 기재합니다.

Content-Typeapplication/json 또는 application/x-www-form-urlencoded으로 지정할 수 있습니다.

호출 테스트 버튼을 통해 올바른 URL과 Content-Type을 지정했는지 테스트할 수 있습니다.

2. 결제 파라미터 설정

포트원 SDK의 PortOne.requestPayment() 함수 파라미터 중 noticeUrls를 통해 관리자콘솔에서 설정한 웹훅 수신 URL을 덮어쓸 수 있습니다.

PortOne.requestPayment({
  /* 객체 생략 */
  noticeUrls: ["https://수신할-웹훅-URL"],
});

요청 처리

웹훅 POST 요청의 본문은 다음의 정보를 포함합니다. 고객사 서버는 아래 정보를 수신하고 포트원 서버에서 결제 정보를 조회하여 검증 및 저장할 수 있습니다. (필드는 별도 안내 없이 추가될 수 있습니다.)

  • payment_id: 주문 ID
  • status: 결제 상태
Express
// Content-Type을 application/json으로 설정한 경우 app.use(bodyParser.json()); // POST 요청을 받는 /portone-webhook app.post("/portone-webhook", async (req, res) => { try { const { payment_id: paymentId } = req.body; // 1. 포트원 API를 사용하기 위한 액세스 토큰 발급 받기 const signinResponse = await fetch("https://api.portone.io/login/api-secret", { method: "POST", headers: { "Content-Type": "application/json" }, data: { apiSecret: PORTONE_API_SECRET, // 포트원 API Secret }, }); if (!signinResponse.ok) throw new Error(`signinResponse: ${signinResponse.statusText}`); const { accessToken } = await signinResponse.json(); // 2. 포트원 결제내역 단건조회 API 호출 const paymentResponse = await fetch(`https://api.portone.io/payments/${encodeURIComponent(paymentId)}`, { // 1번에서 발급받은 액세스 토큰을 Bearer 형식에 맞게 넣어주세요. headers: { "Authorization": "Bearer " + accessToken }, }); if (!paymentResponse.ok) throw new Error(`signinResponse: ${paymentResponse.statusText}`); const { id, status, amount, method } = await paymentResponse.json(); // 3. 고객사 내부 주문 데이터의 가격과 실제 지불된 금액을 비교합니다. const order = await OrderService.findById(id); if (order.amount === amount.total) { switch (status) { case "VIRTUAL_ACCOUNT_ISSUED": { // 가상 계좌가 발급된 상태입니다. // method에 들어 있는 계좌 정보를 이용해 원하는 로직을 구성하세요. break; } case "PAID": { // 모든 금액을 지불했습니다! 완료 시 원하는 로직을 구성하세요. break; } } } else { // 결제 금액이 불일치하여 위/변조 시도가 의심됩니다. } } catch (e) { // 결제 검증에 실패했습니다. res.status(400).send(e); } });

3. 웹훅(Webhook) 요청 검증하기

웹훅 수신주소는 공개된 URL이기 때문에 요청자 IP가 포트원의 IP인지 반드시 확인해야 합니다. 포트원 웹훅은 다음의 고정된 IP로부터 요청이 생성됩니다.

  • 52.78.5.241

웹훅 처리 전에 브라우저 결제 완료 처리가 진행되는 경우

기본적으로 포트원 서버는 웹훅을 호출한 뒤 고객사 응답을 기다리지 않고 브라우저에 302 redirect 응답을 보내기 때문에 결과 도달에 대한 순서를 보장하지 않습니다. 다만 고객사 요청이 있을 경우 webhook 호출 이후에 브라우저에 302 redirect 또는 callback 응답을 보내어 순서를 보장해 드리고 있습니다. 웹훅 우선순위 요청은 support@portone.io 로 고객사 식별코드를 기재하여 요청해 주시면 됩니다.

웹훅 재전송 정책

네트워크 문제나 고객사 오류 등으로 웹훅이 실패할 경우 최대 5회까지 웹훅을 재전송합니다.

재전송 시간은 exponential backoff를 적용하여 0 -> 1 → 4 -> 16 -> 256분을 기다립니다. 이에 더하여 무작위로 지연 시간을 변형하는 jittering이 적용됩니다.