@moonpay/platform-protocol 1.13.1 → 1.15.0

package/dist/api/customer.d.cts

@@ -124,6 +124,20 @@ type CddEmploymentStatus = 'employedOrSelfEmployed' | 'retired' | 'student' | 'u
  * The customer's primary source of wealth.
  */
 type CddSourceOfWealth = 'salary' | 'savings' | 'investments' | 'cryptoTrading' | 'other';
+/**
+ * A challenge that must be resolved by rendering a MoonPay-hosted frame.
+ */
+type Challenge = {
+    /**
+     * The type of challenge resolution required.
+     */
+    kind: ChallengeKind;
+    /**
+     * Fully-formed challenge frame URL. Render directly without parsing.
+     */
+    url: string;
+};
+type ChallengeKind = 'frame';
 /**
  * Request body for creating an identity.
  */
@@ -542,6 +556,10 @@ type GetQuoteResponse = {
      * An opaque token representing the quote to initiate payment frames.
      */
     signature: string;
+    /**
+     * A challenge the partner must surface and the customer must complete before the quote can proceed — for example, verifying identity to raise guest-checkout limits. Present only when the quote requires one; omitted otherwise.
+     */
+    challenge?: Challenge;
 };
 type IPv4Address = string;
 type IPv6Address = string;

package/dist/api/customer.d.ts

@@ -124,6 +124,20 @@ type CddEmploymentStatus = 'employedOrSelfEmployed' | 'retired' | 'student' | 'u
  * The customer's primary source of wealth.
  */
 type CddSourceOfWealth = 'salary' | 'savings' | 'investments' | 'cryptoTrading' | 'other';
+/**
+ * A challenge that must be resolved by rendering a MoonPay-hosted frame.
+ */
+type Challenge = {
+    /**
+     * The type of challenge resolution required.
+     */
+    kind: ChallengeKind;
+    /**
+     * Fully-formed challenge frame URL. Render directly without parsing.
+     */
+    url: string;
+};
+type ChallengeKind = 'frame';
 /**
  * Request body for creating an identity.
  */
@@ -542,6 +556,10 @@ type GetQuoteResponse = {
      * An opaque token representing the quote to initiate payment frames.
      */
     signature: string;
+    /**
+     * A challenge the partner must surface and the customer must complete before the quote can proceed — for example, verifying identity to raise guest-checkout limits. Present only when the quote requires one; omitted otherwise.
+     */
+    challenge?: Challenge;
 };
 type IPv4Address = string;
 type IPv6Address = string;

package/dist/frames/challenge.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/frames/challenge.ts"],"sourcesContent":["import type { FrameTransaction } from '../models/transaction.js';\nimport type { FrameError } from '../protocol.js';\n\nexport type CompleteResult =\n  | { flow: 'buy'; transaction: FrameTransaction }\n  | { flow: 'identity'; identityId: string };\n\nexport type Cancellation =\n  | { flow: 'buy'; transactionId?: string; challengeToken?: string }\n  | { flow: 'identity' };\n\n/**\n * The challenge frame is fully self-contained — it is driven by the\n * `challengeToken` URL param. There is no parent → child message map.\n */\nexport interface MessageMap {\n  ready: void;\n  complete: CompleteResult;\n  /** User dismissed the challenge. Carry `transactionId` / `challengeToken` to resume. */\n  cancelled: Cancellation;\n  error: FrameError;\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
+{"version":3,"sources":["../../src/frames/challenge.ts"],"sourcesContent":["import type { FrameTransaction } from '../models/transaction.js';\nimport type { FrameError } from '../protocol.js';\n\n/**\n * Mirrors the MoonPay API's `GuestCheckoutLimitUpgradeStatus` — a durable,\n * poll-any-time-later fact rather than a short-lived value: `upgraded` and\n * `rejected` reflect a persisted review outcome, not a transient in-progress signal.\n */\nexport type GuestCheckoutLimitUpgradeStatus = 'pending' | 'upgraded' | 'rejected';\n\nexport type CompleteResult =\n  | { flow: 'buy'; transaction: FrameTransaction }\n  | { flow: 'identity'; identityId: string }\n  | { flow: 'guest_checkout_limit_upgrade'; status: GuestCheckoutLimitUpgradeStatus };\n\nexport type Cancellation =\n  | { flow: 'buy'; transactionId?: string; challengeToken?: string }\n  | { flow: 'identity' }\n  | { flow: 'guest_checkout_limit_upgrade' };\n\n/**\n * The challenge frame is fully self-contained — it is driven by the\n * `challengeToken` URL param. There is no parent → child message map.\n */\nexport interface MessageMap {\n  ready: void;\n  complete: CompleteResult;\n  /** User dismissed the challenge. Carry `transactionId` / `challengeToken` to resume. */\n  cancelled: Cancellation;\n  error: FrameError;\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/dist/frames/challenge.d.cts

@@ -1,12 +1,21 @@
 import { FrameTransaction } from '../models/transaction.cjs';
 import { FrameError } from '../protocol.cjs';
 
+/**
+ * Mirrors the MoonPay API's `GuestCheckoutLimitUpgradeStatus` — a durable,
+ * poll-any-time-later fact rather than a short-lived value: `upgraded` and
+ * `rejected` reflect a persisted review outcome, not a transient in-progress signal.
+ */
+type GuestCheckoutLimitUpgradeStatus = 'pending' | 'upgraded' | 'rejected';
 type CompleteResult = {
     flow: 'buy';
     transaction: FrameTransaction;
 } | {
     flow: 'identity';
     identityId: string;
+} | {
+    flow: 'guest_checkout_limit_upgrade';
+    status: GuestCheckoutLimitUpgradeStatus;
 };
 type Cancellation = {
     flow: 'buy';
@@ -14,6 +23,8 @@ type Cancellation = {
     challengeToken?: string;
 } | {
     flow: 'identity';
+} | {
+    flow: 'guest_checkout_limit_upgrade';
 };
 /**
  * The challenge frame is fully self-contained — it is driven by the
@@ -27,4 +38,4 @@ interface MessageMap {
     error: FrameError;
 }
 
-export type { Cancellation, CompleteResult, MessageMap };
+export type { Cancellation, CompleteResult, GuestCheckoutLimitUpgradeStatus, MessageMap };

package/dist/frames/challenge.d.ts

@@ -1,12 +1,21 @@
 import { FrameTransaction } from '../models/transaction.js';
 import { FrameError } from '../protocol.js';
 
+/**
+ * Mirrors the MoonPay API's `GuestCheckoutLimitUpgradeStatus` — a durable,
+ * poll-any-time-later fact rather than a short-lived value: `upgraded` and
+ * `rejected` reflect a persisted review outcome, not a transient in-progress signal.
+ */
+type GuestCheckoutLimitUpgradeStatus = 'pending' | 'upgraded' | 'rejected';
 type CompleteResult = {
     flow: 'buy';
     transaction: FrameTransaction;
 } | {
     flow: 'identity';
     identityId: string;
+} | {
+    flow: 'guest_checkout_limit_upgrade';
+    status: GuestCheckoutLimitUpgradeStatus;
 };
 type Cancellation = {
     flow: 'buy';
@@ -14,6 +23,8 @@ type Cancellation = {
     challengeToken?: string;
 } | {
     flow: 'identity';
+} | {
+    flow: 'guest_checkout_limit_upgrade';
 };
 /**
  * The challenge frame is fully self-contained — it is driven by the
@@ -27,4 +38,4 @@ interface MessageMap {
     error: FrameError;
 }
 
-export type { Cancellation, CompleteResult, MessageMap };
+export type { Cancellation, CompleteResult, GuestCheckoutLimitUpgradeStatus, MessageMap };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@moonpay/platform-protocol",
-  "version": "1.13.1",
+  "version": "1.15.0",
   "description": "Shared protocol types for the MoonPay Developer Platform",
   "type": "module",
   "exports": {