@gj-kit/toss-payments API

This reference is generated from the 0.6.1 release declaration snapshot. Unpublished main APIs are not shown.

`Root entry`

Import: @gj-kit/toss-payments

Symbol	Kind
`andThen`	function
`ApiClientKey`	type
`ApiSecretKey`	type
`AUDIT_REDACTED_KEYS`	constant
`AuditEntry`	interface
`AuditOptions`	interface
`AuditSink`	interface
`BillingErrorCode`	type
`BuiltInRefundPolicyConfig`	type
`CancelErrorCode`	type
`cancelReason`	function
`CancelReason`	type
`cancelRequestId`	function
`CancelRequestId`	type
`CancelTransaction`	interface
`CARD_ISSUER_NAMES_KO`	constant
`CardDetails`	interface
`cardIssuerName`	function
`CardPayment`	interface
`categorizeCancelError`	function
`CLASSIFIED_TOSS_ERROR_CODES`	constant
`classifyTossErrorCode`	function
`compareLedgerRefund`	function
`ConfirmErrorCode`	type
`createCustomRefundPolicy`	function
`createRefundPolicy`	function
`customerKey`	function
`CustomerKey`	type
`CustomRefundPolicyConfig`	interface
`CustomRefundQuoteInput`	interface
`DEFAULT_IDEMPOTENCY_REPLAY_WINDOW_MS`	constant
`DEFAULT_REFUND_QUOTE_TTL_MS`	constant
`deriveIdempotencyKey`	function
`DeriveIdempotencyKeyInput`	interface
`diffPaymentState`	function
`EasyPayDetails`	interface
`EasyPayPayment`	interface
`ElapsedTimeRefundBracket`	interface
`ElapsedTimeRefundPolicyConfig`	interface
`ElapsedTimeRefundQuoteInput`	interface
`Env`	type
`EnvTag`	type
`err`	function
`Err`	interface
`ErrorCategory`	type
`ErrorCodeClassification`	interface
`FullRefundPolicyConfig`	interface
`generateCustomerKey`	function
`generateIdempotencyKey`	function
`generateOrderId`	function
`GiftCertificateDetails`	interface
`GiftCertificatePayment`	interface
`idempotencyKey`	function
`IdempotencyKey`	type
`InvalidInput`	interface
`InvalidPaymentStateSnapshot`	interface
`isAlreadyFullyCanceledError`	function
`isDone`	function
`isErr`	function
`isExecutableRefundQuote`	function
`isFullyCanceled`	function
`isLiveKey`	function
`isOk`	function
`isRetryable`	function
`isTestKey`	function
`isWithinIdempotencyReplayWindow`	function
`KeyParseError`	interface
`KnownCardIssuerCode`	type
`LedgerRefundComparison`	type
`LedgerRefundMismatchDirection`	type
`LedgerRefundShortfall`	type
`LedgerRefundTarget`	interface
`map`	function
`mapErr`	function
`matchesRefundObservedPaymentState`	function
`MobilePhoneDetails`	interface
`MobilePhonePayment`	interface
`mustQueryOutcomeBeforeRetry`	function
`observeRefundPaymentState`	function
`ok`	function
`Ok`	interface
`orderId`	function
`OrderId`	type
`orderName`	function
`OrderName`	type
`orThrow`	function
`OUTCOME_QUERY_FIRST_ERROR_CODES`	constant
`parseApiClientKey`	function
`ParsedRefundQuote`	type
`parsePaymentStateSnapshot`	function
`parseRefundQuote`	function
`parseWidgetClientKey`	function
`Payment`	type
`PaymentAmountState`	type
`PaymentBase`	interface
`PaymentCancelChanges`	interface
`PaymentCancelTransactionSnapshot`	interface
`PaymentCancelTransactionUpdate`	interface
`paymentKey`	function
`PaymentKey`	type
`PaymentLifecycle`	type
`PaymentMethod`	type
`PaymentStateBalanceChange`	interface
`PaymentStateConsistencyIssue`	type
`PaymentStateDiff`	interface
`PaymentStateDiffWarning`	type
`PaymentStateIdentityError`	interface
`PaymentStateIdentityMismatch`	interface
`PaymentStateInput`	type
`PaymentStateSnapshot`	interface
`PaymentStateSnapshotParseReason`	type
`PaymentStateValueChange`	interface
`PaymentStatus`	type
`PendingMethodPayment`	interface
`PercentageRefundPolicyConfig`	interface
`REFUND_RATE_SCALE`	constant
`REFUND_TIME`	constant
`RefundCalculation`	type
`RefundCalculationDetail`	type
`RefundCalendarError`	type
`RefundEntitlement`	type
`RefundObservedCancelState`	interface
`RefundObservedPaymentState`	interface
`RefundPolicy`	interface
`RefundPolicyConfigError`	type
`RefundPolicyIdentity`	interface
`RefundPolicyKind`	type
`RefundQuote`	interface
`RefundQuoteError`	type
`RefundQuoteInput`	interface
`RefundQuoteParseError`	interface
`RefundQuotePolicyMismatchError`	interface
`RefundQuoteRestoreError`	type
`RefundRoundingMode`	type
`remainingCalendarDays`	function
`RemainingCalendarDays`	interface
`RemainingCalendarDaysInput`	interface
`RemainingUnitsRefundPolicyConfig`	interface
`RemainingUnitsRefundQuoteInput`	interface
`Result`	type
`SerializedPaymentStateSnapshot`	interface
`serializePaymentStateSnapshot`	function
`summarizePaymentState`	function
`TOSS_IDEMPOTENCY_KEY_TTL_MS`	constant
`TossApiFailure`	interface
`TransferDetails`	interface
`TransferPayment`	interface
`TransportFailure`	interface
`unwrapOr`	function
`VirtualAccountDetails`	interface
`VirtualAccountPayment`	interface
`WidgetClientKey`	type
`widgetCustomerKey`	function
`WidgetCustomerKey`	type
`WidgetSecretKey`	type

`./browser`

Import: @gj-kit/toss-payments/browser

Symbol	Kind
`AgreementWidget`	interface
`Anonymous`	type
`ANONYMOUS`	constant
`BillingAuthRequest`	type
`loadWidgets`	function
`PaymentRequestOutcome`	type
`RenderedTossWidgets`	interface
`requestBillingAuth`	function
`SdkError`	interface
`TossWidgets`	interface
`TossWidgetsWithAmount`	interface
`WidgetAmount`	interface
`WidgetError`	type
`WidgetPaymentRequest`	interface

`./server`

Import: @gj-kit/toss-payments/server

Symbol	Kind
`andThen`	function
`ApiClientKey`	type
`ApiSecretKey`	type
`asCancelable`	function
`AUDIT_REDACTED_KEYS`	constant
`AuditEntry`	interface
`AuditOptions`	interface
`AuditSink`	interface
`AuthKeyReceived`	interface
`AwaitingDepositCancelable`	interface
`AwaitingDepositRefundRequest`	interface
`BillingApproveError`	type
`BillingAuthCallback`	type
`BillingCapabilities`	interface
`BillingErrorCode`	type
`BillingFlow`	type
`BillingFlowBase`	interface
`BillingKeyDeleteRequest`	interface
`BillingKeyRecord`	interface
`BillingKeySaveOptions`	interface
`BillingKeyStore`	interface
`BillingOrder`	interface
`BillingPayment`	type
`BillingProfile`	interface
`BuiltInRefundPolicyConfig`	type
`CallbackParseError`	interface
`CallbackQueryInput`	type
`CallOptions`	interface
`CancelablePayment`	type
`CancelError`	type
`CancelErrorCode`	type
`CancelOutcome`	interface
`CancelPreflightError`	type
`cancelReason`	function
`CancelReason`	type
`cancelRequestId`	function
`CancelRequestId`	type
`CancelRetryRecord`	interface
`CancelRetryStore`	interface
`CancelRetryTicket`	interface
`CancelTransaction`	interface
`CARD_ISSUER_NAMES_KO`	constant
`CardDetails`	interface
`cardIssuerName`	function
`CardPayment`	interface
`categorizeCancelError`	function
`CLASSIFIED_TOSS_ERROR_CODES`	constant
`classifyTossErrorCode`	function
`compareLedgerRefund`	function
`ConfirmedPayment`	type
`ConfirmedWithoutDepositSecret`	type
`ConfirmError`	type
`ConfirmErrorCode`	type
`ConfirmFlow`	interface
`ConfirmFlowOptions`	interface
`confirmPendingAuth`	function
`ConfirmResolution`	type
`createBillingFlow`	function
`createConfirmFlow`	function
`createCustomRefundPolicy`	function
`createFileAuditSink`	function
`CreateOrderError`	type
`createRefundPolicy`	function
`createTossClient`	function
`createTossEvents`	function
`createTossPayments`	function
`customerKey`	function
`CustomerKey`	type
`CustomRefundPolicyConfig`	interface
`CustomRefundQuoteInput`	interface
`DEFAULT_IDEMPOTENCY_REPLAY_WINDOW_MS`	constant
`DEFAULT_REFUND_QUOTE_TTL_MS`	constant
`defineTossPaymentsConfig`	function
`DepositedVaCancelable`	type
`DepositedVirtualAccountRefundRequest`	interface
`DepositSecretStore`	interface
`deriveIdempotencyKey`	function
`DeriveIdempotencyKeyInput`	interface
`diffPaymentState`	function
`DirectCardIssueInput`	interface
`EasyPayDetails`	interface
`EasyPayPayment`	interface
`ElapsedTimeRefundBracket`	interface
`ElapsedTimeRefundPolicyConfig`	interface
`ElapsedTimeRefundQuoteInput`	interface
`Env`	type
`EnvTag`	type
`err`	function
`Err`	interface
`ErrorCategory`	type
`ErrorCodeClassification`	interface
`executeRefund`	function
`FailCallbackResult`	type
`FullRefundPolicyConfig`	interface
`generateCustomerKey`	function
`generateIdempotencyKey`	function
`generateOrderId`	function
`GiftCertificateDetails`	interface
`GiftCertificatePayment`	interface
`idempotencyKey`	function
`IdempotencyKey`	type
`ImportBillingKeyError`	type
`InvalidInput`	interface
`InvalidPaymentStateSnapshot`	interface
`isAlreadyFullyCanceledError`	function
`isDone`	function
`isErr`	function
`isExecutableRefundQuote`	function
`isFullyCanceled`	function
`isLiveKey`	function
`isOk`	function
`isRetryable`	function
`IssueBillingKeyError`	type
`isTestKey`	function
`isWithinIdempotencyReplayWindow`	function
`KeyKind`	type
`KeyParseError`	interface
`KnownCardIssuerCode`	type
`LedgerRefundComparison`	type
`LedgerRefundMismatchDirection`	type
`LedgerRefundShortfall`	type
`LedgerRefundTarget`	interface
`LookupError`	type
`map`	function
`mapErr`	function
`matchesRefundObservedPaymentState`	function
`MobilePhoneDetails`	interface
`MobilePhonePayment`	interface
`mustQueryOutcomeBeforeRetry`	function
`NoRefundPreparation`	interface
`NotCancelableError`	type
`observeRefundPaymentState`	function
`ok`	function
`Ok`	interface
`orderId`	function
`OrderId`	type
`orderName`	function
`OrderName`	type
`OrderStore`	interface
`orThrow`	function
`OUTCOME_QUERY_FIRST_ERROR_CODES`	constant
`parseApiClientKey`	function
`parseApiSecretKey`	function
`parseBillingAuthCallback`	function
`ParsedRefundQuote`	type
`parseFailCallback`	function
`parsePaymentStateSnapshot`	function
`parseRefundQuote`	function
`parseSecretKey`	function
`parseSuccessCallback`	function
`parseWidgetClientKey`	function
`parseWidgetSecretKey`	function
`PartiallyCancelable`	type
`Payment`	type
`PaymentAmountState`	type
`PaymentBase`	interface
`PaymentCancelChanges`	interface
`PaymentCancelTransactionSnapshot`	interface
`PaymentCancelTransactionUpdate`	interface
`paymentKey`	function
`PaymentKey`	type
`PaymentLifecycle`	type
`PaymentMethod`	type
`PaymentStateBalanceChange`	interface
`PaymentStateConsistencyIssue`	type
`PaymentStateDiff`	interface
`PaymentStateDiffWarning`	type
`PaymentStateIdentityError`	interface
`PaymentStateIdentityMismatch`	interface
`PaymentStateInput`	type
`PaymentStateSnapshot`	interface
`PaymentStateSnapshotParseReason`	type
`PaymentStateValueChange`	interface
`PaymentStatus`	type
`PendingBillingAuth`	interface
`PendingMethodPayment`	interface
`PendingOrder`	interface
`PercentageRefundPolicyConfig`	interface
`prepareRefund`	function
`prepareRefundExecution`	function
`recoverBillingKeyRecord`	function
`REFUND_RATE_SCALE`	constant
`REFUND_TIME`	constant
`refundAccount`	function
`RefundAccount`	interface
`RefundCalculation`	type
`RefundCalculationDetail`	type
`RefundCalendarError`	type
`RefundEntitlement`	type
`RefundExecutionAttempt`	type
`RefundExecutionAttemptOptions`	interface
`RefundExecutionError`	type
`RefundExecutionPlan`	type
`RefundExecutionRequest`	type
`RefundObservedCancelState`	interface
`RefundObservedPaymentState`	interface
`RefundPlanError`	interface
`RefundPlanErrorReason`	type
`RefundPolicy`	interface
`RefundPolicyConfigError`	type
`RefundPolicyIdentity`	interface
`RefundPolicyKind`	type
`RefundPreparation`	type
`RefundQuote`	interface
`RefundQuoteError`	type
`RefundQuoteInput`	interface
`RefundQuoteParseError`	interface
`RefundQuotePolicyMismatchError`	interface
`RefundQuoteRestoreError`	type
`RefundRoundingMode`	type
`RefundRuntimeOptions`	type
`RefundTargetKind`	type
`remainingCalendarDays`	function
`RemainingCalendarDays`	interface
`RemainingCalendarDaysInput`	interface
`RemainingUnitsRefundPolicyConfig`	interface
`RemainingUnitsRefundQuoteInput`	interface
`resolveConfirmFailure`	function
`ResolvedConfirmedPayment`	type
`Result`	type
`RetryOptions`	interface
`RevokeBillingKeyError`	type
`RevokeBillingKeyOutcome`	interface
`SealedBillingKeyRecord`	interface
`SerializedPaymentStateSnapshot`	interface
`serializePaymentStateSnapshot`	function
`SettledCancelable`	type
`SettledRefundRequest`	interface
`StoredOrder`	interface
`StoreFailure`	interface
`summarizePaymentState`	function
`TOSS_IDEMPOTENCY_KEY_TTL_MS`	constant
`TossApiFailure`	interface
`TossCancels`	interface
`TossClientOptions`	interface
`TossEvent`	type
`TossEventMap`	interface
`TossEventName`	type
`TossEvents`	interface
`TossPaymentsApiConfig`	interface
`TossPaymentsBaseConfig`	interface
`TossPaymentsKit`	type
`TossPaymentsWidgetConfig`	interface
`TossServerClient`	interface
`TransferDetails`	interface
`TransferPayment`	interface
`TransportFailure`	interface
`UnverifiedCallback`	interface
`unwrapOr`	function
`VerifiedCheckout`	interface
`VerifyCheckoutError`	type
`VirtualAccountDetails`	interface
`VirtualAccountPayment`	interface
`WidgetClientKey`	type
`widgetCustomerKey`	function
`WidgetCustomerKey`	type
`WidgetSecretKey`	type

`./testing`

Import: @gj-kit/toss-payments/testing

Symbol	Kind
`memoryAuditSink`	function
`memoryBillingKeyStore`	function
`memoryCancelRetryStore`	function
`memoryDedupeStore`	function
`memoryDepositSecretStore`	function
`memoryOrderStore`	function
`signWebhookPayload`	function
`TEST_BILLING_CARD`	constant
`webhookFixture`	constant

`./webhook`

Import: @gj-kit/toss-payments/webhook

Symbol	Kind
`AcceptedWebhook`	type
`ArsReservationChangedEvent`	interface
`BillingDeletedEvent`	interface
`CancelStatusChangedEvent`	interface
`createWebhookVerifier`	function
`CustomerStatusChangedEvent`	interface
`DEFAULT_WEBHOOK_MAX_BODY_BYTES`	constant
`DepositCallbackEvent`	interface
`DepositSecretSource`	interface
`FetchHandlerOptions`	interface
`IncomingHeaders`	type
`LookupError`	type
`MethodUpdatedEvent`	interface
`NodeHandlerOptions`	interface
`NodeIncomingMessageLike`	interface
`NodeServerResponseLike`	interface
`NoPaymentReference`	interface
`OrderPaymentStatusChangedEvent`	interface
`parseSecurityKey`	function
`parseTossTimestamp`	function
`PaymentLookup`	interface
`PaymentStatusChangedEvent`	interface
`PayoutChangedEvent`	interface
`SecretVerified`	interface
`SecurityKey`	type
`SellerChangedEvent`	interface
`SignatureVerified`	interface
`SignedWebhookEvent`	type
`TOSS_WEBHOOK_SOURCE_IPS`	constant
`UnknownWebhookEvent`	interface
`Unverified`	interface
`UnverifiedWebhookEvent`	type
`WebhookClaimState`	type
`WebhookDedupeStore`	interface
`WebhookHandlers`	interface
`WebhookMeta`	interface
`WebhookRejection`	type
`WebhookVerdict`	type
`WebhookVerifier`	interface
`WebhookVerifierConfig`	interface