IAP.completeProductGrant

기능 설명

상품 지급 처리를 완료했다는 메시지를 앱에 전달해요. 결제가 끝난 주문의 상품 지급이 정상적으로 끝났음을 알릴 때 사용해요.

파라미터는 { params: { orderId } } 중첩을 유지해요.

토스앱 Android/iOS 5.233.0 이상에서 사용할 수 있어요. 미지원 버전에서 호출하면 UNSUPPORTED_APP_VERSION 에러가 발생해요.

타입

IAP.completeProductGrant(args: { params: { orderId: string } }): Promise<boolean>;

Params

{
  params: {
    orderId: string;
  }
}

Response

지급 완료 여부를 boolean으로 반환해요.

에러

에러 코드는 catch한 에러의 error.code 값이에요.

코드	설명
UNSUPPORTED_APP_VERSION	실행 중인 토스앱 버전이 이 기능을 지원하지 않으면 호출 즉시 발생해요. IAP.completeProductGrant.isSupported()로 사전 확인하고, 발생 시 error.message(업데이트 안내 문구)를 사용자에게 보여주세요.

예시 코드

import { IAP } from "@apps-in-toss/web-framework";

try {
  await IAP.completeProductGrant({
    params: { orderId: "order-id" },
  });
} catch (error) {
  console.error(error);
}