웹훅 연동하기

웹훅(Webhook) 이란?

특정 이벤트가 발생하였을 때 타 서비스나 응용프로그램으로 알림을 보내는 기능입니다. Webhook 프로바이더는 해당 이벤트가 발행하면 HTTP POST 요청을 생성하여 callback URL(endpoint)로 이벤트 정보을 보냅니다. 주기적으로 데이터를 폴링(polling)하지 않고 원하는 이벤트에 대한 정보만 수신할 수 있어서 webhook은 리소스나 통신 측면에서 훨씬 더 효율적입니다. Webhook을 활용하면 커스텀 기능이나 다른 애플리케이션과 연동하여 기능을 확장할 수 있습니다.

포트원에서는 결제 완료 등 이벤트가 발생했을 때 고객사의 서버에 전송하고 있습니다. 이벤트가 발생하면 포트원 콘솔에 등록된 웹훅 URL로 HTTP POST 요청을 보냅니다. 고객사에서는 이 요청을 받아 최신 결제 정보로 동기화하도록 구현해야 합니다.

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

안정적인 결제 처리를 위해 웹훅 연동을 강력히 권장합니다. 인터넷 연결 끊김, 브라우저 자동 새로고침 등의 이유로 클라이언트에서 결제 완료에 대한 응답을 받지 못하는 경우가 간헐적으로 발생합니다. 이런 경우 연동한 웹훅을 통해 누락 없이 결제 정보를 동기화할 수 있습니다.

웹훅 발생 이벤트

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

• 결제창이 열렸을 때 - (status: Ready)
• 결제(예약 결제 포함)가 승인되었을 때 (모든 결제 수단) - (status : Paid)
• 가상계좌가 발급되었을 때 - (status : VirtualAccountIssued)
• 가상계좌에 결제 금액이 입금되었을 때 - (status : Paid)
• 결제가 부분 취소되었을 때 - (status : PartialCancelled)
• 결제가 완전 취소되었을 때 - (status : Cancelled)
• 결제(예약 결제 포함)가 실패했을 때 - (status: Failed)
• 결제 승인 대기 상태가 되었을 때 (페이팔 연동 시 발생) - (status: PayPending)

웹훅 URL 설정

웹훅 URL을 설정하면 포트원에서 이벤트 발생 시 해당 URL로 웹훅을 전송합니다. URL은 관리자 콘솔에서 두 가지 형태로 지원하고 있습니다. 콘솔에서 설정했더라도 결제 시에 noticeUrls파라미터로 지정하여 호출하는 경우 해당 URL로 전송됩니다.

1. 관리자 콘솔 설정

웹훅을 통해 결제 정보를 통보받을 URL을 설정하는 과정은 다음과 같습니다.

• 포트원 관리자 콘솔 내 [결제 연동] → [연동 관리] →**[결제알림(Webhook) 관리]** 탭을 선택합니다.

• [웹훅 버전] 항목에서 [결제모듈 V2] 를 선택합니다.

• [설정 모드] 항목에서 [실연동] 또는 [테스트]를 선택합니다. (연동 환경에 따라 웹훅 URL을 각각 다르게 설정할 수 있습니다.)

• Endpoint URL에 웹훅 데이터를 수신할 URL을 입력합니다.

• Content Type을 설정합니다. Content Type은 application/json 또는 application/x-www-form-urlencoded 중 하나로 설정할 수 있습니다.

• 저장 버튼을 클릭합니다.

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 paymentResponse = await fetch(
      `https://api.portone.io/payments/${encodeURIComponent(paymentId)}`,
      {
        headers: {
          Authorization: `PortOne ${PORTONE_API_SECRET}`,
        },
      },
    );
    if (!paymentResponse.ok)
      throw new Error(`signinResponse: ${paymentResponse.statusText}`);
    const { id, status, amount, method } = await paymentResponse.json();

    // 2. 고객사 내부 주문 데이터의 가격과 실제 지불된 금액을 비교합니다.
    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. 웹훅 요청 검증하기

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

• 52.78.5.241