Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add verify microdeposits type to SetupIntent next action object #656

Merged
merged 1 commit into from
Oct 4, 2024
Merged

Add verify microdeposits type to SetupIntent next action object #656

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion tests/types/src/valid.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2854,7 +2854,13 @@ stripe

stripe
.verifyMicrodepositsForSetup('', {amounts: [32, 45]})
.then((result: {setupIntent?: SetupIntent; error?: StripeError}) => null);
.then((result: {setupIntent?: SetupIntent; error?: StripeError}) => {
if (result.setupIntent?.next_action?.verify_with_microdeposits) {
console.log(
result.setupIntent?.next_action?.verify_with_microdeposits.arrival_date
);
}
});

stripe
.verifyMicrodepositsForSetup('', {
Expand Down
31 changes: 28 additions & 3 deletions types/api/setup-intents.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,17 +131,25 @@ export namespace SetupIntent {
}

export interface NextAction {
redirect_to_url?: NextAction.RedirectToUrl;

/**
* Type of the next action to perform, one of `redirect_to_url` or `use_stripe_sdk`.
* Type of the next action to perform, one of `redirect_to_url`, `use_stripe_sdk`, or `verify_with_microdeposits`.
*/
type: string;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At this point it's likely not worth fixing, especially since it would be a breaking change, but I wonder why we used string instead of hardcoding type: 'redirect_to_url' | 'use_stripe_sdk' | 'verify_with_microdeposits'


/**
* Contains instructions for authenticating a payment by redirecting your customer to another page or application.
*/
redirect_to_url?: NextAction.RedirectToUrl;

/**
* When confirming a SetupIntent with Stripe.js, Stripe.js depends on the contents of this dictionary to invoke authentication flows. The shape of the contents is subject to change and is only intended to be used by Stripe.js.
*/
use_stripe_sdk?: NextAction.UseStripeSdk;

/**
* Contains details describing microdeposits verification flow.
*/
verify_with_microdeposits?: NextAction.VerifyWithMicrodeposits;
}

export namespace NextAction {
Expand All @@ -158,6 +166,23 @@ export namespace SetupIntent {
}

export interface UseStripeSdk {}

export interface VerifyWithMicrodeposits {
/**
* The timestamp when the microdeposits are expected to land.
*/
arrival_date: number;

/**
* The URL for the hosted verification page, which allows customers to verify their bank account.
*/
hosted_verification_url: string;

/**
* The type of the microdeposit sent to the customer. Used to distinguish between different verification methods.
*/
microdeposit_type: string | null;
}
}

export type Status =
Expand Down
Loading