@delopay/sdk 0.174.0 → 0.176.0

package/dist/index.d.cts

@@ -220,6 +220,8 @@ interface PaymentCreateRequest {
     description?: string | null;
     /** URL to redirect the customer to after payment (required for redirect-based methods). */
     return_url?: string | null;
+    /** URL to leave an unpaid hosted checkout; never falls back to `return_url`. */
+    cancel_url?: string | null;
     /**
      * How long the client secret / hosted checkout link stays usable, in
      * seconds from creation. Omit to inherit the shop's default
@@ -324,6 +326,8 @@ interface PaymentUpdateRequest {
     customer_id?: string | null;
     description?: string | null;
     return_url?: string | null;
+    /** See {@link PaymentCreateRequest.cancel_url}. */
+    cancel_url?: string | null;
     statement_descriptor_name?: string | null;
     statement_descriptor_suffix?: string | null;
     metadata?: Record<string, unknown> | null;
@@ -347,6 +351,8 @@ interface PaymentConfirmRequest {
     payment_method_data?: Record<string, unknown> | null;
     payment_token?: string | null;
     return_url?: string | null;
+    /** See {@link PaymentCreateRequest.cancel_url}. */
+    cancel_url?: string | null;
     billing?: Address | null;
     shipping?: Address | null;
     mandate_id?: string | null;
@@ -444,6 +450,8 @@ interface PaymentResponse {
     description?: string | null;
     /** Redirect URL used after payment completion. */
     return_url?: string | null;
+    /** URL the buyer may use to leave before paying. */
+    cancel_url?: string | null;
     /** Billing address. */
     billing?: Address | null;
     /** Shipping address. */
@@ -3254,6 +3262,7 @@ interface PaymentLinkDetails {
     payment_id: string;
     session_expiry: string;
     merchant_logo: string;
+    cancel_url?: string | null;
     merchant_name: string;
     max_items_visible_after_collapse: number;
     theme: string;
@@ -3277,6 +3286,7 @@ interface PaymentLinkStatusDetails {
     currency: Currency;
     payment_id: string;
     merchant_logo: string;
+    cancel_url?: string | null;
     merchant_name: string;
     created: string;
     status: IntentStatus | 'active' | 'expired';
@@ -5290,6 +5300,8 @@ interface ConnectorListResponse {
 interface ProfileCreateRequest {
     profile_name?: string | null;
     return_url?: string | null;
+    /** Optional default unpaid-checkout exit URL for this shop. */
+    cancel_url?: string | null;
     enable_payment_response_hash?: boolean | null;
     payment_response_hash_key?: string | null;
     redirect_to_merchant_with_http_post?: boolean | null;
@@ -5348,6 +5360,8 @@ interface ProfileCreateRequest {
 interface ProfileUpdateRequest {
     profile_name?: string | null;
     return_url?: string | null;
+    /** Absent leaves unchanged; explicit null clears the shop's Cancel URL. */
+    cancel_url?: string | null;
     enable_payment_response_hash?: boolean | null;
     payment_response_hash_key?: string | null;
     redirect_to_merchant_with_http_post?: boolean | null;
@@ -5423,6 +5437,8 @@ interface ProfileResponse {
     force_3ds_challenge: boolean;
     is_pre_network_tokenization_enabled: boolean;
     return_url?: string | null;
+    /** The shop's optional default unpaid-checkout exit URL. */
+    cancel_url?: string | null;
     payment_response_hash_key?: string | null;
     webhook_details?: WebhookDetails | null;
     metadata?: Record<string, unknown> | null;
@@ -6938,7 +6954,7 @@ type AnalyticsGranularity = 'day' | 'hour' | '30m' | '15m' | '5m';
 /** The dashboards' four outcomes; `open` is processing + awaiting action. */
 type AnalyticsOutcome = 'success' | 'open' | 'failed' | 'void';
 /** Checkout channel token, as the device dashboard's channel series names them. */
-type AnalyticsChannel = 'hosted' | 'embedded' | 'api' | 'dashboard' | 'sdk' | 'unknown';
+type AnalyticsChannel = 'hosted' | 'embedded' | 'auto_redirect' | 'api' | 'dashboard' | 'sdk' | 'unknown';
 /** Sort keys of the payments drill (`GET /analytics/scope/transactions`). */
 type ScopeDrillSortKey = 'created_at' | 'payment_created_at' | 'amount' | 'status' | 'connector' | 'method';
 /** Sort keys of the geo and device drills: the payments keys plus `time_to_pay`. */
@@ -7361,6 +7377,9 @@ interface DeviceChannelBucket {
     hosted: number;
     /** Hosted checkout embedded in the merchant's page. */
     embedded: number;
+    /** Hosted checkout opened through a merchant-authored auto-redirect link.
+     * Absent on routers predating DeloPay-net/delopay-backend#1768. */
+    auto_redirect?: number;
     /** API / server-initiated. */
     api: number;
     dashboard: number;
@@ -9997,7 +10016,7 @@ interface EpayoutsPaypalCaptureResponse {
     matches_order?: boolean;
 }
 /** The closed set of buyer-side checkout events. */
-type CheckoutEventKind$1 = 'native_pane_selected' | 'native_pane_tab_opened' | 'native_pane_tab_blocked' | 'native_pane_abandoned' | 'native_pane_returned';
+type CheckoutEventKind$1 = 'native_pane_selected' | 'native_pane_tab_opened' | 'native_pane_tab_blocked' | 'native_pane_abandoned' | 'native_pane_returned' | 'checkout_cancelled';
 interface RecordCheckoutEventRequest {
     event: CheckoutEventKind$1;
     /** Native-pane catalog key the event is about (`apple_pay`, `klarna`, …). */
@@ -10140,7 +10159,8 @@ interface StripeHostedConfirmRequest {
     confirmation_token?: string | null;
     /**
      * The acquisition channel the checkout reports on the Stripe return URL
-     * (`hosted_checkout` or `hosted_checkout_iframe`).
+     * (`hosted_checkout`, `hosted_checkout_iframe`, or
+     * `hosted_checkout_auto_redirect`).
      */
     pcs?: string | null;
 }
@@ -16805,6 +16825,9 @@ interface CheckoutBranding {
     totalLabel: string;
     showCurrencyCode: boolean;
     showOrderItems: boolean;
+    cancelLinkEnabled: boolean;
+    cancelLinkPosition: 'top' | 'bottom';
+    cancelLinkStyle: 'link' | 'button';
     showSurcharge: boolean;
     surchargePosition: SurchargePosition;
     nativeElementPosition: NativeElementPosition;
@@ -17974,7 +17997,7 @@ declare function focusedCheckoutUrl(params: FocusedCheckoutUrlParams): string;
  * The `native_pane_` prefix is the router's enum on the wire and does not move
  * with the rename — see the module header.
  */
-declare const CHECKOUT_EVENT_KINDS: readonly ["native_pane_selected", "native_pane_tab_opened", "native_pane_tab_blocked", "native_pane_abandoned", "native_pane_returned"];
+declare const CHECKOUT_EVENT_KINDS: readonly ["native_pane_selected", "native_pane_tab_opened", "native_pane_tab_blocked", "native_pane_abandoned", "native_pane_returned", "checkout_cancelled"];
 type CheckoutEventKind = (typeof CHECKOUT_EVENT_KINDS)[number];
 /** @deprecated Renamed to {@link Pane}. Removed in 0.112.0. */
 type StripeNativePane = Pane;

package/dist/index.d.ts

@@ -220,6 +220,8 @@ interface PaymentCreateRequest {
     description?: string | null;
     /** URL to redirect the customer to after payment (required for redirect-based methods). */
     return_url?: string | null;
+    /** URL to leave an unpaid hosted checkout; never falls back to `return_url`. */
+    cancel_url?: string | null;
     /**
      * How long the client secret / hosted checkout link stays usable, in
      * seconds from creation. Omit to inherit the shop's default
@@ -324,6 +326,8 @@ interface PaymentUpdateRequest {
     customer_id?: string | null;
     description?: string | null;
     return_url?: string | null;
+    /** See {@link PaymentCreateRequest.cancel_url}. */
+    cancel_url?: string | null;
     statement_descriptor_name?: string | null;
     statement_descriptor_suffix?: string | null;
     metadata?: Record<string, unknown> | null;
@@ -347,6 +351,8 @@ interface PaymentConfirmRequest {
     payment_method_data?: Record<string, unknown> | null;
     payment_token?: string | null;
     return_url?: string | null;
+    /** See {@link PaymentCreateRequest.cancel_url}. */
+    cancel_url?: string | null;
     billing?: Address | null;
     shipping?: Address | null;
     mandate_id?: string | null;
@@ -444,6 +450,8 @@ interface PaymentResponse {
     description?: string | null;
     /** Redirect URL used after payment completion. */
     return_url?: string | null;
+    /** URL the buyer may use to leave before paying. */
+    cancel_url?: string | null;
     /** Billing address. */
     billing?: Address | null;
     /** Shipping address. */
@@ -3254,6 +3262,7 @@ interface PaymentLinkDetails {
     payment_id: string;
     session_expiry: string;
     merchant_logo: string;
+    cancel_url?: string | null;
     merchant_name: string;
     max_items_visible_after_collapse: number;
     theme: string;
@@ -3277,6 +3286,7 @@ interface PaymentLinkStatusDetails {
     currency: Currency;
     payment_id: string;
     merchant_logo: string;
+    cancel_url?: string | null;
     merchant_name: string;
     created: string;
     status: IntentStatus | 'active' | 'expired';
@@ -5290,6 +5300,8 @@ interface ConnectorListResponse {
 interface ProfileCreateRequest {
     profile_name?: string | null;
     return_url?: string | null;
+    /** Optional default unpaid-checkout exit URL for this shop. */
+    cancel_url?: string | null;
     enable_payment_response_hash?: boolean | null;
     payment_response_hash_key?: string | null;
     redirect_to_merchant_with_http_post?: boolean | null;
@@ -5348,6 +5360,8 @@ interface ProfileCreateRequest {
 interface ProfileUpdateRequest {
     profile_name?: string | null;
     return_url?: string | null;
+    /** Absent leaves unchanged; explicit null clears the shop's Cancel URL. */
+    cancel_url?: string | null;
     enable_payment_response_hash?: boolean | null;
     payment_response_hash_key?: string | null;
     redirect_to_merchant_with_http_post?: boolean | null;
@@ -5423,6 +5437,8 @@ interface ProfileResponse {
     force_3ds_challenge: boolean;
     is_pre_network_tokenization_enabled: boolean;
     return_url?: string | null;
+    /** The shop's optional default unpaid-checkout exit URL. */
+    cancel_url?: string | null;
     payment_response_hash_key?: string | null;
     webhook_details?: WebhookDetails | null;
     metadata?: Record<string, unknown> | null;
@@ -6938,7 +6954,7 @@ type AnalyticsGranularity = 'day' | 'hour' | '30m' | '15m' | '5m';
 /** The dashboards' four outcomes; `open` is processing + awaiting action. */
 type AnalyticsOutcome = 'success' | 'open' | 'failed' | 'void';
 /** Checkout channel token, as the device dashboard's channel series names them. */
-type AnalyticsChannel = 'hosted' | 'embedded' | 'api' | 'dashboard' | 'sdk' | 'unknown';
+type AnalyticsChannel = 'hosted' | 'embedded' | 'auto_redirect' | 'api' | 'dashboard' | 'sdk' | 'unknown';
 /** Sort keys of the payments drill (`GET /analytics/scope/transactions`). */
 type ScopeDrillSortKey = 'created_at' | 'payment_created_at' | 'amount' | 'status' | 'connector' | 'method';
 /** Sort keys of the geo and device drills: the payments keys plus `time_to_pay`. */
@@ -7361,6 +7377,9 @@ interface DeviceChannelBucket {
     hosted: number;
     /** Hosted checkout embedded in the merchant's page. */
     embedded: number;
+    /** Hosted checkout opened through a merchant-authored auto-redirect link.
+     * Absent on routers predating DeloPay-net/delopay-backend#1768. */
+    auto_redirect?: number;
     /** API / server-initiated. */
     api: number;
     dashboard: number;
@@ -9997,7 +10016,7 @@ interface EpayoutsPaypalCaptureResponse {
     matches_order?: boolean;
 }
 /** The closed set of buyer-side checkout events. */
-type CheckoutEventKind$1 = 'native_pane_selected' | 'native_pane_tab_opened' | 'native_pane_tab_blocked' | 'native_pane_abandoned' | 'native_pane_returned';
+type CheckoutEventKind$1 = 'native_pane_selected' | 'native_pane_tab_opened' | 'native_pane_tab_blocked' | 'native_pane_abandoned' | 'native_pane_returned' | 'checkout_cancelled';
 interface RecordCheckoutEventRequest {
     event: CheckoutEventKind$1;
     /** Native-pane catalog key the event is about (`apple_pay`, `klarna`, …). */
@@ -10140,7 +10159,8 @@ interface StripeHostedConfirmRequest {
     confirmation_token?: string | null;
     /**
      * The acquisition channel the checkout reports on the Stripe return URL
-     * (`hosted_checkout` or `hosted_checkout_iframe`).
+     * (`hosted_checkout`, `hosted_checkout_iframe`, or
+     * `hosted_checkout_auto_redirect`).
      */
     pcs?: string | null;
 }
@@ -16805,6 +16825,9 @@ interface CheckoutBranding {
     totalLabel: string;
     showCurrencyCode: boolean;
     showOrderItems: boolean;
+    cancelLinkEnabled: boolean;
+    cancelLinkPosition: 'top' | 'bottom';
+    cancelLinkStyle: 'link' | 'button';
     showSurcharge: boolean;
     surchargePosition: SurchargePosition;
     nativeElementPosition: NativeElementPosition;
@@ -17974,7 +17997,7 @@ declare function focusedCheckoutUrl(params: FocusedCheckoutUrlParams): string;
  * The `native_pane_` prefix is the router's enum on the wire and does not move
  * with the rename — see the module header.
  */
-declare const CHECKOUT_EVENT_KINDS: readonly ["native_pane_selected", "native_pane_tab_opened", "native_pane_tab_blocked", "native_pane_abandoned", "native_pane_returned"];
+declare const CHECKOUT_EVENT_KINDS: readonly ["native_pane_selected", "native_pane_tab_opened", "native_pane_tab_blocked", "native_pane_abandoned", "native_pane_returned", "checkout_cancelled"];
 type CheckoutEventKind = (typeof CHECKOUT_EVENT_KINDS)[number];
 /** @deprecated Renamed to {@link Pane}. Removed in 0.112.0. */
 type StripeNativePane = Pane;

package/dist/index.js

@@ -215,7 +215,7 @@ import {
   validatePanes,
   verticalGapValue,
   visibleCustomFields
-} from "./chunk-7KHTBFO6.js";
+} from "./chunk-OBEPMMEL.js";
 export {
   AIRWALLEX_AUTOFILL_TREATMENTS,
   AIRWALLEX_CARD_LAYOUTS,

package/dist/internal.cjs

@@ -7800,6 +7800,9 @@ var DEFAULT_BRANDING_BASE = {
   totalLabel: "Total",
   showCurrencyCode: false,
   showOrderItems: true,
+  cancelLinkEnabled: true,
+  cancelLinkPosition: "top",
+  cancelLinkStyle: "link",
   // Each flat field keeps its meaning: what the merchant wrote, used in every
   // locale that carries no override. Empty maps therefore change nothing for a
   // profile saved before translations existed.
@@ -8618,6 +8621,17 @@ function decodeBranding(source) {
     totalLabel: s(extras["totalLabel"]) || DEFAULT_BRANDING.totalLabel,
     showCurrencyCode: parseBool(extras["showCurrencyCode"], DEFAULT_BRANDING.showCurrencyCode),
     showOrderItems: parseBool(extras["showOrderItems"], DEFAULT_BRANDING.showOrderItems),
+    cancelLinkEnabled: parseBool(extras["cancelLinkEnabled"], DEFAULT_BRANDING.cancelLinkEnabled),
+    cancelLinkPosition: pickEnum(
+      extras["cancelLinkPosition"],
+      ["top", "bottom"],
+      DEFAULT_BRANDING.cancelLinkPosition
+    ),
+    cancelLinkStyle: pickEnum(
+      extras["cancelLinkStyle"],
+      ["link", "button"],
+      DEFAULT_BRANDING.cancelLinkStyle
+    ),
     trustBadges: trustRow.trustBadges,
     notices: trustRow.notices,
     customFields: decodedCustomFields ?? [],
@@ -8857,6 +8871,9 @@ function encodeBranding(branding, base) {
     totalLabel: branding.totalLabel,
     showCurrencyCode: String(branding.showCurrencyCode),
     showOrderItems: String(branding.showOrderItems),
+    cancelLinkEnabled: String(branding.cancelLinkEnabled),
+    cancelLinkPosition: branding.cancelLinkPosition,
+    cancelLinkStyle: branding.cancelLinkStyle,
     showLogo: String(branding.showLogo),
     logoShape: branding.logoShape,
     logoSize: branding.logoSize,
@@ -9124,6 +9141,17 @@ function parseImportedBranding(raw) {
     trustBadges,
     notices,
     customFields,
+    cancelLinkEnabled: parseBool(root["cancelLinkEnabled"], dflt.cancelLinkEnabled),
+    cancelLinkPosition: pickEnum(
+      root["cancelLinkPosition"],
+      ["top", "bottom"],
+      dflt.cancelLinkPosition
+    ),
+    cancelLinkStyle: pickEnum(
+      root["cancelLinkStyle"],
+      ["link", "button"],
+      dflt.cancelLinkStyle
+    ),
     // An export writes the decoded maps; a hand-written file may carry the
     // JSON strings the bag uses. Both are accepted, and neither is required.
     methodSectionOrder: parseSectionOrderLoose(root[METHOD_SECTION_ORDER_KEY]),
@@ -10253,7 +10281,8 @@ var CHECKOUT_EVENT_KINDS = [
   "native_pane_tab_opened",
   "native_pane_tab_blocked",
   "native_pane_abandoned",
-  "native_pane_returned"
+  "native_pane_returned",
+  "checkout_cancelled"
 ];
 var STRIPE_NATIVE_PANE_METHODS = STRIPE_FALLBACK_PANE_METHODS;
 var NATIVE_PANE_ICON_KEYS = PANE_ICON_KEYS;