TossPay.authorize

Functional API checkoutPaymentYou can use the same functionality with this as well. The function-based API is the same as v2 { params: { payToken } } takes arguments in this form.

Feature description

It opens the TossPay payment window and performs user authentication. When authentication is complete, it returns whether it succeeded.

Actual payment approval should be handled on the server payTokenand handled separately.

Type

TossPay.authorize(params: CheckoutPaymentOptions): Promise<CheckoutPaymentResult>;

Params

type CheckoutPaymentOptions = {
  /** This is the payment token. */
  payToken: string;
};

Response

type CheckoutPaymentResult = {
  /** Whether authentication succeeded. */
  success: boolean;
  /** The reason if authentication failed. */
  reason?: string;
};

Example code

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

async function handlePayment() {
  try {
    // In a real implementation, replace this with the API endpoint that creates the payment.
    const { payToken } = await fetch("/my-api/payment/create").then((res) =>
      res.json(),
    );

    const { success, reason } = await TossPay.authorize({ payToken });

    if (success) {
      // In a real implementation, replace this with the API endpoint that executes the payment.
      await fetch("/my-api/payment/execute", {
        method: "POST",
        body: JSON.stringify({ payToken }),
        headers: { "Content-Type": "application/json" },
      });
    } else {
      console.log("Authentication failed:", reason);
    }
  } catch (error) {
    An error occurred during payment authentication:
  }
}

document.querySelector("#pay-button").addEventListener("click", handlePayment);