@zkp2p/pay-shared 4.0.1 → 5.0.0

package/dist/types.d.ts

@@ -62,6 +62,7 @@ export type CheckoutMethodType = typeof CheckoutMethod[keyof typeof CheckoutMeth
 export declare const FeePayer: {
     readonly MERCHANT: "MERCHANT";
     readonly PAYEE: "PAYEE";
+    readonly SPLIT: "SPLIT";
 };
 export type FeePayerType = typeof FeePayer[keyof typeof FeePayer];
 export declare const MerchantPaymentFlowMode: {
@@ -147,11 +148,95 @@ export type SettlementReferralFeeEntry = {
     recipient: string;
     feeUsdc: string;
 };
+/** FIXED orders carry an amount from creation; OPEN orders get one when the buyer starts a payment. */
+export declare const OrderAmountMode: {
+    readonly FIXED: "FIXED";
+    readonly OPEN: "OPEN";
+};
+export type OrderAmountModeType = typeof OrderAmountMode[keyof typeof OrderAmountMode];
+/**
+ * Why the buyer can no longer change an open order's amount. Precedence when several apply:
+ * PAID, then PAYMENT_MAY_SETTLE, then PAYMENT_IN_PROGRESS.
+ */
+export declare const AmountLockReason: {
+    /** Only CREATED non-Zcash payments lock the amount; cancelling them unlocks it. */
+    readonly PAYMENT_IN_PROGRESS: "PAYMENT_IN_PROGRESS";
+    /** An EXPIRED payment, a locking Zcash payment or a reopenable FAILED Relay payment can still settle; cancelling cannot unlock it. */
+    readonly PAYMENT_MAY_SETTLE: "PAYMENT_MAY_SETTLE";
+    /** A SETTLED payment exists. */
+    readonly PAID: "PAID";
+};
+export type AmountLockReasonType = typeof AmountLockReason[keyof typeof AmountLockReason];
+export declare const OpenAmountErrorCode: {
+    readonly OPEN_AMOUNT_INVALID: "OPEN_AMOUNT_INVALID";
+    readonly OPEN_AMOUNT_DISABLED: "OPEN_AMOUNT_DISABLED";
+    readonly AMOUNT_REQUIRED: "AMOUNT_REQUIRED";
+    readonly AMOUNT_NOT_ALLOWED: "AMOUNT_NOT_ALLOWED";
+    readonly AMOUNT_OUT_OF_RANGE: "AMOUNT_OUT_OF_RANGE";
+    readonly AMOUNT_LOCKED: "AMOUNT_LOCKED";
+    readonly AMOUNT_CONFLICT: "AMOUNT_CONFLICT";
+    readonly RESIZE_NOT_SUPPORTED: "RESIZE_NOT_SUPPORTED";
+};
+export type OpenAmountErrorCodeType = typeof OpenAmountErrorCode[keyof typeof OpenAmountErrorCode];
+/** Merchant request shape. Amounts are positive decimals in `currency` with at most 2 decimals. */
+export type OpenAmountInput = {
+    currency: string;
+    minAmount?: string;
+    maxAmount?: string;
+    presets?: string[];
+};
+/** Stored + API shape (normalized: upper-case currency, 2-dp decimal strings, presets sorted asc, unique). */
+export type OpenAmountConfig = {
+    currency: string;
+    minAmount: string | null;
+    maxAmount: string | null;
+    presets: string[];
+};
+/** The buyer's saved amount and the currency they typed it in (the checkout's selected currency, which may differ from `openAmount.currency`). */
+export type OpenAmountSavedInput = {
+    amount: string;
+    currency: string;
+};
+/**
+ * Platform-quotes `openAmountDisplay` (amendment 2026-10-05): an unlocked open order's range and
+ * presets in the request's `fiatCurrency`. In the order's own currency the merchant's values are
+ * exact, cents kept; in any other currency they are whole units (minimum rounded up, maximum down,
+ * presets half-up and clamped into the range). The bounds and `currencyPerOrderUnit` are null, and
+ * `presets` is empty, when an exchange rate is unavailable.
+ */
+export type OpenAmountDisplay = {
+    currency: string;
+    effectiveMin: string | null;
+    effectiveMax: string | null;
+    presets: string[];
+    /** Units of `currency` one unit of `openAmount.currency` buys at the rates used, as a decimal string; null when unavailable. */
+    currencyPerOrderUnit: string | null;
+};
+/** Hosted (checkout) only. */
+export type HostedOpenAmount = OpenAmountConfig & {
+    /** In `currency`, 2 dp, rounded UP. Null while locked, once FULFILLED or CANCELLED, or when the live rate is unavailable. */
+    effectiveMin: string | null;
+    /** In `currency`, 2 dp, rounded DOWN. Null while locked, once FULFILLED or CANCELLED, or when the live rate is unavailable. */
+    effectiveMax: string | null;
+    /** The buyer's saved amount in the currency they typed it in, or null before the first payment start. */
+    savedInput: OpenAmountSavedInput | null;
+};
+/** `ORDER_AMOUNT_SET` webhook detail. */
+export type OrderAmountChange = {
+    previousAmountUsdc: string | null;
+    newAmountUsdc: string;
+    /** The amount the buyer typed, in the currency they typed it in (the checkout's selected currency). */
+    fiat: OpenAmountSavedInput;
+    amountVersion: number;
+};
 type CreateOrderRequestBase = {
+    idempotencyKey?: string;
     destinationAddress?: string;
     destinationToken?: string;
     destinationChainId?: number;
     feePayer?: FeePayerType;
+    /** SPLIT buyer share of total fees, in basis points (0–10000, steps of 1000). */
+    buyerFeeShareBps?: number;
     enabledRails?: string[];
     dynamicOrdersEnabled?: boolean;
     successUrl?: string | null;
@@ -162,13 +247,21 @@ type CreateOrderRequestWithUsdc = CreateOrderRequestBase & {
     requestedUsdcAmount: string;
     requestedFiatAmount?: never;
     requestedFiatCurrency?: never;
+    openAmount?: never;
 };
 type CreateOrderRequestWithFiat = CreateOrderRequestBase & {
     requestedUsdcAmount?: never;
     requestedFiatAmount: string;
     requestedFiatCurrency: string;
+    openAmount?: never;
 };
-export type CreateOrderRequest = CreateOrderRequestWithUsdc | CreateOrderRequestWithFiat;
+type CreateOrderRequestWithOpenAmount = CreateOrderRequestBase & {
+    requestedUsdcAmount?: never;
+    requestedFiatAmount?: never;
+    requestedFiatCurrency?: never;
+    openAmount: OpenAmountInput;
+};
+export type CreateOrderRequest = CreateOrderRequestWithUsdc | CreateOrderRequestWithFiat | CreateOrderRequestWithOpenAmount;
 export type CheckoutRequest = CreateOrderRequest;
 export type MerchantCheckoutTheme = {
     presetName?: 'default' | 'dark' | 'light' | 'custom';
@@ -196,7 +289,7 @@ export type CheckoutMerchant = {
     /** Whether the merchant has been verified by ZKP2P. */
     verified: boolean;
 };
-export type CheckoutOrder = {
+type CheckoutOrderBase = {
     id: string;
     merchantId: string;
     status: CheckoutOrderStatusType;
@@ -208,12 +301,18 @@ export type CheckoutOrder = {
     refundTransactionHash: string | null;
     refundMetadata: unknown | null;
     inPersonCheckout: boolean;
-    requestedUsdcAmount: string;
-    remainingUsdcAmount: string;
+    /**
+     * USDC the customer would be charged for the current outstanding balance if they
+     * paid by Apple Pay, grossed up by the merchant's Apple Pay fee when the payer
+     * owes it. Hosted aggregates only; null when Apple Pay is disabled or pricing
+     * cannot be resolved. Checkout hides Apple Pay when it is above the 2,500 USDC cap.
+     */
+    applePayChargeUsdcAmount?: string | null;
     destinationAddress: string;
     destinationToken: string;
     destinationChainId: string;
     feePayer: FeePayerType;
+    buyerFeeShareBps: number;
     enabledRails: string[];
     successUrl: string | null;
     cancelUrl: string | null;
@@ -231,7 +330,34 @@ export type CheckoutOrder = {
     createdAt: string;
     updatedAt: string | null;
 };
+export type FixedAmountCheckoutOrder = CheckoutOrderBase & {
+    amountMode: typeof OrderAmountMode.FIXED;
+    requestedUsdcAmount: string;
+    remainingUsdcAmount: string;
+};
+/** Amounts stay null until the buyer starts the first payment; `amountVersion` is 0 until then. */
+export type OpenAmountCheckoutOrder = CheckoutOrderBase & {
+    amountMode: typeof OrderAmountMode.OPEN;
+    requestedUsdcAmount: string | null;
+    remainingUsdcAmount: string | null;
+    openAmount: OpenAmountConfig;
+    amountVersion: number;
+};
+/** Narrow on `amountMode` before reading amounts. */
+export type CheckoutOrder = FixedAmountCheckoutOrder | OpenAmountCheckoutOrder;
+/** Hosted aggregate shape of an open order: effective range, saved input and lock state. */
+export type HostedOpenAmountCheckoutOrder = Omit<OpenAmountCheckoutOrder, 'openAmount'> & {
+    openAmount: HostedOpenAmount;
+    /** Computed server-side from the order's payments; null means the buyer may change the amount. */
+    amountLock: AmountLockReasonType | null;
+};
+export type HostedCheckoutOrder = FixedAmountCheckoutOrder | HostedOpenAmountCheckoutOrder;
 export type CheckoutPaymentQuote = {
+    /** Full-size economics when Peer funds a smaller executable intent. */
+    amountAdjustment?: {
+        requestedSignalAmountRaw: string;
+        buyerFiatAmount: string;
+    };
     conversionRate?: string;
     signalIntent: {
         processorName: string;
@@ -266,6 +392,8 @@ export type CheckoutNearbySuggestion = {
     tokenAmount: string;
     percentDifference: string;
     rail: string;
+    /** Open-amount orders only: the suggestion in the quote's `fiatCurrency`, 2 dp, rounded down. */
+    inputAmount?: string;
 };
 export type CheckoutNearbySuggestions = {
     status: 'suggestions' | 'none' | 'ineligible' | 'unavailable';
@@ -308,6 +436,31 @@ export type CheckoutQuotes = {
     fiatCurrency: string;
     platforms: CheckoutQuoteEntry[];
     nearbySuggestions?: CheckoutNearbySuggestions;
+    /** Open order with no saved amount and no `amount` query parameter: `platforms` is empty. */
+    amountRequired?: true;
+    /** Open orders, when `amount` (in `fiatCurrency`) was sent: the draft converted to USDC. */
+    amountUsdc?: string;
+    /** Open orders, when `amount` was sent: Apple Pay pricing of the draft. */
+    applePay?: {
+        chargeUsdcAmount: string | null;
+        eligible: boolean;
+    };
+    /** Unlocked open orders that are not fulfilled or cancelled, with or without `amount`: the range and presets in `fiatCurrency`. */
+    openAmountDisplay?: OpenAmountDisplay;
+};
+export declare const PaymentPenaltyKind: {
+    readonly PURCHASE_PROTECTION: "PURCHASE_PROTECTION";
+    readonly CROSS_CURRENCY: "CROSS_CURRENCY";
+};
+export type PaymentPenaltyKindType = (typeof PaymentPenaltyKind)[keyof typeof PaymentPenaltyKind];
+/** One attestation-applied reduction of the credited fiat amount. Amounts are in the payment's `currency`. */
+export type PaymentPenalty = {
+    kind: PaymentPenaltyKindType;
+    penaltyBps: number;
+    /** Pre-penalty amount in `payment.currency`, 2-decimal string. */
+    originalAmount: string;
+    /** Post-penalty amount actually credited, same units. */
+    attestedAmount: string;
 };
 export type CheckoutPayment = {
     id: string;
@@ -315,6 +468,7 @@ export type CheckoutPayment = {
     status: CheckoutPaymentStatusType;
     chargebackStatus: PaymentChargebackStatusType;
     chargeback: PaymentChargebackFact | null;
+    penalties: PaymentPenalty[];
     rail: string;
     paymentMethodId: string | null;
     proofMode: ProofMode;
@@ -346,15 +500,25 @@ export type CheckoutAggregatePayment = Omit<CheckoutPayment, 'paymentMethodId'>
     paymentMethodId?: string | null;
 };
 export type CheckoutAggregate = {
-    order: CheckoutOrder;
+    order: HostedCheckoutOrder;
     merchant: CheckoutMerchant;
     currentPayment: CheckoutAggregatePayment | null;
 };
+/** Public GET /api/v1/orders/:orderId responseObject. */
+export type HostedCheckoutResponse = CheckoutAggregate & {
+    paymentCreationPaused: boolean;
+};
 export type CreateOrderResponse = {
     order: CheckoutOrder;
+} & ({
     orderToken: string;
-};
-export type CreatePaymentRequest = {
+    idempotentReplay?: never;
+} | {
+    orderToken: null;
+    idempotentReplay: true;
+});
+type CreatePaymentRequestBase = {
+    onrampProvider?: 'coinbase_apple_pay';
     rail: string;
     paymentMethodId?: string;
     fiatCurrency?: string;
@@ -364,6 +528,23 @@ export type CreatePaymentRequest = {
     excludedPayToValues?: string[];
     refundTo?: string;
 };
+/**
+ * Open-amount orders: `amount`, the fiat `amountCurrency` it is typed in (the checkout's selected
+ * currency, sent on crypto and Apple Pay starts too) and the `amountVersion` the buyer loaded travel
+ * together, or not at all.
+ * On fiat rails, starts with `amount` require `fiatCurrency` to equal `amountCurrency`;
+ * omitted `fiatCurrency` means USD. A mismatch returns HTTP 400. Crypto and Apple Pay
+ * starts are exempt from this check.
+ */
+export type CreatePaymentRequest = CreatePaymentRequestBase & ({
+    amount?: never;
+    amountCurrency?: never;
+    expectedAmountVersion?: never;
+} | {
+    amount: string;
+    amountCurrency: string;
+    expectedAmountVersion: number;
+});
 export type CheckoutPaymentCreationResponse = CheckoutPayment & {
     relayerTransactionId?: string;
     recipientRecovery?: 'matched' | 'missed' | 'not_applicable';
@@ -371,9 +552,9 @@ export type CheckoutPaymentCreationResponse = CheckoutPayment & {
 export type PaymentDeeplinkResponse = {
     paymentId: string;
     orderId: string;
-    intentHash: string;
+    intentHash: string | null;
     url: string;
-    proofSubmissionUrl: string;
+    proofSubmissionUrl: string | null;
     checkoutReturnUrl: string;
     linkKind?: 'app_clip' | 'deeplink';
 };
@@ -382,7 +563,9 @@ export type MerchantConfig = {
     id: string;
     merchantId: string;
     feePayer: FeePayerType;
+    buyerFeeShareBps: number;
     enabledRails: string[];
+    applePayAvailable: boolean;
     defaultPaymentCurrency: string | null;
     destinationChainId: string;
     destinationToken: string;
@@ -393,15 +576,27 @@ export type MerchantConfig = {
     platformReferralFeeConfig: ReferralFeeConfig | null;
     referralSplitConfig: ReferralSplitConfig | null;
     flatFeePricing: boolean;
+    /** Admin-managed: this merchant may create Master Merchant Account sub-merchants. */
+    masterMerchantEnabled: boolean;
+    /** Admin-managed cap, in bps, for the master merchant fee on this merchant's sub-merchants; null means no Master Merchant Account-specific cap. */
+    masterMerchantMaxFeeBps: number | null;
     createdAt: string;
     updatedAt: string | null;
 };
+export declare const MerchantUserRole: {
+    readonly OWNER: "OWNER";
+    readonly MANAGER: "MANAGER";
+    readonly CASHIER: "CASHIER";
+};
+export type MerchantUserRoleType = typeof MerchantUserRole[keyof typeof MerchantUserRole];
 export type MerchantUser = {
     id: string;
     email: string | null;
     privyUserId: string | null;
     v1PrivyUserId: string | null;
-    role: 'OWNER' | 'MANAGER' | 'CASHIER';
+    role: MerchantUserRoleType;
+    /** Master Merchant Account seat after an ownership transfer: it cannot be removed by merchant users, only by an admin. */
+    removalLocked: boolean;
     merchantId: string | null;
     createdAt: string;
     updatedAt: string | null;
@@ -417,6 +612,8 @@ export type MerchantProfile = {
     onboardingCompletedAt: string | null;
     onboardingSkippedAt: string | null;
     apiKey: string;
+    /** Canonical IPv4/IPv6 CIDR entries allowed to use the API key; empty means the allowlist is off. */
+    apiKeyIpAllowlist: string[];
     environment: MerchantEnvironmentType;
     sandboxMerchantId: string | null;
     inPersonCheckoutEnabled: boolean;
@@ -425,12 +622,16 @@ export type MerchantProfile = {
     v1EvmWalletAddress: string | null;
     v1SolanaWalletAddress: string | null;
     tier: MerchantTierName | null;
+    /** The Master Merchant Account merchant that created this sub-merchant; null for every other merchant. */
+    masterMerchantId: string | null;
     createdAt: string;
     updatedAt: string | null;
     merchantConfig: MerchantConfig | null;
     merchantUsers: MerchantUser[];
 };
+export declare const PAYMENT_CREATION_PAUSED_MESSAGE = "Payments are temporarily paused. Please try again shortly.";
 export declare const OrderErrorCode: {
+    readonly PAYMENTS_PAUSED: "PAYMENTS_PAUSED";
     readonly PROOF_INVALID: "PROOF_INVALID";
     readonly PROOF_EXPIRED: "PROOF_EXPIRED";
     readonly PROOF_RECIPIENT_MISMATCH: "PROOF_RECIPIENT_MISMATCH";
@@ -443,6 +644,7 @@ export declare const OrderErrorCode: {
     readonly ATTESTATION_ERROR: "ATTESTATION_ERROR";
     readonly BRIDGE_TIMEOUT: "BRIDGE_TIMEOUT";
     readonly FEE_THRESHOLD_EXCEEDED: "FEE_THRESHOLD_EXCEEDED";
+    readonly INTENT_ABOVE_MAX: "INTENT_ABOVE_MAX";
     readonly SDK_ERROR: "SDK_ERROR";
     readonly UNKNOWN_ERROR: "UNKNOWN_ERROR";
 };
@@ -691,7 +893,14 @@ export type StartSessionRequest = {
     originToken: PayCryptoTokenSymbol;
 };
 export type RelayCryptoPaymentStatus = 'refund' | 'delayed' | 'waiting' | 'failure' | 'pending' | 'success';
+export type NearIntentsPaymentDetails = {
+    status: 'PENDING_DEPOSIT' | 'KNOWN_DEPOSIT_TX' | 'INCOMPLETE_DEPOSIT' | 'PROCESSING' | 'SUCCESS' | 'REFUNDED' | 'FAILED';
+    deadline: string;
+    refundAddress: string;
+    refundedAmount?: string;
+};
 export type CheckoutCryptoPayment = {
+    nearIntents?: NearIntentsPaymentDetails;
     requestId: string;
     status: RelayCryptoPaymentStatus;
     depositAddress: string;
@@ -788,6 +997,12 @@ export type OnboardingStepState = {
     status: OnboardingStepStatusValue;
     verifiedBy: OnboardingStepVerifiedByValue;
 };
+/**
+ * responseObject of GET /api/v1/merchants/dashboard/me/onboarding,
+ * POST /api/v1/merchants/dashboard/me/onboarding/steps/:stepId/ack, and
+ * POST /api/v1/merchants/dashboard/me/onboarding/skip.
+ * For POST routes, this is the state after the write is applied.
+ */
 export type MerchantOnboardingResponse = {
     path: MerchantIntegrationPathValue | null;
     sandboxApiKey: string | null;
@@ -795,11 +1010,25 @@ export type MerchantOnboardingResponse = {
     skippedAt: string | null;
     steps: OnboardingStepState[];
 };
+export declare const MERCHANT_REFERRAL_FEE_BPS_BY_TIER: Readonly<Record<MerchantTierName, number>>;
+export type MerchantReferralReferredMerchant = {
+    id: string;
+    name: string;
+    createdAt: string;
+};
+export type MerchantReferralProgramResponse = {
+    code: string;
+    referralFeeBpsByTier: Readonly<Record<MerchantTierName, number>>;
+    recipientAddress: string;
+    totalReferred: number;
+    referredMerchants: MerchantReferralReferredMerchant[];
+};
 export declare const WebhookEventType: {
     readonly ORDER_CREATED: "ORDER_CREATED";
     readonly ORDER_FULFILLED: "ORDER_FULFILLED";
     readonly ORDER_CANCELLED: "ORDER_CANCELLED";
     readonly ORDER_RESIZED: "ORDER_RESIZED";
+    readonly ORDER_AMOUNT_SET: "ORDER_AMOUNT_SET";
     readonly PAYMENT_CREATED: "PAYMENT_CREATED";
     readonly PAYMENT_SETTLED: "PAYMENT_SETTLED";
     readonly PAYMENT_CANCELLED: "PAYMENT_CANCELLED";
@@ -868,6 +1097,8 @@ export type WebhookPayload = {
             previousAmountUsdc: string;
             newAmountUsdc: string;
         };
+        /** Only on `ORDER_AMOUNT_SET`. */
+        amountChange?: OrderAmountChange;
     };
 };
 export type CreateWebhookRequest = {
@@ -897,4 +1128,77 @@ export type TestWebhookResponse = {
     responseCode?: number | null;
     error?: string | null;
 };
+/**
+ * Wallet-snapshot fence rejections (ownership-transfer era rule). PR 4-6 add keys to this object.
+ * MERCHANT_OWNERSHIP_CHANGED is retryable: an order insert lost the era it read its wallet in.
+ * ORDER_FROM_PREVIOUS_OWNER is final: the order belongs to an earlier owner's era.
+ */
+export declare const MerchantOwnershipErrorCode: {
+    readonly MERCHANT_OWNERSHIP_CHANGED: "MERCHANT_OWNERSHIP_CHANGED";
+    readonly ORDER_FROM_PREVIOUS_OWNER: "ORDER_FROM_PREVIOUS_OWNER";
+    readonly MEMBER_LOCKED: "MEMBER_LOCKED";
+    /** 403: the current merchant is not an enabled, LIVE, eligible Master Merchant Account. */
+    readonly MASTER_MERCHANT_NOT_ENABLED: "MASTER_MERCHANT_NOT_ENABLED";
+    /** 422: the master merchant fee is above the Master Merchant Account's masterMerchantMaxFeeBps, only when the Master Merchant Account has a cap. */
+    readonly MASTER_MERCHANT_FEE_EXCEEDS_CAP: "MASTER_MERCHANT_FEE_EXCEEDS_CAP";
+    /** 422: a payment method's configured fees for some amount band would exceed the max fee. */
+    readonly MASTER_MERCHANT_FEE_EXCEEDS_MAX_FEE: "MASTER_MERCHANT_FEE_EXCEEDS_MAX_FEE";
+    /** 409: the Master Merchant Account can no longer change this sub merchant's fee (transferred, or a transfer is pending). */
+    readonly MASTER_MERCHANT_FEE_LOCKED: "MASTER_MERCHANT_FEE_LOCKED";
+    readonly TRANSFER_ALREADY_PENDING: "TRANSFER_ALREADY_PENDING";
+    readonly WALLET_SETUP_REQUIRED: "WALLET_SETUP_REQUIRED";
+    readonly TERMS_CHANGED: "TERMS_CHANGED";
+    readonly TRANSFER_NOT_FOUND: "TRANSFER_NOT_FOUND";
+    readonly TRANSFER_EMAIL_MISMATCH: "TRANSFER_EMAIL_MISMATCH";
+    readonly TRANSFER_UNAVAILABLE: "TRANSFER_UNAVAILABLE";
+};
+export type MerchantOwnershipErrorCodeType = typeof MerchantOwnershipErrorCode[keyof typeof MerchantOwnershipErrorCode];
+export declare const MERCHANT_OWNERSHIP_CHANGED_MESSAGE = "The merchant account changed owners while this order was being created. Retry to create it for the new owner.";
+export declare const ORDER_FROM_PREVIOUS_OWNER_MESSAGE = "This order was created before the merchant account changed owners. Ask the merchant for a new payment link.";
+export declare const ORDER_FROM_PREVIOUS_OWNER_REFUND_MESSAGE = "This order was created before the merchant account changed owners, so it cannot be refunded from this account.";
+/** Response copy for MEMBER_LOCKED: the Master Merchant Account seat after an ownership transfer can only be removed by an admin. */
+export declare const MEMBER_LOCKED_MESSAGE = "Locked merchant member can only be removed by an admin";
+export type OwnershipTransferErrorCodeType = typeof MerchantOwnershipErrorCode.TRANSFER_ALREADY_PENDING | typeof MerchantOwnershipErrorCode.WALLET_SETUP_REQUIRED | typeof MerchantOwnershipErrorCode.TERMS_CHANGED | typeof MerchantOwnershipErrorCode.TRANSFER_NOT_FOUND | typeof MerchantOwnershipErrorCode.TRANSFER_EMAIL_MISMATCH | typeof MerchantOwnershipErrorCode.TRANSFER_UNAVAILABLE;
+/** One user-facing message per ownership-transfer error; the API and the CLI simulator both send these. */
+export declare const OWNERSHIP_TRANSFER_ERROR_MESSAGES: Readonly<Record<OwnershipTransferErrorCodeType, string>>;
+/**
+ * Routing states POST /auth/login returns (HTTP 200, `merchant: null`) instead of auto-claiming an
+ * invite or auto-creating a merchant, while an ownership transfer applies to a user with no merchant.
+ */
+export declare const OwnershipTransferLoginState: {
+    readonly PENDING_OWNERSHIP_TRANSFER: "PENDING_OWNERSHIP_TRANSFER";
+    readonly OWNERSHIP_TRANSFER_EMAIL_MISMATCH: "OWNERSHIP_TRANSFER_EMAIL_MISMATCH";
+    readonly OWNERSHIP_TRANSFER_UNAVAILABLE: "OWNERSHIP_TRANSFER_UNAVAILABLE";
+};
+export type OwnershipTransferLoginStateType = typeof OwnershipTransferLoginState[keyof typeof OwnershipTransferLoginState];
+/** Discriminator of POST /auth/ownership-transfers/preview. EMAIL_MISMATCH is the spec's `emailMatches: false`. */
+export declare const OwnershipTransferPreviewState: {
+    readonly PENDING: "PENDING";
+    readonly EMAIL_MISMATCH: "EMAIL_MISMATCH";
+    readonly ACCEPTED: "ACCEPTED";
+};
+export type OwnershipTransferPreviewStateType = typeof OwnershipTransferPreviewState[keyof typeof OwnershipTransferPreviewState];
+/** Mirrors the Prisma enum MerchantOwnershipTransferStatus for pure (Prisma-free) wire schemas. */
+export declare const OwnershipTransferStatus: {
+    readonly PENDING: "PENDING";
+    readonly ACCEPTED: "ACCEPTED";
+    readonly CANCELLED: "CANCELLED";
+    readonly EXPIRED: "EXPIRED";
+};
+export type OwnershipTransferStatusType = typeof OwnershipTransferStatus[keyof typeof OwnershipTransferStatus];
+export declare const MerchantOwnershipTransferCancelReason: {
+    readonly MASTER_MERCHANT_CANCELLED: "MASTER_MERCHANT_CANCELLED";
+    readonly TERMS_CHANGED: "TERMS_CHANGED";
+    readonly MASTER_MERCHANT_FLAG_REMOVED: "MASTER_MERCHANT_FLAG_REMOVED";
+};
+export type MerchantOwnershipTransferCancelReasonType = typeof MerchantOwnershipTransferCancelReason[keyof typeof MerchantOwnershipTransferCancelReason];
+export declare const OwnershipTransferMasterMerchantPermission: {
+    readonly CHECKOUT_CONFIG: "CHECKOUT_CONFIG";
+    readonly TEAM: "TEAM";
+};
+export type OwnershipTransferMasterMerchantPermissionType = typeof OwnershipTransferMasterMerchantPermission[keyof typeof OwnershipTransferMasterMerchantPermission];
+/** What the Master Merchant Account's locked MANAGER seat keeps after a transfer (spec decisions 2 and 9; refunds are OWNER-only); the accept page lists exactly these. */
+export declare const OWNERSHIP_TRANSFER_MASTER_MERCHANT_PERMISSIONS: readonly OwnershipTransferMasterMerchantPermissionType[];
+/** "alice@example.com" → "a•••@example.com". The input is a validated, lowercased address. */
+export declare function maskOwnershipTransferEmail(email: string): string;
 export {};

package/dist/types.js

@@ -60,6 +60,7 @@ export const CheckoutMethod = {
 export const FeePayer = {
     MERCHANT: 'MERCHANT',
     PAYEE: 'PAYEE',
+    SPLIT: 'SPLIT',
 };
 export const MerchantPaymentFlowMode = {
     EXCLUSIVE_SAR: 'EXCLUSIVE_SAR',
@@ -112,8 +113,47 @@ export const CheckoutPaymentMemoPolicy = {
     REQUIRED: 'REQUIRED',
     EMPTY: 'EMPTY',
 };
+// ============ Open-amount orders ============
+/** FIXED orders carry an amount from creation; OPEN orders get one when the buyer starts a payment. */
+export const OrderAmountMode = {
+    FIXED: 'FIXED',
+    OPEN: 'OPEN',
+};
+/**
+ * Why the buyer can no longer change an open order's amount. Precedence when several apply:
+ * PAID, then PAYMENT_MAY_SETTLE, then PAYMENT_IN_PROGRESS.
+ */
+export const AmountLockReason = {
+    /** Only CREATED non-Zcash payments lock the amount; cancelling them unlocks it. */
+    PAYMENT_IN_PROGRESS: 'PAYMENT_IN_PROGRESS',
+    /** An EXPIRED payment, a locking Zcash payment or a reopenable FAILED Relay payment can still settle; cancelling cannot unlock it. */
+    PAYMENT_MAY_SETTLE: 'PAYMENT_MAY_SETTLE',
+    /** A SETTLED payment exists. */
+    PAID: 'PAID',
+};
+export const OpenAmountErrorCode = {
+    OPEN_AMOUNT_INVALID: 'OPEN_AMOUNT_INVALID',
+    OPEN_AMOUNT_DISABLED: 'OPEN_AMOUNT_DISABLED',
+    AMOUNT_REQUIRED: 'AMOUNT_REQUIRED',
+    AMOUNT_NOT_ALLOWED: 'AMOUNT_NOT_ALLOWED',
+    AMOUNT_OUT_OF_RANGE: 'AMOUNT_OUT_OF_RANGE',
+    AMOUNT_LOCKED: 'AMOUNT_LOCKED',
+    AMOUNT_CONFLICT: 'AMOUNT_CONFLICT',
+    RESIZE_NOT_SUPPORTED: 'RESIZE_NOT_SUPPORTED',
+};
+export const PaymentPenaltyKind = {
+    PURCHASE_PROTECTION: 'PURCHASE_PROTECTION',
+    CROSS_CURRENCY: 'CROSS_CURRENCY',
+};
+export const MerchantUserRole = {
+    OWNER: 'OWNER',
+    MANAGER: 'MANAGER',
+    CASHIER: 'CASHIER',
+};
 // Structured error codes for Order failures
+export const PAYMENT_CREATION_PAUSED_MESSAGE = 'Payments are temporarily paused. Please try again shortly.';
 export const OrderErrorCode = {
+    PAYMENTS_PAUSED: 'PAYMENTS_PAUSED',
     // Proof verification errors
     PROOF_INVALID: 'PROOF_INVALID', // Proof data failed attestation verification
     PROOF_EXPIRED: 'PROOF_EXPIRED', // Proof timestamp too old
@@ -131,6 +171,8 @@ export const OrderErrorCode = {
     BRIDGE_TIMEOUT: 'BRIDGE_TIMEOUT', // Bridge fill timed out
     // Fee threshold errors (exact-fiat mode)
     FEE_THRESHOLD_EXCEEDED: 'FEE_THRESHOLD_EXCEEDED', // Quote fee exceeds merchant's max
+    // Payment start limits
+    INTENT_ABOVE_MAX: 'INTENT_ABOVE_MAX', // On-chain intent above the per-payment limit (fees included)
     // Generic
     SDK_ERROR: 'SDK_ERROR', // Unknown SDK error
     UNKNOWN_ERROR: 'UNKNOWN_ERROR', // Uncategorized error
@@ -163,12 +205,18 @@ export const OnboardingStepVerifiedBy = {
     AUTO: 'auto',
     MANUAL: 'manual',
 };
+export const MERCHANT_REFERRAL_FEE_BPS_BY_TIER = {
+    BASE: 30,
+    PRO: 50,
+    CONCIERGE: 100,
+};
 // ============ Webhook Types ============
 export const WebhookEventType = {
     ORDER_CREATED: 'ORDER_CREATED',
     ORDER_FULFILLED: 'ORDER_FULFILLED',
     ORDER_CANCELLED: 'ORDER_CANCELLED',
     ORDER_RESIZED: 'ORDER_RESIZED',
+    ORDER_AMOUNT_SET: 'ORDER_AMOUNT_SET',
     PAYMENT_CREATED: 'PAYMENT_CREATED',
     PAYMENT_SETTLED: 'PAYMENT_SETTLED',
     PAYMENT_CANCELLED: 'PAYMENT_CANCELLED',
@@ -189,3 +237,84 @@ export const WebhookDeliveryStatus = {
     DELIVERED: 'DELIVERED',
     FAILED: 'FAILED',
 };
+/**
+ * Wallet-snapshot fence rejections (ownership-transfer era rule). PR 4-6 add keys to this object.
+ * MERCHANT_OWNERSHIP_CHANGED is retryable: an order insert lost the era it read its wallet in.
+ * ORDER_FROM_PREVIOUS_OWNER is final: the order belongs to an earlier owner's era.
+ */
+export const MerchantOwnershipErrorCode = {
+    MERCHANT_OWNERSHIP_CHANGED: 'MERCHANT_OWNERSHIP_CHANGED',
+    ORDER_FROM_PREVIOUS_OWNER: 'ORDER_FROM_PREVIOUS_OWNER',
+    MEMBER_LOCKED: 'MEMBER_LOCKED',
+    /** 403: the current merchant is not an enabled, LIVE, eligible Master Merchant Account. */
+    MASTER_MERCHANT_NOT_ENABLED: 'MASTER_MERCHANT_NOT_ENABLED',
+    /** 422: the master merchant fee is above the Master Merchant Account's masterMerchantMaxFeeBps, only when the Master Merchant Account has a cap. */
+    MASTER_MERCHANT_FEE_EXCEEDS_CAP: 'MASTER_MERCHANT_FEE_EXCEEDS_CAP',
+    /** 422: a payment method's configured fees for some amount band would exceed the max fee. */
+    MASTER_MERCHANT_FEE_EXCEEDS_MAX_FEE: 'MASTER_MERCHANT_FEE_EXCEEDS_MAX_FEE',
+    /** 409: the Master Merchant Account can no longer change this sub merchant's fee (transferred, or a transfer is pending). */
+    MASTER_MERCHANT_FEE_LOCKED: 'MASTER_MERCHANT_FEE_LOCKED',
+    TRANSFER_ALREADY_PENDING: 'TRANSFER_ALREADY_PENDING',
+    WALLET_SETUP_REQUIRED: 'WALLET_SETUP_REQUIRED',
+    TERMS_CHANGED: 'TERMS_CHANGED',
+    TRANSFER_NOT_FOUND: 'TRANSFER_NOT_FOUND',
+    TRANSFER_EMAIL_MISMATCH: 'TRANSFER_EMAIL_MISMATCH',
+    TRANSFER_UNAVAILABLE: 'TRANSFER_UNAVAILABLE',
+};
+export const MERCHANT_OWNERSHIP_CHANGED_MESSAGE = 'The merchant account changed owners while this order was being created. Retry to create it for the new owner.';
+export const ORDER_FROM_PREVIOUS_OWNER_MESSAGE = 'This order was created before the merchant account changed owners. Ask the merchant for a new payment link.';
+export const ORDER_FROM_PREVIOUS_OWNER_REFUND_MESSAGE = 'This order was created before the merchant account changed owners, so it cannot be refunded from this account.';
+/** Response copy for MEMBER_LOCKED: the Master Merchant Account seat after an ownership transfer can only be removed by an admin. */
+export const MEMBER_LOCKED_MESSAGE = 'Locked merchant member can only be removed by an admin';
+/** One user-facing message per ownership-transfer error; the API and the CLI simulator both send these. */
+export const OWNERSHIP_TRANSFER_ERROR_MESSAGES = {
+    TRANSFER_ALREADY_PENDING: 'A transfer is already pending for this merchant account',
+    WALLET_SETUP_REQUIRED: 'Set up your wallet in the dashboard before accepting this transfer',
+    TERMS_CHANGED: 'The transfer terms changed; review them again before accepting',
+    TRANSFER_NOT_FOUND: 'Ownership transfer not found',
+    TRANSFER_EMAIL_MISMATCH: 'This transfer is for a different email',
+    TRANSFER_UNAVAILABLE: 'This transfer was withdrawn or expired',
+};
+/**
+ * Routing states POST /auth/login returns (HTTP 200, `merchant: null`) instead of auto-claiming an
+ * invite or auto-creating a merchant, while an ownership transfer applies to a user with no merchant.
+ */
+export const OwnershipTransferLoginState = {
+    PENDING_OWNERSHIP_TRANSFER: 'PENDING_OWNERSHIP_TRANSFER',
+    OWNERSHIP_TRANSFER_EMAIL_MISMATCH: 'OWNERSHIP_TRANSFER_EMAIL_MISMATCH',
+    OWNERSHIP_TRANSFER_UNAVAILABLE: 'OWNERSHIP_TRANSFER_UNAVAILABLE',
+};
+/** Discriminator of POST /auth/ownership-transfers/preview. EMAIL_MISMATCH is the spec's `emailMatches: false`. */
+export const OwnershipTransferPreviewState = {
+    PENDING: 'PENDING',
+    EMAIL_MISMATCH: 'EMAIL_MISMATCH',
+    ACCEPTED: 'ACCEPTED',
+};
+/** Mirrors the Prisma enum MerchantOwnershipTransferStatus for pure (Prisma-free) wire schemas. */
+export const OwnershipTransferStatus = {
+    PENDING: 'PENDING',
+    ACCEPTED: 'ACCEPTED',
+    CANCELLED: 'CANCELLED',
+    EXPIRED: 'EXPIRED',
+};
+export const MerchantOwnershipTransferCancelReason = {
+    MASTER_MERCHANT_CANCELLED: 'MASTER_MERCHANT_CANCELLED',
+    TERMS_CHANGED: 'TERMS_CHANGED',
+    MASTER_MERCHANT_FLAG_REMOVED: 'MASTER_MERCHANT_FLAG_REMOVED',
+};
+export const OwnershipTransferMasterMerchantPermission = {
+    CHECKOUT_CONFIG: 'CHECKOUT_CONFIG',
+    TEAM: 'TEAM',
+};
+/** What the Master Merchant Account's locked MANAGER seat keeps after a transfer (spec decisions 2 and 9; refunds are OWNER-only); the accept page lists exactly these. */
+export const OWNERSHIP_TRANSFER_MASTER_MERCHANT_PERMISSIONS = [
+    OwnershipTransferMasterMerchantPermission.CHECKOUT_CONFIG,
+    OwnershipTransferMasterMerchantPermission.TEAM,
+];
+/** "alice@example.com" → "a•••@example.com". The input is a validated, lowercased address. */
+export function maskOwnershipTransferEmail(email) {
+    const at = email.indexOf('@');
+    if (at < 1)
+        throw new Error('Cannot mask an address without a local part');
+    return `${email.slice(0, 1)}•••${email.slice(at)}`;
+}