@zkp2p/pay-shared 6.0.0 → 7.0.0

package/dist/types.d.ts

@@ -1,3 +1,4 @@
+import type { PAYOUT_RAIL_CURRENCIES, PayoutCurrencyType, PayoutFiatValue, PayoutOracleCurrencyType } from './cashoutCurrencies.js';
 import type { PayCryptoTokenSymbol } from './crypto.js';
 import type { ProofMode } from './buyerTee.js';
 import type { OnboardingStepIdValue } from './onboarding.js';
@@ -1044,21 +1045,21 @@ export declare const WebhookEventType: {
     readonly PAYMENT_CHARGEBACKED: "PAYMENT_CHARGEBACKED";
     readonly ORDER_PARTIALLY_CHARGEBACKED: "ORDER_PARTIALLY_CHARGEBACKED";
     readonly ORDER_CHARGEBACKED: "ORDER_CHARGEBACKED";
-    readonly CASHOUT_ORDER_CREATED: "CASHOUT_ORDER_CREATED";
-    readonly CASHOUT_ORDER_CANCELLED: "CASHOUT_ORDER_CANCELLED";
-    readonly CASHOUT_ORDER_PARTIALLY_FUNDED: "CASHOUT_ORDER_PARTIALLY_FUNDED";
-    readonly CASHOUT_ORDER_FUNDED: "CASHOUT_ORDER_FUNDED";
-    readonly CASHOUT_ORDER_MATCHED: "CASHOUT_ORDER_MATCHED";
-    readonly CASHOUT_ORDER_PARTIALLY_PAID: "CASHOUT_ORDER_PARTIALLY_PAID";
-    readonly CASHOUT_ORDER_SETTLED: "CASHOUT_ORDER_SETTLED";
-    readonly CASHOUT_ORDER_EXPIRED: "CASHOUT_ORDER_EXPIRED";
+    readonly PAYOUT_ORDER_CREATED: "PAYOUT_ORDER_CREATED";
+    readonly PAYOUT_ORDER_CANCELLED: "PAYOUT_ORDER_CANCELLED";
+    readonly PAYOUT_ORDER_PARTIALLY_FUNDED: "PAYOUT_ORDER_PARTIALLY_FUNDED";
+    readonly PAYOUT_ORDER_FUNDED: "PAYOUT_ORDER_FUNDED";
+    readonly PAYOUT_ORDER_MATCHED: "PAYOUT_ORDER_MATCHED";
+    readonly PAYOUT_ORDER_PARTIALLY_PAID: "PAYOUT_ORDER_PARTIALLY_PAID";
+    readonly PAYOUT_ORDER_SETTLED: "PAYOUT_ORDER_SETTLED";
+    readonly PAYOUT_ORDER_EXPIRED: "PAYOUT_ORDER_EXPIRED";
 };
 export type WebhookEventTypeValue = typeof WebhookEventType[keyof typeof WebhookEventType];
-/** Cashout events carry a CashoutView, not the order envelope. */
-export declare const CASHOUT_WEBHOOK_EVENT_TYPES: readonly ["CASHOUT_ORDER_CREATED", "CASHOUT_ORDER_CANCELLED", "CASHOUT_ORDER_PARTIALLY_FUNDED", "CASHOUT_ORDER_FUNDED", "CASHOUT_ORDER_MATCHED", "CASHOUT_ORDER_PARTIALLY_PAID", "CASHOUT_ORDER_SETTLED", "CASHOUT_ORDER_EXPIRED"];
-export type CashoutWebhookEventTypeValue = typeof CASHOUT_WEBHOOK_EVENT_TYPES[number];
-export type OrderWebhookEventTypeValue = Exclude<WebhookEventTypeValue, CashoutWebhookEventTypeValue>;
-export declare function isCashoutWebhookEventType(type: string): type is CashoutWebhookEventTypeValue;
+/** Payout events carry a PayoutView, not the order envelope. */
+export declare const PAYOUT_WEBHOOK_EVENT_TYPES: readonly ["PAYOUT_ORDER_CREATED", "PAYOUT_ORDER_CANCELLED", "PAYOUT_ORDER_PARTIALLY_FUNDED", "PAYOUT_ORDER_FUNDED", "PAYOUT_ORDER_MATCHED", "PAYOUT_ORDER_PARTIALLY_PAID", "PAYOUT_ORDER_SETTLED", "PAYOUT_ORDER_EXPIRED"];
+export type PayoutWebhookEventTypeValue = typeof PAYOUT_WEBHOOK_EVENT_TYPES[number];
+export type OrderWebhookEventTypeValue = Exclude<WebhookEventTypeValue, PayoutWebhookEventTypeValue>;
+export declare function isPayoutWebhookEventType(type: string): type is PayoutWebhookEventTypeValue;
 export declare const WebhookDeliveryStatus: {
     readonly PENDING: "PENDING";
     readonly DELIVERED: "DELIVERED";
@@ -1115,11 +1116,11 @@ export type OrderWebhookPayload = {
         amountChange?: OrderAmountChange;
     };
 };
-/** Bumped only on a breaking change to a cashout payload. */
-export declare const CASHOUT_WEBHOOK_VERSION = 1;
-/** One buyer payment that left part of the cashout unpaid; decimal USDC. */
-export interface CashoutPartialPayment {
-    /** The cashout's depositAmount: what buyers can pay in total. */
+/** Bumped only on a breaking change to a payout payload. */
+export declare const PAYOUT_WEBHOOK_VERSION = 2;
+/** One buyer payment that left part of the payout unpaid; amounts are decimal USDC except fill.fiat. */
+export interface PayoutPartialPayment {
+    /** The payout's depositAmount: what buyers can pay in total. */
     expectedAmount: string;
     /** What buyers have paid so far, this fill included. */
     paidAmount: string;
@@ -1128,32 +1129,34 @@ export interface CashoutPartialPayment {
     fill: {
         amount: string;
         txHash: string;
+        /** Fiat paid at this fill's bound rate; null when the currency or rate is unknown. */
+        fiat: PayoutFiatValue | null;
     };
 }
-export type CashoutWebhookEventData = {
-    readonly type: Exclude<CashoutWebhookEventTypeValue, typeof WebhookEventType.CASHOUT_ORDER_PARTIALLY_PAID>;
-    readonly data: CashoutView;
+export type PayoutWebhookEventData = {
+    readonly type: Exclude<PayoutWebhookEventTypeValue, typeof WebhookEventType.PAYOUT_ORDER_PARTIALLY_PAID>;
+    readonly data: PayoutView;
 } | {
-    readonly type: typeof WebhookEventType.CASHOUT_ORDER_PARTIALLY_PAID;
-    readonly data: CashoutView;
-    readonly partialPayment: CashoutPartialPayment;
+    readonly type: typeof WebhookEventType.PAYOUT_ORDER_PARTIALLY_PAID;
+    readonly data: PayoutView;
+    readonly partialPayment: PayoutPartialPayment;
 };
-export type CashoutWebhookPayload = {
+export type PayoutWebhookPayload = {
     id: string;
-    type: Exclude<CashoutWebhookEventTypeValue, typeof WebhookEventType.CASHOUT_ORDER_PARTIALLY_PAID>;
+    type: Exclude<PayoutWebhookEventTypeValue, typeof WebhookEventType.PAYOUT_ORDER_PARTIALLY_PAID>;
     timestamp: string;
-    version: typeof CASHOUT_WEBHOOK_VERSION;
-    data: CashoutView;
+    version: typeof PAYOUT_WEBHOOK_VERSION;
+    data: PayoutView;
 } | {
     id: string;
-    type: typeof WebhookEventType.CASHOUT_ORDER_PARTIALLY_PAID;
+    type: typeof WebhookEventType.PAYOUT_ORDER_PARTIALLY_PAID;
     timestamp: string;
-    version: typeof CASHOUT_WEBHOOK_VERSION;
-    data: CashoutView;
-    partialPayment: CashoutPartialPayment;
+    version: typeof PAYOUT_WEBHOOK_VERSION;
+    data: PayoutView;
+    partialPayment: PayoutPartialPayment;
 };
-export type WebhookPayload = OrderWebhookPayload | CashoutWebhookPayload;
-export declare function isCashoutWebhook(payload: WebhookPayload): payload is CashoutWebhookPayload;
+export type WebhookPayload = OrderWebhookPayload | PayoutWebhookPayload;
+export declare function isPayoutWebhook(payload: WebhookPayload): payload is PayoutWebhookPayload;
 export type CreateWebhookRequest = {
     url: string;
     events?: WebhookEventTypeValue[];
@@ -1254,45 +1257,43 @@ export type OwnershipTransferMasterMerchantPermissionType = typeof OwnershipTran
 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 declare const CashoutStatus: {
+export declare const PayoutStatus: {
     readonly AWAITING_FUNDING: "AWAITING_FUNDING";
     readonly FUNDED: "FUNDED";
     readonly READY: "READY";
     readonly LISTING: "LISTING";
     readonly PAYING: "PAYING";
     readonly SETTLED: "SETTLED";
-    readonly CANCELLING: "CANCELLING";
     readonly CANCELLED: "CANCELLED";
     readonly EXPIRED: "EXPIRED";
 };
-export type CashoutStatusType = typeof CashoutStatus[keyof typeof CashoutStatus];
-export declare const CashoutFundingStatus: {
+export type PayoutStatusType = typeof PayoutStatus[keyof typeof PayoutStatus];
+export declare const PayoutFundingStatus: {
     readonly AWAITING_FUNDING: "AWAITING_FUNDING";
     readonly PARTIALLY_FUNDED: "PARTIALLY_FUNDED";
     readonly FUNDED: "FUNDED";
     readonly FUNDING_EXPIRED: "FUNDING_EXPIRED";
 };
-export type CashoutFundingStatusType = typeof CashoutFundingStatus[keyof typeof CashoutFundingStatus];
-export declare const CashoutCancelSource: {
-    readonly CHECKOUT: "CHECKOUT";
+export type PayoutFundingStatusType = typeof PayoutFundingStatus[keyof typeof PayoutFundingStatus];
+export declare const PayoutCancelSource: {
     readonly MERCHANT: "MERCHANT";
     readonly PEER_APP: "PEER_APP";
 };
-export type CashoutCancelSourceType = typeof CashoutCancelSource[keyof typeof CashoutCancelSource];
-export declare const CashoutPayoutKind: {
+export type PayoutCancelSourceType = typeof PayoutCancelSource[keyof typeof PayoutCancelSource];
+export declare const PayoutKind: {
     readonly ESCROW: "ESCROW";
     readonly CRYPTO: "CRYPTO";
 };
-export type CashoutPayoutKindType = typeof CashoutPayoutKind[keyof typeof CashoutPayoutKind];
-export declare const CashoutAttemptStatus: {
+export type PayoutKindType = typeof PayoutKind[keyof typeof PayoutKind];
+export declare const PayoutAttemptStatus: {
     readonly ACTIVE: "ACTIVE";
     readonly CLOSED: "CLOSED";
     readonly SETTLED: "SETTLED";
     readonly FAILED: "FAILED";
 };
-export type CashoutAttemptStatusType = typeof CashoutAttemptStatus[keyof typeof CashoutAttemptStatus];
+export type PayoutAttemptStatusType = typeof PayoutAttemptStatus[keyof typeof PayoutAttemptStatus];
 /** Fiat payout methods, in the order players see them: SAR rails, then buyer-proof rails. */
-export declare const CashoutFiatRail: {
+export declare const PayoutFiatRail: {
     readonly VENMO: "venmo";
     readonly CASHAPP: "cashapp";
     readonly PAYPAL: "paypal";
@@ -1300,9 +1301,9 @@ export declare const CashoutFiatRail: {
     readonly REVOLUT: "revolut";
     readonly CHIME: "chime";
 };
-export type CashoutFiatRailType = typeof CashoutFiatRail[keyof typeof CashoutFiatRail];
+export type PayoutFiatRailType = typeof PayoutFiatRail[keyof typeof PayoutFiatRail];
 /** One rail per crypto payout network, with checkout's rail ids (any-coin spec "Cashout rails"); the player sees them as one "Crypto" option. */
-export declare const CashoutCryptoRail: {
+export declare const PayoutCryptoRail: {
     readonly RELAY_1: "relay_1";
     readonly RELAY_10: "relay_10";
     readonly RELAY_56: "relay_56";
@@ -1318,9 +1319,9 @@ export declare const CashoutCryptoRail: {
     /** ZEC on Zcash through NEAR Intents (Zcash spec "Catalog, route and address"); checkout's ZCASH_RAIL. */
     readonly NEAR_INTENTS_133701: "near_intents_133701";
 };
-export type CashoutCryptoRailType = typeof CashoutCryptoRail[keyof typeof CashoutCryptoRail];
-/** Every cashout rail, in rail order: fiat, then the crypto networks. */
-export declare const CashoutRail: {
+export type PayoutCryptoRailType = typeof PayoutCryptoRail[keyof typeof PayoutCryptoRail];
+/** Every payout rail, in rail order: fiat, then the crypto networks. */
+export declare const PayoutRail: {
     readonly RELAY_1: "relay_1";
     readonly RELAY_10: "relay_10";
     readonly RELAY_56: "relay_56";
@@ -1342,16 +1343,16 @@ export declare const CashoutRail: {
     readonly REVOLUT: "revolut";
     readonly CHIME: "chime";
 };
-export type CashoutRailType = CashoutFiatRailType | CashoutCryptoRailType;
+export type PayoutRailType = PayoutFiatRailType | PayoutCryptoRailType;
 /** Fiat rails whose account the player connects so Peer can confirm buyer payments; derived from SAR_SUPPORTED_FIAT_RAILS. */
-export type CashoutSarRailType = Extract<CashoutFiatRailType, SarSupportedFiatRail>;
+export type PayoutSarRailType = Extract<PayoutFiatRailType, SarSupportedFiatRail>;
 /** Fiat rails with no connect step: the buyer proves the payment with the PeerAuth extension or the Peer app. */
-export type CashoutBuyerProofRailType = Exclude<CashoutFiatRailType, CashoutSarRailType>;
-export declare const CashoutPayoutProvider: {
+export type CashoutBuyerProofRailType = Exclude<PayoutFiatRailType, PayoutSarRailType>;
+export declare const PayoutProvider: {
     readonly RELAY: "RELAY";
     readonly NEAR_INTENTS: "NEAR_INTENTS";
 };
-export type CashoutPayoutProviderType = typeof CashoutPayoutProvider[keyof typeof CashoutPayoutProvider];
+export type PayoutProviderType = typeof PayoutProvider[keyof typeof PayoutProvider];
 export declare const CashoutPayoutBridgeStatus: {
     readonly QUOTED: "QUOTED";
     readonly NOT_SENT: "NOT_SENT";
@@ -1361,7 +1362,7 @@ export declare const CashoutPayoutBridgeStatus: {
 };
 export type CashoutPayoutBridgeStatusType = typeof CashoutPayoutBridgeStatus[keyof typeof CashoutPayoutBridgeStatus];
 /** A crypto payout's coin, network and the player's address there. */
-export interface CashoutCryptoDestination {
+export interface PayoutCryptoDestination {
     chainId: number;
     /** The shared catalog's address for the token on chainId. */
     tokenAddress: string;
@@ -1372,18 +1373,18 @@ export interface CashoutCryptoDestination {
 }
 /** Body of the crypto payout-method, payout-quote and send-to-address requests. The rail names the network. */
 export interface CashoutPayoutDestinationRequest {
-    rail: CashoutCryptoRailType;
+    rail: PayoutCryptoRailType;
     tokenAddress: string;
     address: string;
 }
 /** A crypto payout method: the network's rail and where on it the player takes the payout. */
-export interface CashoutCryptoMethod {
-    rail: CashoutCryptoRailType;
-    destination: CashoutCryptoDestination;
+export interface PayoutCryptoMethod {
+    rail: PayoutCryptoRailType;
+    destination: PayoutCryptoDestination;
 }
 /** POST /api/v1/cashout-checkout/:id/payout-quote. Not a promise. */
 export interface CashoutPayoutQuote {
-    destination: CashoutCryptoDestination;
+    destination: PayoutCryptoDestination;
     /** Decimal USDC that would leave the player's wallet. */
     usdcAmount: string;
     /** Decimal destination token; equals usdcAmount for USDC on Base. */
@@ -1392,9 +1393,9 @@ export interface CashoutPayoutQuote {
 }
 /** The player's bridged payout, newest attempt first; never NOT_SENT. */
 export interface CashoutPayoutBridgeView {
-    provider: CashoutPayoutProviderType;
+    provider: PayoutProviderType;
     status: Exclude<CashoutPayoutBridgeStatusType, typeof CashoutPayoutBridgeStatus.NOT_SENT>;
-    destination: CashoutCryptoDestination;
+    destination: PayoutCryptoDestination;
     usdcAmount: string;
     /** The binding quote's output, decimal destination token. */
     estimatedAmount: string;
@@ -1404,16 +1405,20 @@ export interface CashoutPayoutBridgeView {
     refundedAmount: string | null;
     refundTxHash: string | null;
 }
-export interface CashoutPartialFillView {
+export interface PayoutPartialFillView {
+    /** Fiat paid at this fill's bound rate; null when the currency or rate is unknown. */
+    fiat: PayoutFiatValue | null;
     /** Decimal USDC this buyer paid. */
     amount: string;
     txHash: string;
     paidAt: string;
 }
-/** Where a SETTLED cashout's USDC ended up; decimal USDC, "0.00" for a part that did not happen. */
-export interface CashoutSettlementBreakdown {
+/** Where a SETTLED payout's USDC ended up; decimal USDC, "0.00" for a part that did not happen. */
+export interface PayoutSettlementBreakdown {
     /** Paid by buyers through the escrow, across every listing. */
     buyerPaidAmount: string;
+    /** Fiat totals in first-paid order; null if any payment has an unknown currency or bound rate, [] if no buyer paid. */
+    buyerPaidFiat: PayoutFiatValue[] | null;
     /** USDC that left the player's wallet for a crypto payout (direct or bridged) or a send-to-address remainder. */
     sentAmount: string;
     /** The player's recipient: EVM lower-case, Solana, Tron and Bitcoin canonical; never a deposit address. */
@@ -1425,12 +1430,14 @@ export interface CashoutSettlementBreakdown {
     /** Σ refundLossUnits: USDC Relay kept on refunds; "0.00" when none. */
     refundFeeAmount: string;
 }
-/** Merchant-facing cashout. Never includes the Peer fee, the player's email, wallet or payee handle. */
-export interface CashoutView {
-    cashoutId: string;
+/** Merchant-facing payout. Never includes the Peer fee, the player's email, wallet or payee handle. */
+export interface PayoutView {
+    /** The chosen fiat payout currency; null for crypto or no selected method. */
+    payoutCurrency: PayoutCurrencyType | null;
+    payoutId: string;
     merchantReference: string | null;
-    status: CashoutStatusType;
-    fundingStatus: CashoutFundingStatusType;
+    status: PayoutStatusType;
+    fundingStatus: PayoutFundingStatusType;
     payout: {
         amount: string;
         chainId: number;
@@ -1455,7 +1462,7 @@ export interface CashoutView {
         expectedAmount: string;
         /** Reached the player's wallet on Base, decimal USDC. */
         receivedAmount: string;
-        /** Null once the cashout can no longer be funded. */
+        /** Null once the payout can no longer be funded. */
         depositAddress: string | null;
         /** Funding deadline; each on-time arrival moves it to at least the funding TTL (24 hours by default) after that check. */
         quoteExpiresAt: string;
@@ -1463,13 +1470,13 @@ export interface CashoutView {
     depositAmount: string | null;
     /** What buyers have paid across every listing, partial fills included. */
     paidAmount: string;
-    partialFills: CashoutPartialFillView[];
+    partialFills: PayoutPartialFillView[];
     /** Only when status is SETTLED. */
-    settlement: CashoutSettlementBreakdown | null;
+    settlement: PayoutSettlementBreakdown | null;
     attempt: {
-        kind: CashoutPayoutKindType;
+        kind: PayoutKindType;
         rail: string | null;
-        status: CashoutAttemptStatusType;
+        status: PayoutAttemptStatusType;
     } | null;
     /** Only when settled with a sent amount, including a send-to-address remainder. */
     payoutTransfer: {
@@ -1485,9 +1492,9 @@ export interface CashoutView {
         /** The USDC transfer on Base; settlement.sentAmount is its amount. */
         usdcTxHash: string;
         /** The bridge provider (RELAY or NEAR_INTENTS) when bridged; null for USDC on Base, where txHash = usdcTxHash. */
-        provider: CashoutPayoutProviderType | null;
+        provider: PayoutProviderType | null;
     } | null;
-    cancelSource: CashoutCancelSourceType | null;
+    cancelSource: PayoutCancelSourceType | null;
     returnUrl: string | null;
     expiresAt: string;
     fundedAt: string | null;
@@ -1495,7 +1502,7 @@ export interface CashoutView {
     cancelledAt: string | null;
     createdAt: string;
 }
-export interface CreateCashoutRequest {
+export interface CreatePayoutRequest {
     merchantReference?: string;
     customerEmail: string;
     payout: {
@@ -1509,22 +1516,22 @@ export interface CreateCashoutRequest {
         refundAddress?: string;
     };
     returnUrl?: string;
-    /** Limits the cashout to these rails; never widens the merchant's (any-coin spec "Cashout rails"). */
-    rails?: CashoutRailType[];
+    /** Limits the payout to these rails; never widens the merchant's (any-coin spec "Cashout rails"). */
+    rails?: PayoutRailType[];
 }
 /** A replay with the same key and body returns the current checkout link, marked `idempotentReplay: true`. */
-export type CreateCashoutResponse = CashoutView & {
+export type CreatePayoutResponse = PayoutView & {
     checkoutUrl: string;
     idempotentReplay: boolean;
 };
-export interface ListCashoutsResponse {
-    items: CashoutView[];
+export interface ListPayoutsResponse {
+    items: PayoutView[];
     page: number;
     limit: number;
     total: number;
 }
-/** A moment on a cashout's dashboard timeline. */
-export declare const CashoutTimelineEventType: {
+/** A moment on a payout's dashboard timeline. */
+export declare const PayoutTimelineEventType: {
     readonly CREATED: "CREATED";
     readonly PARTIALLY_FUNDED: "PARTIALLY_FUNDED";
     readonly FUNDED: "FUNDED";
@@ -1540,7 +1547,6 @@ export declare const CashoutTimelineEventType: {
     readonly RELISTED: "RELISTED";
     readonly BUYER_DROPPED: "BUYER_DROPPED";
     readonly RECONNECT_NEEDED: "RECONNECT_NEEDED";
-    readonly CANCEL_STARTED: "CANCEL_STARTED";
     /** The listing came back to the player's wallet so they can pick another payout method. */
     readonly LISTING_WITHDRAWN: "LISTING_WITHDRAWN";
     readonly SETTLED: "SETTLED";
@@ -1548,17 +1554,17 @@ export declare const CashoutTimelineEventType: {
     readonly FUNDING_ISSUE: "FUNDING_ISSUE";
     readonly PAYOUT_REFUNDED: "PAYOUT_REFUNDED";
 };
-export type CashoutTimelineEventTypeValue = typeof CashoutTimelineEventType[keyof typeof CashoutTimelineEventType];
-/** Largest merchant cashout payout step, in whole USDC. The smallest is the API's CASHOUT_MIN_USDC (10 in production). */
-export declare const CASHOUT_PAYOUT_STEP_MAX_USDC = 1000;
-/** Whole-USDC bounds for a merchant's cashout payout step in this environment. */
-export interface CashoutPayoutStepRange {
+export type PayoutTimelineEventTypeValue = typeof PayoutTimelineEventType[keyof typeof PayoutTimelineEventType];
+/** Largest merchant payout step, in whole USDC. The smallest is the API's CASHOUT_MIN_USDC (10 in production). */
+export declare const PAYOUT_STEP_MAX_USDC = 1000;
+/** Whole-USDC bounds for a merchant's payout step in this environment. */
+export interface PayoutStepRange {
     min: number;
     max: number;
 }
-/** A merchant's cashout settings; the Peer fee is not the merchant's to see. */
-export interface CashoutSettings {
-    rails: CashoutRailType[];
+/** A merchant's payout settings; the Peer fee is not the merchant's to see. */
+export interface PayoutSettings {
+    rails: PayoutRailType[];
     /** Merchant fee in bps of the deposit, 0–1000. */
     feeBps: number;
     /** Whole USDC, within the environment's payout step range. */
@@ -1566,62 +1572,63 @@ export interface CashoutSettings {
     /** An https URL or a mailto: link; optional. Without it the player's checkout shows no contact line. */
     supportUrl: string | null;
 }
-export declare const CashoutFundingIssueKind: {
+export declare const PayoutFundingIssueKind: {
     readonly LATE_FUNDS: "LATE_FUNDS";
     readonly OVERPAYMENT: "OVERPAYMENT";
     readonly ROUTE_REFUND: "ROUTE_REFUND";
 };
-export type CashoutFundingIssueKindType = typeof CashoutFundingIssueKind[keyof typeof CashoutFundingIssueKind];
-export declare const CashoutFundingIssueResolution: {
+export type PayoutFundingIssueKindType = typeof PayoutFundingIssueKind[keyof typeof PayoutFundingIssueKind];
+export declare const PayoutFundingIssueResolution: {
     readonly RETURNED: "RETURNED";
     readonly CLAIMED: "CLAIMED";
 };
-export type CashoutFundingIssueResolutionType = typeof CashoutFundingIssueResolution[keyof typeof CashoutFundingIssueResolution];
+export type PayoutFundingIssueResolutionType = typeof PayoutFundingIssueResolution[keyof typeof PayoutFundingIssueResolution];
 /** A funding token as offered to a merchant: `key` is "chainId:lowercaseAddress". */
-export interface CashoutFundingTokenOption {
+export interface PayoutFundingTokenOption {
     key: string;
     chainId: number;
     address: string;
     symbol: string;
 }
-/** GET /merchants/me/cashout-settings: the saved settings plus what Peer currently allows. */
-export interface CashoutSettingsView extends CashoutSettings {
-    availableRails: CashoutRailType[];
-    availableFundingTokens: CashoutFundingTokenOption[];
-    payoutStepRange: CashoutPayoutStepRange;
+/** GET /merchants/me/payout-settings: the saved settings plus what Peer currently allows. */
+export interface PayoutSettingsView extends PayoutSettings {
+    availableRails: PayoutRailType[];
+    availableFundingTokens: PayoutFundingTokenOption[];
+    payoutStepRange: PayoutStepRange;
 }
 /** Merchant-facing; never includes the admin's note or name. */
-export interface MerchantCashoutFundingIssue {
-    kind: CashoutFundingIssueKindType;
+export interface MerchantPayoutFundingIssue {
+    kind: PayoutFundingIssueKindType;
     /** Decimal USDC; null for a route refund, which is paid back in the origin token. */
     amountUsdc: string | null;
     txHash: string | null;
     detectedAt: string;
-    resolution: CashoutFundingIssueResolutionType | null;
+    resolution: PayoutFundingIssueResolutionType | null;
     resolutionTxHash: string | null;
     resolvedAt: string | null;
 }
-export type CashoutPayoutMethodView = {
-    rail: CashoutFiatRailType;
+export type PayoutMethodView = {
+    rail: PayoutFiatRailType;
     handle: string;
-} | CashoutCryptoMethod;
-/** The dashboard's cashout: the API view plus what only the merchant's staff may see. */
-export interface MerchantCashoutView extends CashoutView {
+    currency: PayoutCurrencyType;
+} | PayoutCryptoMethod;
+/** The dashboard's payout: the API view plus what only the merchant's staff may see. */
+export interface MerchantPayoutView extends PayoutView {
     /** The player's email as given at create, stored lower-cased. */
     customerEmail: string;
-    payoutMethod: CashoutPayoutMethodView | null;
-    /** Null once the cashout is final. */
+    payoutMethod: PayoutMethodView | null;
+    /** Null once the payout is final. */
     checkoutUrl: string | null;
 }
-export interface CashoutTimelineEntry {
-    type: CashoutTimelineEventTypeValue;
+export interface PayoutTimelineEntry {
+    type: PayoutTimelineEventTypeValue;
     text: string;
     txHash: string | null;
     /** The chain txHash is on; null when txHash isn't linked. */
     txChainId: number | null;
     occurredAt: string;
 }
-export interface CashoutWebhookDeliveryView {
+export interface PayoutWebhookDeliveryView {
     eventType: string;
     status: string;
     attempts: number;
@@ -1629,47 +1636,47 @@ export interface CashoutWebhookDeliveryView {
     lastAttemptAt: string | null;
     createdAt: string;
 }
-export interface MerchantCashoutDetail {
-    cashout: MerchantCashoutView;
-    timeline: CashoutTimelineEntry[];
+export interface MerchantPayoutDetail {
+    payout: MerchantPayoutView;
+    timeline: PayoutTimelineEntry[];
     /** Not stored: what happens next from the current status, or null when final. */
     nextStep: string | null;
-    webhooks: CashoutWebhookDeliveryView[];
-    fundingIssues: MerchantCashoutFundingIssue[];
+    webhooks: PayoutWebhookDeliveryView[];
+    fundingIssues: MerchantPayoutFundingIssue[];
 }
-/** The dashboard's create form result; a replay returns the same cashout and its current link. */
-export type CreateMerchantCashoutResponse = MerchantCashoutView & {
+/** The dashboard's create form result; a replay returns the same payout and its current link. */
+export type CreateMerchantPayoutResponse = MerchantPayoutView & {
     idempotentReplay: boolean;
 };
-export interface ListMerchantCashoutsResponse {
-    items: MerchantCashoutView[];
+export interface ListMerchantPayoutsResponse {
+    items: MerchantPayoutView[];
     page: number;
     limit: number;
     total: number;
 }
 export interface AdminCashoutSettings {
-    disabledRails: CashoutRailType[];
+    disabledRails: PayoutRailType[];
     disabledFundingTokens: string[];
     peerFeeRecipient: string;
-    supportedFundingTokens: CashoutFundingTokenOption[];
+    supportedFundingTokens: PayoutFundingTokenOption[];
     updatedAt: string;
 }
 export interface AdminCashoutMerchantConfig {
     merchantId: string;
     peerFeeBps: number;
     payoutStepUsdc: number;
-    payoutStepRange: CashoutPayoutStepRange;
+    payoutStepRange: PayoutStepRange;
     fundingTokens: string[];
     /** Merchant cashout rails, edited by the merchant and Peer admins, in rail order. */
-    rails: CashoutRailType[];
+    rails: PayoutRailType[];
     /** Player support link; optional. */
     supportUrl: string | null;
     /** Merchant rails minus Peer's global disables and the fiat rails `DISABLED_RAILS` turns off, in rail order. */
-    effectiveRails: CashoutRailType[];
+    effectiveRails: PayoutRailType[];
     merchantFeeBps: number;
     merchantFeeRecipient: string | null;
 }
-export interface AdminCashoutFundingIssue extends MerchantCashoutFundingIssue {
+export interface AdminCashoutFundingIssue extends MerchantPayoutFundingIssue {
     id: string;
     cashoutId: string;
     merchantId: string;
@@ -1698,8 +1705,6 @@ export declare const CashoutPlayerAction: {
     readonly CONNECT_RAIL: "CONNECT_RAIL";
     readonly SKIP_CONNECT: "SKIP_CONNECT";
     readonly CONFIRM: "CONFIRM";
-    readonly CANCEL: "CANCEL";
-    readonly FINISH_CANCEL: "FINISH_CANCEL";
     readonly CHANGE_METHOD: "CHANGE_METHOD";
     readonly SEND_TO_ADDRESS: "SEND_TO_ADDRESS";
     readonly RELIST: "RELIST";
@@ -1720,7 +1725,7 @@ export declare const CashoutCredentialStatus: {
 };
 export type CashoutCredentialStatusType = typeof CashoutCredentialStatus[keyof typeof CashoutCredentialStatus];
 export interface CashoutRailOption {
-    rail: CashoutRailType;
+    rail: PayoutRailType;
     /** Smallest single buyer payment, USDC decimal; null for crypto rails. */
     minAmount: string | null;
     /** Largest single buyer payment, USDC decimal; null for crypto rails. */
@@ -1728,7 +1733,8 @@ export interface CashoutRailOption {
 }
 /** A SAR method supports seller-side confirmation; when connecting is skipped, each buyer proves payment. */
 export interface CashoutSarMethod {
-    rail: CashoutSarRailType;
+    currency: PayoutCurrencyType;
+    rail: PayoutSarRailType;
     payeeHandle: string;
     credentialStatus: CashoutCredentialStatusType;
     /** The player chose to list without connecting this method. */
@@ -1739,6 +1745,7 @@ export interface CashoutSarMethod {
 }
 /** A buyer-proof method has no connect step or credential; each buyer proves their payment. */
 export interface CashoutBuyerProofMethod {
+    currency: PayoutCurrencyType;
     rail: CashoutBuyerProofRailType;
     payeeHandle: string;
     payeeHash: string;
@@ -1756,25 +1763,46 @@ export interface CashoutCheckoutSummary {
     email: string;
     maskedEmail: string;
     payoutAmount: string;
-    status: CashoutStatusType;
+    status: PayoutStatusType;
     rails: CashoutRailOption[];
     returnUrl: string | null;
 }
+/** Display only: an oracle read never gates a payout. */
+export interface CashoutFxRate {
+    currency: PayoutOracleCurrencyType;
+    rate: string;
+}
+export interface CashoutPayoutCurrencyOption {
+    currency: PayoutCurrencyType;
+    rails: PayoutFiatRailType[];
+    rate: CashoutFxRate | null;
+    estimate: PayoutFiatValue | null;
+}
+export interface CashoutFiatPricing {
+    currency: PayoutOracleCurrencyType;
+    rate: CashoutFxRate | null;
+    unpaid: PayoutFiatValue | null;
+    listed: PayoutFiatValue | null;
+}
 /** GET /api/v1/cashout-checkout/:id/state (link token + Peer app login). */
 export interface CashoutCheckoutState {
+    payoutCurrencies: CashoutPayoutCurrencyOption[];
+    fiatPricing: CashoutFiatPricing | null;
+    /** Exact fiat while PAYING; null when there is no buyer payment or no known currency and bound rate. */
+    buyerPayment: PayoutFiatValue | null;
     cashoutId: string;
-    status: CashoutStatusType;
+    status: PayoutStatusType;
     walletAddress: string;
     depositAmount: string | null;
     /** Live from the escrow deposit; null before listing and once the listing is closed. */
     remainingAmount: string | null;
     buyerPaymentActive: boolean;
-    method: CashoutSarMethod | CashoutBuyerProofMethod | CashoutCryptoMethod | null;
+    method: CashoutSarMethod | CashoutBuyerProofMethod | PayoutCryptoMethod | null;
     /** Prefill from this player's last cashout on an available rail; never a deposit address. */
-    lastPayoutTarget: CashoutPayoutMethodView | null;
+    lastPayoutTarget: PayoutMethodView | null;
     attempt: {
         attemptId: string;
-        status: CashoutAttemptStatusType;
+        status: PayoutAttemptStatusType;
         depositId: string | null;
     } | null;
     signer: {
@@ -1789,18 +1817,18 @@ export interface CashoutCheckoutState {
      * Also true when a Venmo or PayPal listing's Peer Pay group send failed and its listing was withdrawn (the cashout is back in FUNDED/READY).
      */
     lastSendFailed: boolean;
-    /** Set when the Peer wallet no longer covers this cashout (newest first, like the wallet job): what it needs and what is left for it after the player's older cashouts, in decimal USDC. Only CANCEL is offered then. */
+    /** Set when the Peer wallet no longer covers this cashout (newest first, like the wallet job): what it needs and what is left for it after the player's older cashouts, in decimal USDC. Nothing is offered then: the wallet job closes it. */
     walletShortfall: {
         requiredAmount: string;
         availableAmount: string;
     } | null;
     /** PARTIALLY_FUNDED means the merchant still owes a top-up; receivedAmount is the USDC that reached the player's wallet. */
     funding: {
-        status: CashoutFundingStatusType;
+        status: PayoutFundingStatusType;
         receivedAmount: string | null;
     };
-    /** Who cancelled; PEER_APP when the player took the cashout back in the Peer app. */
-    cancelSource: CashoutCancelSourceType | null;
+    /** Who ended it: MERCHANT before funding, PEER_APP when the player moved the money in the Peer app. */
+    cancelSource: PayoutCancelSourceType | null;
     merchantReference: string | null;
     /** Once settled: the delivering transaction and its chain. */
     settleTx: {
@@ -1813,6 +1841,8 @@ export interface CashoutCheckoutState {
     buyerMatchedAt: string | null;
     /** Set once a buyer paid part of the cashout; decimal USDC. totalAmount is depositAmount. */
     partialPayment: {
+        /** Fiat totals in first-paid order; null if any payment has an unknown currency or bound rate, [] if no buyer paid. */
+        paidFiat: PayoutFiatValue[] | null;
         paidAmount: string;
         unpaidAmount: string;
         totalAmount: string;
@@ -1826,22 +1856,27 @@ export interface CashoutCheckoutState {
         acceptingBuyers: boolean;
     } | null;
     /** Only when status is SETTLED. */
-    settlement: CashoutSettlementBreakdown | null;
+    settlement: PayoutSettlementBreakdown | null;
     actions: CashoutPlayerActionType[];
 }
 export type SetCashoutPayoutMethodRequest = {
-    rail: typeof CashoutRail.VENMO | typeof CashoutRail.CASHAPP;
+    rail: typeof PayoutRail.VENMO | typeof PayoutRail.CASHAPP;
     payeeHandle: string;
 }
 /** The App Clip checks the connected PayPal account against this email. */
  | {
-    rail: typeof CashoutRail.PAYPAL;
+    rail: typeof PayoutRail.PAYPAL;
     payeeHandle: string;
     paypalEmail: string;
+    currency: (typeof PAYOUT_RAIL_CURRENCIES)['paypal'][number];
 }
-/** Buyer-proof rails need only the payout account; there is no connect step. */
+/** The multi-currency rail carries the player's selected payout currency. */
  | {
-    rail: CashoutBuyerProofRailType;
+    rail: typeof PayoutRail.REVOLUT;
+    payeeHandle: string;
+    currency: (typeof PAYOUT_RAIL_CURRENCIES)['revolut'][number];
+} | {
+    rail: typeof PayoutRail.ZELLE | typeof PayoutRail.CHIME;
     payeeHandle: string;
 } | CashoutPayoutDestinationRequest;
 /** POST /api/v1/cashout-checkout/:id/send-to-address. The checkout requires the network tick box before sending. */
@@ -1852,8 +1887,8 @@ export interface CashoutActivityItem {
     checkoutUrl: string;
     payoutAmount: string;
     /** The chosen payout app, or null before the player picks one. */
-    payoutRail: CashoutRailType | null;
-    status: CashoutStatusType;
+    payoutRail: PayoutRailType | null;
+    status: PayoutStatusType;
     createdAt: string;
 }
 export interface ListCashoutActivityResponse {