타입 별칭 PortOneApiClient

PortOneApiClient: {
    apiBase: string;
    storeId?: string;
    getBillingKey(billingKey: string): Promise<null | DeletedBillingKeyInfo | IssuedBillingKeyInfo>;
    deleteBillingKey(billingKey: string): Promise<DeleteBillingKeyResponse>;
    getBillingKeys(pageNumber: number, pageSize: number, options?: {
        sort?: BillingKeySortInput;
        filter?: Omit<BillingKeyFilterInput, "storeId">;
    }): Promise<BillingKeyInfo[]>;
    issueBillingKey(method: InstantBillingKeyPaymentMethodInput, options?: Omit<IssueBillingKeyBody, "method" | "storeId">): Promise<IssueBillingKeyResponse>;
    getCashReceipt(paymentId: string): Promise<
        | null
        | CancelledCashReceipt
        | IssuedCashReceipt
        | IssueFailedCashReceipt>;
    issueCashReceipt(options: Omit<IssueCashReceiptBody, "storeId">): Promise<CashReceiptSummary>;
    cancelCashReceipt(paymentId: string): Promise<CancelCashReceiptResponse>;
    getIdentityVerification(identityVerificationId: string): Promise<
        | null
        | FailedIdentityVerification
        | ReadyIdentityVerification
        | VerifiedIdentityVerification>;
    sendIdentityVerification(identityVerificationId: string, options: Omit<SendIdentityVerificationBody, "storeId">): Promise<void>;
    confirmIdentityVerification(identityVerificationId: string, otp?: string): Promise<VerifiedIdentityVerification>;
    resendIdentityVerification(identityVerificationId: string): Promise<void>;
    getPaymentSchedule(paymentScheduleId: string): Promise<
        | null
        | FailedPaymentSchedule
        | PendingPaymentSchedule
        | RevokedPaymentSchedule
        | ScheduledPaymentSchedule
        | StartedPaymentSchedule
        | SucceededPaymentSchedule>;
    getPaymentScheuldes(pageNumber: number, pageSize: number, options?: {
        sort?: PaymentScheduleSortInput;
        filter?: Omit<PaymentScheduleFilterInput, "storeId">;
    }): Promise<PaymentSchedule[]>;
    revokePaymentSchedules(options?: Omit<RevokePaymentSchedulesBody, "storeId">): Promise<RevokePaymentSchedulesResponse>;
    schedulePayment(paymentId: string, payment: Omit<BillingKeyPaymentInput, "storeId">, timeToPay: string): Promise<PaymentScheduleSummary>;
    getPayment(paymentId: string): Promise<
        | null
        | CancelledPayment
        | FailedPayment
        | PaidPayment
        | PartialCancelledPayment
        | PayPendingPayment
        | ReadyPayment
        | VirtualAccountIssuedPayment>;
    getPayments(pageNumber: number, pageSize: number, filter?: Omit<PaymentFilterInput, "storeId">): Promise<Payment[]>;
    preRegisterPayment(paymentId: string, options?: Omit<PreRegisterPaymentBody, "storeId">): Promise<void>;
    cancelPayment(paymentId: string, options: Omit<CancelPaymentBody, "storeId">): Promise<PaymentCancellation>;
    payWithBillingKey(paymentId: string, options: Omit<BillingKeyPaymentInput, "storeId">): Promise<BillingKeyPaymentSummary>;
    instantPay(paymentId: string, options: Omit<InstantPaymentInput, "storeId">): Promise<InstantPaymentSummary>;
    closeVirtualAccount(paymentId: string): Promise<CloseVirtualAccountResponse>;
    registerEscrowLogistics(paymentId: string, options: Omit<RegisterEscrowLogisticsBody, "storeId">): Promise<ApplyEscrowLogisticsResponse>;
    modifyEscrowLogsitics(paymentId: string, options: Omit<ModifyEscrowLogisticsBody, "storeId">): Promise<ModifyEscrowLogisticsResponse>;
    completeEscrow(paymentId: string, fromStore?: boolean): Promise<ConfirmEscrowResponse>;
    resendWebhook(paymentId: string, webhookId?: string): Promise<PaymentWebhook>;
    registerStoreReceipt(paymentId: string, items: RegisterStoreReceiptBodyItem[]): Promise<RegisterStoreReceiptResponse>;
    getKakaopayOrder(pgTxId: string, channelKey: string): Promise<GetKakaopayPaymentOrderResponse>;
}

포트원 API 객체

타입 선언

설정

필터