Add onBehalfOf type to PaymentRequest (#592)

* Add onBehalfOf type to PaymentRequest * Invalid tests
stripe · Apr 5, 2024 · 1259510 · 1259510
1 parent a91238b
commit 1259510
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 0 deletions.
diff --git a/tests/types/src/invalid.ts b/tests/types/src/invalid.ts
@@ -416,3 +416,18 @@ stripe
     // @ts-expect-error mandate_data is not a valid parameter
     result.confirmationToken.mandate_data;
   });
+
+const paymentRequest = stripe.paymentRequest({
+  country: 'US',
+  currency: 'usd',
+  total: {
+    label: 'Demo total',
+    amount: 1000,
+  },
+  // @ts-expect-error Type 'number' is not assignable to type 'string'.
+  onBehalfOf: 123,
+});
+paymentRequest.update({
+  // @ts-expect-error Object literal may only specify known properties, and 'onBehalfOf' does not exist in type 'PaymentRequestUpdateOptions'.
+  onBehalfOf: 'acct_123',
+});
diff --git a/tests/types/src/valid.ts b/tests/types/src/valid.ts
@@ -3184,6 +3184,13 @@ const paymentRequest: PaymentRequest = stripe.paymentRequest({
   },
 });
 
+const paymentRequestOBO: PaymentRequest = stripe.paymentRequest({
+  country: 'US',
+  currency: 'usd',
+  total: {label: 'Demo total', amount: 1000},
+  onBehalfOf: 'acct_123',
+});
+
 paymentRequest.canMakePayment().then((result) => {
   if (result) {
     const {applePay}: CanMakePaymentResult = result;

diff --git a/types/stripe-js/payment-request.d.ts b/types/stripe-js/payment-request.d.ts
@@ -237,6 +237,11 @@ export interface PaymentRequestOptions {
    */
   applePay?: ApplePayOption;
 
+  /**
+   * The Stripe account ID which is the business of record.
+   */
+  onBehalfOf?: string;
+
   /**
    * @deprecated
    * Use disableWallets instead.