FIX: TS def XX_bank_account -> XX_bank_transfer

[hideokamoto-stripe]

The API and document tell us using xx_bank_transfer string to the confirmCustomerBalancePayment method.
But this SDK shows the error when we using these values.

I think we need to these definition

Summary & motivation

When we want to use confirmCustomerBalancePayment method with TypeScript.
We got these errors:

TypeScript Error:

When we copy and paste this example code from the documents:
https://stripe.com/docs/payments/bank-transfers/accept-a-payment?platform=api#collect-payment-method-options

stripe.confirmCustomerBalancePayment(
  '{PAYMENT_INTENT_CLIENT_SECRET}',
  {
    payment_method: {
      customer_balance: {
      },
    },
    payment_method_options: {
      customer_balance: {
        funding_type: 'bank_transfer',
        bank_transfer: {
          type: 'eu_bank_transfer',
          eu_bank_transfer: {
            country: 'FR',
          }
        },
      },
    },
  },
  {
    handleActions: false,
  }
)

We got the TypeScript error:

./pages/payment_intents/index.tsx:55:23
Type error: Type '"eu_bank_transfer"' is not assignable to type '"us_bank_account" | "eu_bank_account" | "id_bank_account" | "gb_bank_account" | "jp_bank_account" | "mx_bank_account"'.

  53 |                     funding_type: 'bank_transfer',
  54 |                     bank_transfer: {
> 55 |                       type: 'eu_bank_transfer',
     |                       ^
  56 |                       eu_bank_transfer: {
  57 |                         country: 'FR',
  58 |                       }

> Build error occurred

API error:

I tried to update the code to allow the TypeScript error:

stripe.confirmCustomerBalancePayment(
  '{PAYMENT_INTENT_CLIENT_SECRET}',
  {
    payment_method: {
      customer_balance: {
      },
    },
    payment_method_options: {
      customer_balance: {
        funding_type: 'bank_transfer',
        bank_transfer: {
-          type: 'eu_bank_transfer',
+          type: 'eu_bank_account',
-          eu_bank_transfer: {
+          eu_bank_account: {
            country: 'FR',
          }
        },
      },
    },
  },
  {
    handleActions: false,
  }
)

Then, the Stripe API returned this error:

code: "parameter_unknown"
doc_url: "https://stripe.com/docs/error-codes/parameter-unknown"
message: "Received unknown parameter: payment_method_options[customer_balance][bank_transfer][eu_bank_account]. Did you mean eu_bank_transfer?"
param: "payment_method_options[customer_balance][bank_transfer][eu_bank_account]"

So, we may need to update the TypeScript definition to resolve the conflicts.

Thanks!

[martinalong-stripe]

Whoops looks like there was a bit of confusion about who would merge this in! Amazing job catching this @hideokamoto-stripe.

I notice that the API ref for this also says "account" so I went ahead and messaged the owners of these docs to double check that these should indeed say "transfer" rather than "account". Once confirmed, I'll merge this in and they will correct the API ref.

[alessandro-stripe]

@martinalong-stripe hey there, xx_bank_account has been indeed deprecated in favour of xx_bank_transfer

[alessandro-stripe]

NB: This includes some values that haven't been GA'd are only accessible via gating and/or beta headers