Add ECE custom error message types (#723)

* Add ece custom error message types * Prettier
stripe · Feb 28, 2025 · af12a8e · af12a8e
1 parent 73cab60
commit af12a8e
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 2 deletions.
diff --git a/tests/types/src/invalid.ts b/tests/types/src/invalid.ts
@@ -193,7 +193,7 @@ expressCheckoutElement.on('shippingaddresschange', ({address, resolve}) => {
 });
 
 expressCheckoutElement.on('confirm', ({paymentFailed}) => {
-  // @ts-expect-error Can only fail a payment for a reason of 'fail' or 'invalid-shipping-address'
+  // @ts-expect-error Can only fail a payment for a reason of 'fail', 'invalid_shipping_address', 'invalid_billing_address', 'invalid_payment_data', or 'address_unserviceable'
   paymentFailed({reason: 'pizza-time'});
 });
 

diff --git a/tests/types/src/valid.ts b/tests/types/src/valid.ts
@@ -1052,6 +1052,10 @@ expressCheckoutElement.on('confirm', ({paymentFailed, expressPaymentType}) => {
   paymentFailed();
   paymentFailed({});
   paymentFailed({reason: 'invalid_shipping_address'});
+  paymentFailed({reason: 'invalid_billing_address'});
+  paymentFailed({reason: 'invalid_payment_data'});
+  paymentFailed({reason: 'address_unserviceable'});
+  paymentFailed({message: 'Test error message'});
 });
 
 expressCheckoutElement.on(

diff --git a/types/stripe-js/elements/express-checkout.d.ts b/types/stripe-js/elements/express-checkout.d.ts
@@ -529,7 +529,13 @@ export interface StripeExpressCheckoutElementConfirmEvent {
    * Callback when a payment is unsuccessful. Optionally, specifying a reason will show a more detailed error in the payment interface.
    */
   paymentFailed: (payload?: {
-    reason?: 'fail' | 'invalid_shipping_address';
+    reason?:
+      | 'fail'
+      | 'invalid_shipping_address'
+      | 'invalid_billing_address'
+      | 'invalid_payment_data'
+      | 'address_unserviceable';
+    message?: string;
   }) => void;
 
   billingDetails?: BillingDetails;