타입 별칭 Paths

타입 선언

• /billing-keys: {
      get: {
          parameters: {
              body: GetBillingKeyInfosBody;
          };
          success: GetBillingKeyInfosResponse;
          error: Schema.ForbiddenError | Schema.InvalidRequestError | Schema.UnauthorizedError;
      };
      post: {
          parameters: {
              body: IssueBillingKeyBody;
          };
          success: IssueBillingKeyResponse;
          error:
              | Schema.ChannelNotFoundError
              | Schema.ChannelSpecificError
              | Schema.ForbiddenError
              | Schema.InvalidRequestError
              | Schema.PgProviderError
              | Schema.UnauthorizedError;
      };
  }

  • get: {
        parameters: {
            body: GetBillingKeyInfosBody;
        };
        success: GetBillingKeyInfosResponse;
        error: Schema.ForbiddenError | Schema.InvalidRequestError | Schema.UnauthorizedError;
    }

    • parameters: {
          body: GetBillingKeyInfosBody;
      }

      • body: GetBillingKeyInfosBody

    • success: GetBillingKeyInfosResponse

      빌링키 다건 조회 성공 응답 정보

    • error: Schema.ForbiddenError | Schema.InvalidRequestError | Schema.UnauthorizedError

      GetBillingKeyInfosError

  • post: {
        parameters: {
            body: IssueBillingKeyBody;
        };
        success: IssueBillingKeyResponse;
        error:
            | Schema.ChannelNotFoundError
            | Schema.ChannelSpecificError
            | Schema.ForbiddenError
            | Schema.InvalidRequestError
            | Schema.PgProviderError
            | Schema.UnauthorizedError;
    }

    • parameters: {
          body: IssueBillingKeyBody;
      }

      • body: IssueBillingKeyBody

    • success: IssueBillingKeyResponse

      빌링키 발급 성공 응답

    • error:
          | Schema.ChannelNotFoundError
          | Schema.ChannelSpecificError
          | Schema.ForbiddenError
          | Schema.InvalidRequestError
          | Schema.PgProviderError
          | Schema.UnauthorizedError

      IssueBillingKeyError

• /billing-keys/{billingKey}: {
      get: {
          parameters: {
              path: {
                  billingKey: string;
              };
              query: {
                  storeId?: string;
              };
          };
          success: DeletedBillingKeyInfo | IssuedBillingKeyInfo;
          error:
              | Schema.BillingKeyNotFoundError
              | Schema.ForbiddenError
              | Schema.InvalidRequestError
              | Schema.UnauthorizedError;
      };
      delete: {
          parameters: {
              path: {
                  billingKey: string;
              };
              query: {
                  storeId?: string;
              };
          };
          success: DeleteBillingKeyResponse;
          error:
              | Schema.BillingKeyAlreadyDeletedError
              | Schema.BillingKeyNotFoundError
              | Schema.BillingKeyNotIssuedError
              | Schema.ChannelSpecificError
              | Schema.ForbiddenError
              | Schema.InvalidRequestError
              | Schema.PaymentScheduleAlreadyExistsError
              | Schema.PgProviderError
              | Schema.UnauthorizedError;
      };
  }

  • get: {
        parameters: {
            path: {
                billingKey: string;
            };
            query: {
                storeId?: string;
            };
        };
        success: DeletedBillingKeyInfo | IssuedBillingKeyInfo;
        error:
            | Schema.BillingKeyNotFoundError
            | Schema.ForbiddenError
            | Schema.InvalidRequestError
            | Schema.UnauthorizedError;
    }

    • parameters: {
          path: {
              billingKey: string;
          };
          query: {
              storeId?: string;
          };
      }

      • path: {
            billingKey: string;
        }

        • billingKey: string

          조회할 빌링키

      • query: {
            storeId?: string;
        }

        • OptionalstoreId?: string

          상점 아이디

          접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 토큰에 담긴 상점 아이디를 사용합니다.

    • success: DeletedBillingKeyInfo | IssuedBillingKeyInfo

      빌링키 정보

    • error:
          | Schema.BillingKeyNotFoundError
          | Schema.ForbiddenError
          | Schema.InvalidRequestError
          | Schema.UnauthorizedError

      GetBillingKeyInfoError

  • delete: {
        parameters: {
            path: {
                billingKey: string;
            };
            query: {
                storeId?: string;
            };
        };
        success: DeleteBillingKeyResponse;
        error:
            | Schema.BillingKeyAlreadyDeletedError
            | Schema.BillingKeyNotFoundError
            | Schema.BillingKeyNotIssuedError
            | Schema.ChannelSpecificError
            | Schema.ForbiddenError
            | Schema.InvalidRequestError
            | Schema.PaymentScheduleAlreadyExistsError
            | Schema.PgProviderError
            | Schema.UnauthorizedError;
    }

    • parameters: {
          path: {
              billingKey: string;
          };
          query: {
              storeId?: string;
          };
      }

      • path: {
            billingKey: string;
        }

        • billingKey: string

          삭제할 빌링키

      • query: {
            storeId?: string;
        }

        • OptionalstoreId?: string

          상점 아이디

          접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 토큰에 담긴 상점 아이디를 사용합니다.

    • success: DeleteBillingKeyResponse

      빌링키 삭제 성공 응답

    • error:
          | Schema.BillingKeyAlreadyDeletedError
          | Schema.BillingKeyNotFoundError
          | Schema.BillingKeyNotIssuedError
          | Schema.ChannelSpecificError
          | Schema.ForbiddenError
          | Schema.InvalidRequestError
          | Schema.PaymentScheduleAlreadyExistsError
          | Schema.PgProviderError
          | Schema.UnauthorizedError

      DeleteBillingKeyError

• /cash-receipts: {
      post: {
          parameters: {
              body: IssueCashReceiptBody;
          };
          success: IssueCashReceiptResponse;
          error:
              | Schema.CashReceiptAlreadyIssuedError
              | Schema.ChannelNotFoundError
              | Schema.ForbiddenError
              | Schema.InvalidRequestError
              | Schema.PgProviderError
              | Schema.UnauthorizedError;
      };
  }

  • post: {
        parameters: {
            body: IssueCashReceiptBody;
        };
        success: IssueCashReceiptResponse;
        error:
            | Schema.CashReceiptAlreadyIssuedError
            | Schema.ChannelNotFoundError
            | Schema.ForbiddenError
            | Schema.InvalidRequestError
            | Schema.PgProviderError
            | Schema.UnauthorizedError;
    }

    • parameters: {
          body: IssueCashReceiptBody;
      }

      • body: IssueCashReceiptBody

    • success: IssueCashReceiptResponse

      현금 영수증 발급 성공 응답

    • error:
          | Schema.CashReceiptAlreadyIssuedError
          | Schema.ChannelNotFoundError
          | Schema.ForbiddenError
          | Schema.InvalidRequestError
          | Schema.PgProviderError
          | Schema.UnauthorizedError

      IssueCashReceiptError

• /identity-verifications/{identityVerificationId}: {
      get: {
          parameters: {
              path: {
                  identityVerificationId: string;
              };
              query: {
                  storeId?: string;
              };
          };
          success: FailedIdentityVerification | ReadyIdentityVerification | VerifiedIdentityVerification;
          error:
              | Schema.ForbiddenError
              | Schema.IdentityVerificationNotFoundError
              | Schema.InvalidRequestError
              | Schema.UnauthorizedError;
      };
  }

  • get: {
        parameters: {
            path: {
                identityVerificationId: string;
            };
            query: {
                storeId?: string;
            };
        };
        success: FailedIdentityVerification | ReadyIdentityVerification | VerifiedIdentityVerification;
        error:
            | Schema.ForbiddenError
            | Schema.IdentityVerificationNotFoundError
            | Schema.InvalidRequestError
            | Schema.UnauthorizedError;
    }

    • parameters: {
          path: {
              identityVerificationId: string;
          };
          query: {
              storeId?: string;
          };
      }

      • path: {
            identityVerificationId: string;
        }

        • identityVerificationId: string

          조회할 본인인증 아이디

      • query: {
            storeId?: string;
        }

        • OptionalstoreId?: string

          상점 아이디

          접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 토큰에 담긴 상점 아이디를 사용합니다.

    • success: FailedIdentityVerification | ReadyIdentityVerification | VerifiedIdentityVerification

      본인인증 내역

    • error:
          | Schema.ForbiddenError
          | Schema.IdentityVerificationNotFoundError
          | Schema.InvalidRequestError
          | Schema.UnauthorizedError

      GetIdentityVerificationError

• /identity-verifications/{identityVerificationId}/confirm: {
      post: {
          parameters: {
              path: {
                  identityVerificationId: string;
              };
              body: ConfirmIdentityVerificationBody;
          };
          success: ConfirmIdentityVerificationResponse;
          error:
              | Schema.ForbiddenError
              | Schema.IdentityVerificationAlreadyVerifiedError
              | Schema.IdentityVerificationNotFoundError
              | Schema.IdentityVerificationNotSentError
              | Schema.InvalidRequestError
              | Schema.PgProviderError
              | Schema.UnauthorizedError;
      };
  }

  • post: {
        parameters: {
            path: {
                identityVerificationId: string;
            };
            body: ConfirmIdentityVerificationBody;
        };
        success: ConfirmIdentityVerificationResponse;
        error:
            | Schema.ForbiddenError
            | Schema.IdentityVerificationAlreadyVerifiedError
            | Schema.IdentityVerificationNotFoundError
            | Schema.IdentityVerificationNotSentError
            | Schema.InvalidRequestError
            | Schema.PgProviderError
            | Schema.UnauthorizedError;
    }

    • parameters: {
          path: {
              identityVerificationId: string;
          };
          body: ConfirmIdentityVerificationBody;
      }

      • path: {
            identityVerificationId: string;
        }

        • identityVerificationId: string

          본인인증 아이디

      • body: ConfirmIdentityVerificationBody

    • success: ConfirmIdentityVerificationResponse

      본인인증 확인 성공 응답

    • error:
          | Schema.ForbiddenError
          | Schema.IdentityVerificationAlreadyVerifiedError
          | Schema.IdentityVerificationNotFoundError
          | Schema.IdentityVerificationNotSentError
          | Schema.InvalidRequestError
          | Schema.PgProviderError
          | Schema.UnauthorizedError

      ConfirmIdentityVerificationError

• /identity-verifications/{identityVerificationId}/resend: {
      post: {
          parameters: {
              path: {
                  identityVerificationId: string;
              };
              query: {
                  storeId?: string;
              };
          };
          success: void;
          error:
              | Schema.ForbiddenError
              | Schema.IdentityVerificationAlreadyVerifiedError
              | Schema.IdentityVerificationNotFoundError
              | Schema.IdentityVerificationNotSentError
              | Schema.InvalidRequestError
              | Schema.PgProviderError
              | Schema.UnauthorizedError;
      };
  }

  • post: {
        parameters: {
            path: {
                identityVerificationId: string;
            };
            query: {
                storeId?: string;
            };
        };
        success: void;
        error:
            | Schema.ForbiddenError
            | Schema.IdentityVerificationAlreadyVerifiedError
            | Schema.IdentityVerificationNotFoundError
            | Schema.IdentityVerificationNotSentError
            | Schema.InvalidRequestError
            | Schema.PgProviderError
            | Schema.UnauthorizedError;
    }

    • parameters: {
          path: {
              identityVerificationId: string;
          };
          query: {
              storeId?: string;
          };
      }

      • path: {
            identityVerificationId: string;
        }

        • identityVerificationId: string

          본인인증 아이디

      • query: {
            storeId?: string;
        }

        • OptionalstoreId?: string

          상점 아이디

          접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 토큰에 담긴 상점 아이디를 사용합니다.

    • success: void

      본인인증 요청 재전송 성공 응답

    • error:
          | Schema.ForbiddenError
          | Schema.IdentityVerificationAlreadyVerifiedError
          | Schema.IdentityVerificationNotFoundError
          | Schema.IdentityVerificationNotSentError
          | Schema.InvalidRequestError
          | Schema.PgProviderError
          | Schema.UnauthorizedError

      ResendIdentityVerificationError

• /identity-verifications/{identityVerificationId}/send: {
      post: {
          parameters: {
              path: {
                  identityVerificationId: string;
              };
              body: SendIdentityVerificationBody;
          };
          success: void;
          error:
              | Schema.ChannelNotFoundError
              | Schema.ForbiddenError
              | Schema.IdentityVerificationAlreadySentError
              | Schema.IdentityVerificationAlreadyVerifiedError
              | Schema.IdentityVerificationNotFoundError
              | Schema.InvalidRequestError
              | Schema.PgProviderError
              | Schema.UnauthorizedError;
      };
  }

  • post: {
        parameters: {
            path: {
                identityVerificationId: string;
            };
            body: SendIdentityVerificationBody;
        };
        success: void;
        error:
            | Schema.ChannelNotFoundError
            | Schema.ForbiddenError
            | Schema.IdentityVerificationAlreadySentError
            | Schema.IdentityVerificationAlreadyVerifiedError
            | Schema.IdentityVerificationNotFoundError
            | Schema.InvalidRequestError
            | Schema.PgProviderError
            | Schema.UnauthorizedError;
    }

    • parameters: {
          path: {
              identityVerificationId: string;
          };
          body: SendIdentityVerificationBody;
      }

      • path: {
            identityVerificationId: string;
        }

        • identityVerificationId: string

          본인인증 아이디

      • body: SendIdentityVerificationBody

    • success: void

      본인인증 요청 전송 성공 응답

    • error:
          | Schema.ChannelNotFoundError
          | Schema.ForbiddenError
          | Schema.IdentityVerificationAlreadySentError
          | Schema.IdentityVerificationAlreadyVerifiedError
          | Schema.IdentityVerificationNotFoundError
          | Schema.InvalidRequestError
          | Schema.PgProviderError
          | Schema.UnauthorizedError

      SendIdentityVerificationError

• /kakaopay/payment/order: {
      get: {
          parameters: {
              query: {
                  pgTxId: string;
                  channelKey: string;
              };
          };
          success: GetKakaopayPaymentOrderResponse;
          error: Schema.InvalidRequestError | Schema.UnauthorizedError;
      };
  }

  • get: {
        parameters: {
            query: {
                pgTxId: string;
                channelKey: string;
            };
        };
        success: GetKakaopayPaymentOrderResponse;
        error: Schema.InvalidRequestError | Schema.UnauthorizedError;
    }

    • parameters: {
          query: {
              pgTxId: string;
              channelKey: string;
          };
      }

      • query: {
            pgTxId: string;
            channelKey: string;
        }

        • pgTxId: string

          카카오페이 주문 번호 (tid)

        • channelKey: string

          채널 키

    • success: GetKakaopayPaymentOrderResponse

      카카오페이 주문 조회 응답

    • error: Schema.InvalidRequestError | Schema.UnauthorizedError

      GetKakaopayPaymentOrderError

• /payment-schedules: {
      get: {
          parameters: {
              body: GetPaymentSchedulesBody;
          };
          success: GetPaymentSchedulesResponse;
          error: Schema.ForbiddenError | Schema.InvalidRequestError | Schema.UnauthorizedError;
      };
      delete: {
          parameters: {
              body: RevokePaymentSchedulesBody;
          };
          success: RevokePaymentSchedulesResponse;
          error:
              | Schema.BillingKeyAlreadyDeletedError
              | Schema.BillingKeyNotFoundError
              | Schema.ForbiddenError
              | Schema.InvalidRequestError
              | Schema.PaymentScheduleAlreadyProcessedError
              | Schema.PaymentScheduleAlreadyRevokedError
              | Schema.PaymentScheduleNotFoundError
              | Schema.UnauthorizedError;
      };
  }

  • get: {
        parameters: {
            body: GetPaymentSchedulesBody;
        };
        success: GetPaymentSchedulesResponse;
        error: Schema.ForbiddenError | Schema.InvalidRequestError | Schema.UnauthorizedError;
    }

    • parameters: {
          body: GetPaymentSchedulesBody;
      }

      • body: GetPaymentSchedulesBody

    • success: GetPaymentSchedulesResponse

      결제 예약 다건 조회 성공 응답 정보

    • error: Schema.ForbiddenError | Schema.InvalidRequestError | Schema.UnauthorizedError

      GetPaymentSchedulesError

  • delete: {
        parameters: {
            body: RevokePaymentSchedulesBody;
        };
        success: RevokePaymentSchedulesResponse;
        error:
            | Schema.BillingKeyAlreadyDeletedError
            | Schema.BillingKeyNotFoundError
            | Schema.ForbiddenError
            | Schema.InvalidRequestError
            | Schema.PaymentScheduleAlreadyProcessedError
            | Schema.PaymentScheduleAlreadyRevokedError
            | Schema.PaymentScheduleNotFoundError
            | Schema.UnauthorizedError;
    }

    • parameters: {
          body: RevokePaymentSchedulesBody;
      }

      • body: RevokePaymentSchedulesBody

    • success: RevokePaymentSchedulesResponse

      결제 예약 건 취소 성공 응답

    • error:
          | Schema.BillingKeyAlreadyDeletedError
          | Schema.BillingKeyNotFoundError
          | Schema.ForbiddenError
          | Schema.InvalidRequestError
          | Schema.PaymentScheduleAlreadyProcessedError
          | Schema.PaymentScheduleAlreadyRevokedError
          | Schema.PaymentScheduleNotFoundError
          | Schema.UnauthorizedError

      RevokePaymentSchedulesError

• /payment-schedules/{paymentScheduleId}: {
      get: {
          parameters: {
              path: {
                  paymentScheduleId: string;
              };
              query: {
                  storeId?: string;
              };
          };
          success:
              | FailedPaymentSchedule
              | PendingPaymentSchedule
              | RevokedPaymentSchedule
              | ScheduledPaymentSchedule
              | StartedPaymentSchedule
              | SucceededPaymentSchedule;
          error:
              | Schema.ForbiddenError
              | Schema.InvalidRequestError
              | Schema.PaymentScheduleNotFoundError
              | Schema.UnauthorizedError;
      };
  }

  • get: {
        parameters: {
            path: {
                paymentScheduleId: string;
            };
            query: {
                storeId?: string;
            };
        };
        success:
            | FailedPaymentSchedule
            | PendingPaymentSchedule
            | RevokedPaymentSchedule
            | ScheduledPaymentSchedule
            | StartedPaymentSchedule
            | SucceededPaymentSchedule;
        error:
            | Schema.ForbiddenError
            | Schema.InvalidRequestError
            | Schema.PaymentScheduleNotFoundError
            | Schema.UnauthorizedError;
    }

    • parameters: {
          path: {
              paymentScheduleId: string;
          };
          query: {
              storeId?: string;
          };
      }

      • path: {
            paymentScheduleId: string;
        }

        • paymentScheduleId: string

          조회할 결제 예약 건 아이디

      • query: {
            storeId?: string;
        }

        • OptionalstoreId?: string

          상점 아이디

          접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 토큰에 담긴 상점 아이디를 사용합니다.

    • success:
          | FailedPaymentSchedule
          | PendingPaymentSchedule
          | RevokedPaymentSchedule
          | ScheduledPaymentSchedule
          | StartedPaymentSchedule
          | SucceededPaymentSchedule

      결제 예약 건

    • error:
          | Schema.ForbiddenError
          | Schema.InvalidRequestError
          | Schema.PaymentScheduleNotFoundError
          | Schema.UnauthorizedError

      GetPaymentScheduleError

• /payments: {
      get: {
          parameters: {
              body: GetPaymentsBody;
          };
          success: GetPaymentsResponse;
          error: Schema.ForbiddenError | Schema.InvalidRequestError | Schema.UnauthorizedError;
      };
  }

  • get: {
        parameters: {
            body: GetPaymentsBody;
        };
        success: GetPaymentsResponse;
        error: Schema.ForbiddenError | Schema.InvalidRequestError | Schema.UnauthorizedError;
    }

    • parameters: {
          body: GetPaymentsBody;
      }

      • body: GetPaymentsBody

    • success: GetPaymentsResponse

      결제 건 다건 조회 성공 응답 정보

    • error: Schema.ForbiddenError | Schema.InvalidRequestError | Schema.UnauthorizedError

      GetPaymentsError

• /payments-by-cursor: {
      get: {
          parameters: {
              body: GetAllPaymentsByCursorBody;
          };
          success: GetAllPaymentsByCursorResponse;
          error: Schema.ForbiddenError | Schema.InvalidRequestError | Schema.UnauthorizedError;
      };
  }

  • get: {
        parameters: {
            body: GetAllPaymentsByCursorBody;
        };
        success: GetAllPaymentsByCursorResponse;
        error: Schema.ForbiddenError | Schema.InvalidRequestError | Schema.UnauthorizedError;
    }

    • parameters: {
          body: GetAllPaymentsByCursorBody;
      }

      • body: GetAllPaymentsByCursorBody

    • success: GetAllPaymentsByCursorResponse

      결제 건 커서 기반 대용량 다건 조회 성공 응답 정보

    • error: Schema.ForbiddenError | Schema.InvalidRequestError | Schema.UnauthorizedError

      GetAllPaymentsError

• /payments/{paymentId}: {
      get: {
          parameters: {
              path: {
                  paymentId: string;
              };
              query: {
                  storeId?: string;
              };
          };
          success:
              | CancelledPayment
              | FailedPayment
              | PaidPayment
              | PartialCancelledPayment
              | PayPendingPayment
              | ReadyPayment
              | VirtualAccountIssuedPayment;
          error:
              | Schema.ForbiddenError
              | Schema.InvalidRequestError
              | Schema.PaymentNotFoundError
              | Schema.UnauthorizedError;
      };
  }

  • get: {
        parameters: {
            path: {
                paymentId: string;
            };
            query: {
                storeId?: string;
            };
        };
        success:
            | CancelledPayment
            | FailedPayment
            | PaidPayment
            | PartialCancelledPayment
            | PayPendingPayment
            | ReadyPayment
            | VirtualAccountIssuedPayment;
        error:
            | Schema.ForbiddenError
            | Schema.InvalidRequestError
            | Schema.PaymentNotFoundError
            | Schema.UnauthorizedError;
    }

    • parameters: {
          path: {
              paymentId: string;
          };
          query: {
              storeId?: string;
          };
      }

      • path: {
            paymentId: string;
        }

        • paymentId: string

          조회할 결제 아이디

      • query: {
            storeId?: string;
        }

        • OptionalstoreId?: string

          상점 아이디

    • success:
          | CancelledPayment
          | FailedPayment
          | PaidPayment
          | PartialCancelledPayment
          | PayPendingPayment
          | ReadyPayment
          | VirtualAccountIssuedPayment

      결제 건

    • error:
          | Schema.ForbiddenError
          | Schema.InvalidRequestError
          | Schema.PaymentNotFoundError
          | Schema.UnauthorizedError

      GetPaymentError

• /payments/{paymentId}/billing-key: {
      post: {
          parameters: {
              path: {
                  paymentId: string;
              };
              body: BillingKeyPaymentInput;
          };
          success: PayWithBillingKeyResponse;
          error:
              | Schema.AlreadyPaidError
              | Schema.BillingKeyAlreadyDeletedError
              | Schema.BillingKeyNotFoundError
              | Schema.ChannelNotFoundError
              | Schema.DiscountAmountExceedsTotalAmountError
              | Schema.ForbiddenError
              | Schema.InvalidRequestError
              | Schema.PgProviderError
              | Schema.PromotionPayMethodDoesNotMatchError
              | Schema.SumOfPartsExceedsTotalAmountError
              | Schema.UnauthorizedError;
      };
  }

  • post: {
        parameters: {
            path: {
                paymentId: string;
            };
            body: BillingKeyPaymentInput;
        };
        success: PayWithBillingKeyResponse;
        error:
            | Schema.AlreadyPaidError
            | Schema.BillingKeyAlreadyDeletedError
            | Schema.BillingKeyNotFoundError
            | Schema.ChannelNotFoundError
            | Schema.DiscountAmountExceedsTotalAmountError
            | Schema.ForbiddenError
            | Schema.InvalidRequestError
            | Schema.PgProviderError
            | Schema.PromotionPayMethodDoesNotMatchError
            | Schema.SumOfPartsExceedsTotalAmountError
            | Schema.UnauthorizedError;
    }

    • parameters: {
          path: {
              paymentId: string;
          };
          body: BillingKeyPaymentInput;
      }

      • path: {
            paymentId: string;
        }

        • paymentId: string

          결제 건 아이디

      • body: BillingKeyPaymentInput

    • success: PayWithBillingKeyResponse

      빌링키 결제 성공 응답

    • error:
          | Schema.AlreadyPaidError
          | Schema.BillingKeyAlreadyDeletedError
          | Schema.BillingKeyNotFoundError
          | Schema.ChannelNotFoundError
          | Schema.DiscountAmountExceedsTotalAmountError
          | Schema.ForbiddenError
          | Schema.InvalidRequestError
          | Schema.PgProviderError
          | Schema.PromotionPayMethodDoesNotMatchError
          | Schema.SumOfPartsExceedsTotalAmountError
          | Schema.UnauthorizedError

      PayWithBillingKeyError

• /payments/{paymentId}/cancel: {
      post: {
          parameters: {
              path: {
                  paymentId: string;
              };
              body: CancelPaymentBody;
          };
          success: CancelPaymentResponse;
          error:
              | Schema.CancellableAmountConsistencyBrokenError
              | Schema.CancelAmountExceedsCancellableAmountError
              | Schema.CancelTaxAmountExceedsCancellableTaxAmountError
              | Schema.CancelTaxFreeAmountExceedsCancellableTaxFreeAmountError
              | Schema.ForbiddenError
              | Schema.InvalidRequestError
              | Schema.PaymentAlreadyCancelledError
              | Schema.PaymentNotFoundError
              | Schema.PaymentNotPaidError
              | Schema.PgProviderError
              | Schema.RemainedAmountLessThanPromotionMinPaymentAmountError
              | Schema.SumOfPartsExceedsCancelAmountError
              | Schema.UnauthorizedError;
      };
  }

  • post: {
        parameters: {
            path: {
                paymentId: string;
            };
            body: CancelPaymentBody;
        };
        success: CancelPaymentResponse;
        error:
            | Schema.CancellableAmountConsistencyBrokenError
            | Schema.CancelAmountExceedsCancellableAmountError
            | Schema.CancelTaxAmountExceedsCancellableTaxAmountError
            | Schema.CancelTaxFreeAmountExceedsCancellableTaxFreeAmountError
            | Schema.ForbiddenError
            | Schema.InvalidRequestError
            | Schema.PaymentAlreadyCancelledError
            | Schema.PaymentNotFoundError
            | Schema.PaymentNotPaidError
            | Schema.PgProviderError
            | Schema.RemainedAmountLessThanPromotionMinPaymentAmountError
            | Schema.SumOfPartsExceedsCancelAmountError
            | Schema.UnauthorizedError;
    }

    • parameters: {
          path: {
              paymentId: string;
          };
          body: CancelPaymentBody;
      }

      • path: {
            paymentId: string;
        }

        • paymentId: string

          결제 건 아이디

      • body: CancelPaymentBody

    • success: CancelPaymentResponse

      결제 취소 성공 응답

    • error:
          | Schema.CancellableAmountConsistencyBrokenError
          | Schema.CancelAmountExceedsCancellableAmountError
          | Schema.CancelTaxAmountExceedsCancellableTaxAmountError
          | Schema.CancelTaxFreeAmountExceedsCancellableTaxFreeAmountError
          | Schema.ForbiddenError
          | Schema.InvalidRequestError
          | Schema.PaymentAlreadyCancelledError
          | Schema.PaymentNotFoundError
          | Schema.PaymentNotPaidError
          | Schema.PgProviderError
          | Schema.RemainedAmountLessThanPromotionMinPaymentAmountError
          | Schema.SumOfPartsExceedsCancelAmountError
          | Schema.UnauthorizedError

      CancelPaymentError

• /payments/{paymentId}/cash-receipt: {
      get: {
          parameters: {
              path: {
                  paymentId: string;
              };
              query: {
                  storeId?: string;
              };
          };
          success: CancelledCashReceipt | IssuedCashReceipt | IssueFailedCashReceipt;
          error:
              | Schema.CashReceiptNotFoundError
              | Schema.ForbiddenError
              | Schema.InvalidRequestError
              | Schema.UnauthorizedError;
      };
  }

  • get: {
        parameters: {
            path: {
                paymentId: string;
            };
            query: {
                storeId?: string;
            };
        };
        success: CancelledCashReceipt | IssuedCashReceipt | IssueFailedCashReceipt;
        error:
            | Schema.CashReceiptNotFoundError
            | Schema.ForbiddenError
            | Schema.InvalidRequestError
            | Schema.UnauthorizedError;
    }

    • parameters: {
          path: {
              paymentId: string;
          };
          query: {
              storeId?: string;
          };
      }

      • path: {
            paymentId: string;
        }

        • paymentId: string

          결제 건 아이디

      • query: {
            storeId?: string;
        }

        • OptionalstoreId?: string

          상점 아이디

          접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 토큰에 담긴 상점 아이디를 사용합니다.

    • success: CancelledCashReceipt | IssuedCashReceipt | IssueFailedCashReceipt

      현금영수증 내역

    • error:
          | Schema.CashReceiptNotFoundError
          | Schema.ForbiddenError
          | Schema.InvalidRequestError
          | Schema.UnauthorizedError

      GetCashReceiptError

• /payments/{paymentId}/cash-receipt/cancel: {
      post: {
          parameters: {
              path: {
                  paymentId: string;
              };
              query: {
                  storeId?: string;
              };
          };
          success: CancelCashReceiptResponse;
          error:
              | Schema.CashReceiptNotFoundError
              | Schema.CashReceiptNotIssuedError
              | Schema.ForbiddenError
              | Schema.InvalidRequestError
              | Schema.PgProviderError
              | Schema.UnauthorizedError;
      };
  }

  • post: {
        parameters: {
            path: {
                paymentId: string;
            };
            query: {
                storeId?: string;
            };
        };
        success: CancelCashReceiptResponse;
        error:
            | Schema.CashReceiptNotFoundError
            | Schema.CashReceiptNotIssuedError
            | Schema.ForbiddenError
            | Schema.InvalidRequestError
            | Schema.PgProviderError
            | Schema.UnauthorizedError;
    }

    • parameters: {
          path: {
              paymentId: string;
          };
          query: {
              storeId?: string;
          };
      }

      • path: {
            paymentId: string;
        }

        • paymentId: string

          결제 건 아이디

      • query: {
            storeId?: string;
        }

        • OptionalstoreId?: string

          상점 아이디

          접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 토큰에 담긴 상점 아이디를 사용합니다.

    • success: CancelCashReceiptResponse

      현금 영수증 취소 성공 응답

    • error:
          | Schema.CashReceiptNotFoundError
          | Schema.CashReceiptNotIssuedError
          | Schema.ForbiddenError
          | Schema.InvalidRequestError
          | Schema.PgProviderError
          | Schema.UnauthorizedError

      CancelCashReceiptError

• /payments/{paymentId}/escrow/complete: {
      post: {
          parameters: {
              path: {
                  paymentId: string;
              };
              body: ConfirmEscrowBody;
          };
          success: ConfirmEscrowResponse;
          error:
              | Schema.ForbiddenError
              | Schema.InvalidRequestError
              | Schema.PaymentNotFoundError
              | Schema.PaymentNotPaidError
              | Schema.PgProviderError
              | Schema.UnauthorizedError;
      };
  }

  • post: {
        parameters: {
            path: {
                paymentId: string;
            };
            body: ConfirmEscrowBody;
        };
        success: ConfirmEscrowResponse;
        error:
            | Schema.ForbiddenError
            | Schema.InvalidRequestError
            | Schema.PaymentNotFoundError
            | Schema.PaymentNotPaidError
            | Schema.PgProviderError
            | Schema.UnauthorizedError;
    }

    • parameters: {
          path: {
              paymentId: string;
          };
          body: ConfirmEscrowBody;
      }

      • path: {
            paymentId: string;
        }

        • paymentId: string

          결제 건 아이디

      • body: ConfirmEscrowBody

    • success: ConfirmEscrowResponse

      에스크로 구매 확정 성공 응답

    • error:
          | Schema.ForbiddenError
          | Schema.InvalidRequestError
          | Schema.PaymentNotFoundError
          | Schema.PaymentNotPaidError
          | Schema.PgProviderError
          | Schema.UnauthorizedError

      ConfirmEscrowError

• /payments/{paymentId}/escrow/logistics: {
      post: {
          parameters: {
              path: {
                  paymentId: string;
              };
              body: RegisterEscrowLogisticsBody;
          };
          success: ApplyEscrowLogisticsResponse;
          error:
              | Schema.ForbiddenError
              | Schema.InvalidRequestError
              | Schema.PaymentNotFoundError
              | Schema.PaymentNotPaidError
              | Schema.PgProviderError
              | Schema.UnauthorizedError;
      };
      patch: {
          parameters: {
              path: {
                  paymentId: string;
              };
              body: ModifyEscrowLogisticsBody;
          };
          success: ModifyEscrowLogisticsResponse;
          error:
              | Schema.ForbiddenError
              | Schema.InvalidRequestError
              | Schema.PaymentNotFoundError
              | Schema.PaymentNotPaidError
              | Schema.PgProviderError
              | Schema.UnauthorizedError;
      };
  }

  • post: {
        parameters: {
            path: {
                paymentId: string;
            };
            body: RegisterEscrowLogisticsBody;
        };
        success: ApplyEscrowLogisticsResponse;
        error:
            | Schema.ForbiddenError
            | Schema.InvalidRequestError
            | Schema.PaymentNotFoundError
            | Schema.PaymentNotPaidError
            | Schema.PgProviderError
            | Schema.UnauthorizedError;
    }

    • parameters: {
          path: {
              paymentId: string;
          };
          body: RegisterEscrowLogisticsBody;
      }

      • path: {
            paymentId: string;
        }

        • paymentId: string

          결제 건 아이디

      • body: RegisterEscrowLogisticsBody

    • success: ApplyEscrowLogisticsResponse

      에스크로 배송 정보 등록 성공 응답

    • error:
          | Schema.ForbiddenError
          | Schema.InvalidRequestError
          | Schema.PaymentNotFoundError
          | Schema.PaymentNotPaidError
          | Schema.PgProviderError
          | Schema.UnauthorizedError

      ApplyEscrowLogisticsError

  • patch: {
        parameters: {
            path: {
                paymentId: string;
            };
            body: ModifyEscrowLogisticsBody;
        };
        success: ModifyEscrowLogisticsResponse;
        error:
            | Schema.ForbiddenError
            | Schema.InvalidRequestError
            | Schema.PaymentNotFoundError
            | Schema.PaymentNotPaidError
            | Schema.PgProviderError
            | Schema.UnauthorizedError;
    }

    • parameters: {
          path: {
              paymentId: string;
          };
          body: ModifyEscrowLogisticsBody;
      }

      • path: {
            paymentId: string;
        }

        • paymentId: string

          결제 건 아이디

      • body: ModifyEscrowLogisticsBody

    • success: ModifyEscrowLogisticsResponse

      에스크로 배송 정보 수정 성공 응답

    • error:
          | Schema.ForbiddenError
          | Schema.InvalidRequestError
          | Schema.PaymentNotFoundError
          | Schema.PaymentNotPaidError
          | Schema.PgProviderError
          | Schema.UnauthorizedError

      ModifyEscrowLogisticsError

• /payments/{paymentId}/instant: {
      post: {
          parameters: {
              path: {
                  paymentId: string;
              };
              body: InstantPaymentInput;
          };
          success: PayInstantlyResponse;
          error:
              | Schema.AlreadyPaidError
              | Schema.ChannelNotFoundError
              | Schema.DiscountAmountExceedsTotalAmountError
              | Schema.ForbiddenError
              | Schema.InvalidRequestError
              | Schema.PgProviderError
              | Schema.PromotionPayMethodDoesNotMatchError
              | Schema.SumOfPartsExceedsTotalAmountError
              | Schema.UnauthorizedError;
      };
  }

  • post: {
        parameters: {
            path: {
                paymentId: string;
            };
            body: InstantPaymentInput;
        };
        success: PayInstantlyResponse;
        error:
            | Schema.AlreadyPaidError
            | Schema.ChannelNotFoundError
            | Schema.DiscountAmountExceedsTotalAmountError
            | Schema.ForbiddenError
            | Schema.InvalidRequestError
            | Schema.PgProviderError
            | Schema.PromotionPayMethodDoesNotMatchError
            | Schema.SumOfPartsExceedsTotalAmountError
            | Schema.UnauthorizedError;
    }

    • parameters: {
          path: {
              paymentId: string;
          };
          body: InstantPaymentInput;
      }

      • path: {
            paymentId: string;
        }

        • paymentId: string

          결제 건 아이디

      • body: InstantPaymentInput

    • success: PayInstantlyResponse

      수기 결제 성공 응답

    • error:
          | Schema.AlreadyPaidError
          | Schema.ChannelNotFoundError
          | Schema.DiscountAmountExceedsTotalAmountError
          | Schema.ForbiddenError
          | Schema.InvalidRequestError
          | Schema.PgProviderError
          | Schema.PromotionPayMethodDoesNotMatchError
          | Schema.SumOfPartsExceedsTotalAmountError
          | Schema.UnauthorizedError

      PayInstantlyError

• /payments/{paymentId}/pre-register: {
      post: {
          parameters: {
              path: {
                  paymentId: string;
              };
              body: PreRegisterPaymentBody;
          };
          success: void;
          error:
              | Schema.AlreadyPaidError
              | Schema.ForbiddenError
              | Schema.InvalidRequestError
              | Schema.UnauthorizedError;
      };
  }

  • post: {
        parameters: {
            path: {
                paymentId: string;
            };
            body: PreRegisterPaymentBody;
        };
        success: void;
        error:
            | Schema.AlreadyPaidError
            | Schema.ForbiddenError
            | Schema.InvalidRequestError
            | Schema.UnauthorizedError;
    }

    • parameters: {
          path: {
              paymentId: string;
          };
          body: PreRegisterPaymentBody;
      }

      • path: {
            paymentId: string;
        }

        • paymentId: string

          결제 건 아이디

      • body: PreRegisterPaymentBody

    • success: void

      결제 사전 등록 성공 응답

    • error:
          | Schema.AlreadyPaidError
          | Schema.ForbiddenError
          | Schema.InvalidRequestError
          | Schema.UnauthorizedError

      PreRegisterPaymentError

• /payments/{paymentId}/register-store-receipt: {
      post: {
          parameters: {
              path: {
                  paymentId: string;
              };
              body: RegisterStoreReceiptBody;
          };
          success: RegisterStoreReceiptResponse;
          error:
              | Schema.ForbiddenError
              | Schema.InvalidRequestError
              | Schema.PaymentNotFoundError
              | Schema.PaymentNotPaidError
              | Schema.PgProviderError
              | Schema.UnauthorizedError;
      };
  }

  • post: {
        parameters: {
            path: {
                paymentId: string;
            };
            body: RegisterStoreReceiptBody;
        };
        success: RegisterStoreReceiptResponse;
        error:
            | Schema.ForbiddenError
            | Schema.InvalidRequestError
            | Schema.PaymentNotFoundError
            | Schema.PaymentNotPaidError
            | Schema.PgProviderError
            | Schema.UnauthorizedError;
    }

    • parameters: {
          path: {
              paymentId: string;
          };
          body: RegisterStoreReceiptBody;
      }

      • path: {
            paymentId: string;
        }

        • paymentId: string

          등록할 하위 상점 결제 건 아이디

      • body: RegisterStoreReceiptBody

    • success: RegisterStoreReceiptResponse

      영수증 내 하위 상점 거래 등록 응답

    • error:
          | Schema.ForbiddenError
          | Schema.InvalidRequestError
          | Schema.PaymentNotFoundError
          | Schema.PaymentNotPaidError
          | Schema.PgProviderError
          | Schema.UnauthorizedError

      RegisterStoreReceiptError

• /payments/{paymentId}/resend-webhook: {
      post: {
          parameters: {
              path: {
                  paymentId: string;
              };
              body: ResendWebhookBody;
          };
          success: ResendWebhookResponse;
          error:
              | Schema.ForbiddenError
              | Schema.InvalidRequestError
              | Schema.PaymentNotFoundError
              | Schema.UnauthorizedError
              | Schema.WebhookNotFoundError;
      };
  }

  • post: {
        parameters: {
            path: {
                paymentId: string;
            };
            body: ResendWebhookBody;
        };
        success: ResendWebhookResponse;
        error:
            | Schema.ForbiddenError
            | Schema.InvalidRequestError
            | Schema.PaymentNotFoundError
            | Schema.UnauthorizedError
            | Schema.WebhookNotFoundError;
    }

    • parameters: {
          path: {
              paymentId: string;
          };
          body: ResendWebhookBody;
      }

      • path: {
            paymentId: string;
        }

        • paymentId: string

          결제 건 아이디

      • body: ResendWebhookBody

    • success: ResendWebhookResponse

      웹훅 재발송 응답 정보

    • error:
          | Schema.ForbiddenError
          | Schema.InvalidRequestError
          | Schema.PaymentNotFoundError
          | Schema.UnauthorizedError
          | Schema.WebhookNotFoundError

      ResendWebhookError

• /payments/{paymentId}/schedule: {
      post: {
          parameters: {
              path: {
                  paymentId: string;
              };
              body: CreatePaymentScheduleBody;
          };
          success: CreatePaymentScheduleResponse;
          error:
              | Schema.AlreadyPaidOrWaitingError
              | Schema.BillingKeyAlreadyDeletedError
              | Schema.BillingKeyNotFoundError
              | Schema.ForbiddenError
              | Schema.InvalidRequestError
              | Schema.PaymentScheduleAlreadyExistsError
              | Schema.SumOfPartsExceedsTotalAmountError
              | Schema.UnauthorizedError;
      };
  }

  • post: {
        parameters: {
            path: {
                paymentId: string;
            };
            body: CreatePaymentScheduleBody;
        };
        success: CreatePaymentScheduleResponse;
        error:
            | Schema.AlreadyPaidOrWaitingError
            | Schema.BillingKeyAlreadyDeletedError
            | Schema.BillingKeyNotFoundError
            | Schema.ForbiddenError
            | Schema.InvalidRequestError
            | Schema.PaymentScheduleAlreadyExistsError
            | Schema.SumOfPartsExceedsTotalAmountError
            | Schema.UnauthorizedError;
    }

    • parameters: {
          path: {
              paymentId: string;
          };
          body: CreatePaymentScheduleBody;
      }

      • path: {
            paymentId: string;
        }

        • paymentId: string

          결제 건 아이디

      • body: CreatePaymentScheduleBody

    • success: CreatePaymentScheduleResponse

      결제 예약 성공 응답

    • error:
          | Schema.AlreadyPaidOrWaitingError
          | Schema.BillingKeyAlreadyDeletedError
          | Schema.BillingKeyNotFoundError
          | Schema.ForbiddenError
          | Schema.InvalidRequestError
          | Schema.PaymentScheduleAlreadyExistsError
          | Schema.SumOfPartsExceedsTotalAmountError
          | Schema.UnauthorizedError

      CreatePaymentScheduleError

• /payments/{paymentId}/virtual-account/close: {
      post: {
          parameters: {
              path: {
                  paymentId: string;
              };
              query: {
                  storeId?: string;
              };
          };
          success: CloseVirtualAccountResponse;
          error:
              | Schema.ForbiddenError
              | Schema.InvalidRequestError
              | Schema.PaymentNotFoundError
              | Schema.PaymentNotWaitingForDepositError
              | Schema.PgProviderError
              | Schema.UnauthorizedError;
      };
  }

  • post: {
        parameters: {
            path: {
                paymentId: string;
            };
            query: {
                storeId?: string;
            };
        };
        success: CloseVirtualAccountResponse;
        error:
            | Schema.ForbiddenError
            | Schema.InvalidRequestError
            | Schema.PaymentNotFoundError
            | Schema.PaymentNotWaitingForDepositError
            | Schema.PgProviderError
            | Schema.UnauthorizedError;
    }

    • parameters: {
          path: {
              paymentId: string;
          };
          query: {
              storeId?: string;
          };
      }

      • path: {
            paymentId: string;
        }

        • paymentId: string

          결제 건 아이디

      • query: {
            storeId?: string;
        }

        • OptionalstoreId?: string

          상점 아이디

          접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 토큰에 담긴 상점 아이디를 사용합니다.

    • success: CloseVirtualAccountResponse

      가상계좌 말소 성공 응답

    • error:
          | Schema.ForbiddenError
          | Schema.InvalidRequestError
          | Schema.PaymentNotFoundError
          | Schema.PaymentNotWaitingForDepositError
          | Schema.PgProviderError
          | Schema.UnauthorizedError

      CloseVirtualAccountError