@portone/server-sdk/dist/generated/pgSpecific/client.d.ts

PortOne JavaScript SDK for server-side usage

import { PgSpecificError } from "./PgSpecificError.js";
import type { Unrecognized } from "./../../utils/unrecognized.js";
import { type PortOneClientInit } from "../../client.js";
import type { GetKakaopayPaymentOrderResponse } from "../../generated/pgSpecific/GetKakaopayPaymentOrderResponse.js";
import type { InvalidRequestError } from "../../generated/common/InvalidRequestError.js";
import type { UnauthorizedError } from "../../generated/common/UnauthorizedError.js";
/**
 * 포트원 API 클라이언트를 생성합니다.
 */
export declare function PgSpecificClient(init: PortOneClientInit): PgSpecificClient;
export type PgSpecificClient = {
    /**
     * 카카오페이 주문 조회 API
     *
     * 주어진 아이디에 대응되는 카카오페이 주문 건을 조회합니다.
     * 해당 API 사용이 필요한 경우 포트원 기술지원팀으로 문의 주시길 바랍니다.
     *
     * @throws {@link GetKakaopayPaymentOrderError}
     */
    getKakaopayPaymentOrder: (options: {
        /** 카카오페이 주문 번호 (tid) */
        pgTxId: string;
        /** 채널 키 */
        channelKey: string;
    }) => Promise<GetKakaopayPaymentOrderResponse>;
};
export declare class GetKakaopayPaymentOrderError extends PgSpecificError {
    readonly data: InvalidRequestError | UnauthorizedError | {
        readonly type: Unrecognized;
    };
    /** @ignore */
    constructor(data: InvalidRequestError | UnauthorizedError | {
        readonly type: Unrecognized;
    });
}