platform-types 1.10.760 → 1.10.761

package/dist/cjs/paymentAttempt.js

@@ -19,7 +19,7 @@
  * no operator write can carry it back onto the order.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PAYMENT_ATTEMPT_RESOLUTION_CAUSES = exports.ORDER_NOT_PAYABLE_REASONS = exports.PAYMENT_ATTEMPT_ERROR_CODES = exports.PAYMENT_ATTEMPT_STATES = void 0;
+exports.PAYMENT_HOLD_MINUTES_DEFAULT = exports.PAYMENT_HOLD_MINUTES_MAX = exports.PAYMENT_HOLD_MINUTES_MIN = exports.PAYMENT_ATTEMPT_RESOLUTION_CAUSES = exports.ORDER_NOT_PAYABLE_REASONS = exports.PAYMENT_ATTEMPT_ERROR_CODES = exports.PAYMENT_ATTEMPT_STATES = void 0;
 /** Every {@link PaymentAttemptState}, in lifecycle order. */
 exports.PAYMENT_ATTEMPT_STATES = [
     'created',
@@ -86,3 +86,12 @@ exports.PAYMENT_ATTEMPT_RESOLUTION_CAUSES = [
     'not-settled',
     'late-capture',
 ];
+/**
+ * The bounds of the store's payment hold, `ecommerce.config.paymentHoldMinutes`
+ * — how long a new attempt stays payable, in whole minutes. Both writers refuse
+ * a value outside `[MIN, MAX]` (`400 VALIDATION_FAILED`); the start reads an
+ * absent or out-of-range stored value as `DEFAULT`.
+ */
+exports.PAYMENT_HOLD_MINUTES_MIN = 15;
+exports.PAYMENT_HOLD_MINUTES_MAX = 1440;
+exports.PAYMENT_HOLD_MINUTES_DEFAULT = 60;

package/dist/payment.d.ts

@@ -136,6 +136,18 @@ declare global {
         externalReference?: string;
         reconciled?: boolean;
         reconcileReason?: string;
+        /**
+         * MercadoPago's own money breakdown, in major units of `currency`: `gross` is
+         * `transaction_amount`, `net` is `transaction_details.net_received_amount`
+         * (what the store received), and `fee` is what MercadoPago kept
+         * (`gross − net`; the collector-paid `fee_details` when MercadoPago states no
+         * net). Each is present only when MercadoPago reported it, on MercadoPago
+         * payments recorded since these fields existed. Absent means "not recorded",
+         * never zero; a `fee` of `0` is a fee-free payment.
+         */
+        gross?: number;
+        fee?: number;
+        net?: number;
     }
     /**
      * Confidence tier for a link suggestion.

package/dist/paymentAttempt.d.ts

@@ -34,7 +34,9 @@ declare global {
      *   left as it is and the attempt stays `expired` — not `resolution`, since
      *   that money is not this attempt's.
      * - `cancelled` — the order was cancelled while the attempt was live.
-     * - `refunded` — the approved payment was refunded.
+     * - `refunded` — the approved payment was refunded. Only from `approved`: a
+     *   refund on a `resolution` attempt is the operator's resolution work and
+     *   leaves it `resolution`.
      * - `charged_back` — the approved payment was charged back.
      * - `resolution` — money landed that must NOT settle the order: an approval
      *   on an order already paid, on an expired or cancelled order, or for an
@@ -175,4 +177,13 @@ export declare const ORDER_NOT_PAYABLE_REASONS: readonly ["cancelled", "paid", "
  *   expired or been cancelled, or the order was already cancelled.
  */
 export declare const PAYMENT_ATTEMPT_RESOLUTION_CAUSES: readonly ["second-approval", "amount-mismatch", "order-mismatch", "order-already-paid", "not-settled", "late-capture"];
+/**
+ * The bounds of the store's payment hold, `ecommerce.config.paymentHoldMinutes`
+ * — how long a new attempt stays payable, in whole minutes. Both writers refuse
+ * a value outside `[MIN, MAX]` (`400 VALIDATION_FAILED`); the start reads an
+ * absent or out-of-range stored value as `DEFAULT`.
+ */
+export declare const PAYMENT_HOLD_MINUTES_MIN = 15;
+export declare const PAYMENT_HOLD_MINUTES_MAX = 1440;
+export declare const PAYMENT_HOLD_MINUTES_DEFAULT = 60;
 export {};

package/dist/paymentAttempt.js

@@ -83,3 +83,12 @@ export const PAYMENT_ATTEMPT_RESOLUTION_CAUSES = [
     'not-settled',
     'late-capture',
 ];
+/**
+ * The bounds of the store's payment hold, `ecommerce.config.paymentHoldMinutes`
+ * — how long a new attempt stays payable, in whole minutes. Both writers refuse
+ * a value outside `[MIN, MAX]` (`400 VALIDATION_FAILED`); the start reads an
+ * absent or out-of-range stored value as `DEFAULT`.
+ */
+export const PAYMENT_HOLD_MINUTES_MIN = 15;
+export const PAYMENT_HOLD_MINUTES_MAX = 1440;
+export const PAYMENT_HOLD_MINUTES_DEFAULT = 60;

package/dist/store.d.ts

@@ -146,6 +146,18 @@ declare global {
              * frame), so the storefront can say the account needs approval.
              */
             registrationMode?: 'open' | 'approval';
+            /**
+             * How long a storefront online payment holds the order, in whole
+             * minutes: the payment attempt's `expiresAt` and its Checkout Pro
+             * Preference's `expiration_date_to` are this far from the start.
+             * An integer from `PAYMENT_HOLD_MINUTES_MIN` (15) to
+             * `PAYMENT_HOLD_MINUTES_MAX` (1440); absent means
+             * `PAYMENT_HOLD_MINUTES_DEFAULT` (60), and so does a stored value
+             * outside that range. Written by `PATCH /store` (ADMIN) and
+             * `PUT /platform/stores/{storeId}` (MANAGER). Never sent to shoppers:
+             * they see the attempt's `expiresAt` instead.
+             */
+            paymentHoldMinutes?: number;
             showStocks?: boolean;
         };
         sidebar?: {
@@ -188,7 +200,7 @@ declare global {
      * data: { field: 'ecommerce.config.newCustomerPriceList', value: number }; nothing written.
      */
     interface EcommercePatchInput {
-        config?: Pick<NonNullable<Ecommerce['config']>, 'showDefaultPriceList' | 'newCustomerPriceList' | 'registrationMode'> & StorefrontLiveSettingsPatch;
+        config?: Pick<NonNullable<Ecommerce['config']>, 'showDefaultPriceList' | 'newCustomerPriceList' | 'registrationMode' | 'paymentHoldMinutes'> & StorefrontLiveSettingsPatch;
         sidebar?: Ecommerce['sidebar'];
         home?: Omit<NonNullable<Ecommerce['home']>, 'displayOrders' | 'displayProfile'>;
         themeColors?: Ecommerce['themeColors'];

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "platform-types",
-	"version": "1.10.760",
+	"version": "1.10.761",
 	"description": "Shared wire and entity contracts for the platform.",
 	"type": "module",
 	"main": "dist/index.js",