IAP.getPendingOrders

Feature description

Get the list of pending orders. You can check orders for which payment has not yet been completed.

Toss app Android 5.234.0, iOS 5.231.0 It can be used on versions above. If called in an unsupported version, UNSUPPORTED_APP_VERSION an error occurs.

Type

IAP.getPendingOrders(): Promise<{ orders: Array<{ orderId: string; sku: string; paymentCompletedDate: string }> }>;

Params

None

Response

{
  orders: Array<{
    orderId: string;
    sku: string;
    paymentCompletedDate: string;
  }>;
}

Error

The error code is the error.code value.

Code	Description
UNSUPPORTED_APP_VERSION	If the running version of the Toss app doesn't support this feature, it occurs immediately upon call. IAP.getPendingOrders.isSupported()Check in advance with error.messageand, if it occurs, show the user the (update guidance message).

Example code

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

try {
  const pendingOrders = await IAP.getPendingOrders();
  console.log(pendingOrders.orders);
} catch (error) {
  console.error(error);
}