Add STPPaymentIntent, and method to retrieve from the API given a clientSecret #985
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| // | ||
| // STPPaymentIntent.h | ||
| // Stripe | ||
| // | ||
| // Created by Daniel Jackson on 6/27/18. | ||
| // Copyright © 2018 Stripe, Inc. All rights reserved. | ||
| // | ||
|
|
||
| #import <Foundation/Foundation.h> | ||
|
|
||
| #import "STPAPIResponseDecodable.h" | ||
| #import "STPPaymentIntentEnums.h" | ||
|
|
||
| NS_ASSUME_NONNULL_BEGIN | ||
|
|
||
| /** | ||
| A PaymentIntent tracks the process of collecting a payment from your customer. | ||
|
|
||
| @see https://stripe.com/docs/api#payment_intents | ||
| @see https://stripe.com/docs/payments/dynamic-authentication | ||
| */ | ||
| @interface STPPaymentIntent : NSObject<STPAPIResponseDecodable> | ||
|
|
||
| /** | ||
| You cannot directly instantiate an `STPPaymentIntent`. You should only use one that | ||
| has been returned from an `STPAPIClient` callback. | ||
| */ | ||
| - (instancetype)init __attribute__((unavailable("You cannot directly instantiate an STPPaymentIntent. You should only use one that has been returned from an STPAPIClient callback."))); | ||
|
|
||
| /** | ||
| The Stripe ID of the PaymentIntent. | ||
| */ | ||
| @property (nonatomic, readonly) NSString *stripeId; | ||
|
|
||
| /** | ||
| The client secret used to fetch this PaymentIntent | ||
| */ | ||
| @property (nonatomic, readonly) NSString *clientSecret; | ||
|
|
||
| /** | ||
| The amount associated with the PaymentIntent | ||
|
There was a problem hiding this comment. Our doc has a better sounding description to me: "Amount intended to be collected by this PaymentIntent." |
||
| */ | ||
| @property (nonatomic, readonly) NSNumber *amount; | ||
|
|
||
| /** | ||
| If status is canceled, when the PaymentIntent was canceled. | ||
|
There was a problem hiding this comment. "If status is STPPaymentIntentStatusCanceled, when the PaymentIntent was canceled."? |
||
| */ | ||
| @property (nonatomic, nullable, readonly) NSDate *canceledAt; | ||
|
|
||
| /** | ||
| Capture method of this PaymentIntent | ||
| */ | ||
| @property (nonatomic, readonly) STPPaymentIntentCaptureMethod captureMethod; | ||
|
|
||
| /** | ||
| Confirmation method of this PaymentIntent | ||
| */ | ||
| @property (nonatomic, readonly) STPPaymentIntentConfirmationMethod confirmationMethod; | ||
|
|
||
| /** | ||
| When the PaymentIntent was created. | ||
| */ | ||
| @property (nonatomic, nullable, readonly) NSDate *created; | ||
|
|
||
| /** | ||
| The currency associated with the PaymentIntent. | ||
|
There was a problem hiding this comment. Our docs nicely mention it's the ISO currency code, I wonder if we mention that elsewhere we reference "Three-letter ISO currency code, in lowercase. Must be a supported currency." https://www.iso.org/iso-4217-currency-codes.html There was a problem hiding this comment. It looks mixed. Most headers that have a I think it's reasonable to elide this |
||
| */ | ||
| @property (nonatomic, readonly) NSString *currency; | ||
|
|
||
| /** | ||
| The `description` field of the PaymentIntent. | ||
| An arbitrary string attached to the object. Often useful for displaying to users. | ||
| */ | ||
| @property (nonatomic, nullable, readonly) NSString *stripeDescription; | ||
|
|
||
| /** | ||
| Whether or not this PaymentIntent was created in livemode. | ||
| */ | ||
| @property (nonatomic, readonly) BOOL livemode; | ||
|
|
||
| /** | ||
| Email address that the receipt for the resulting payment will be sent to. | ||
| */ | ||
| @property (nonatomic, nullable, readonly) NSString *receiptEmail; | ||
|
|
||
| /** | ||
| The Stripe ID of the Source used in this PaymentIntent. | ||
| */ | ||
| @property (nonatomic, nullable, readonly) NSString *sourceId; | ||
|
|
||
| /** | ||
| Status of the PaymentIntent | ||
| */ | ||
| @property (nonatomic, readonly) STPPaymentIntentStatus status; | ||
|
|
||
| @end | ||
|
|
||
| NS_ASSUME_NONNULL_END | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,94 @@ | ||
| // | ||
| // STPPaymentIntentEnums.h | ||
| // Stripe | ||
| // | ||
| // Created by Daniel Jackson on 6/27/18. | ||
| // Copyright © 2018 Stripe, Inc. All rights reserved. | ||
| // | ||
|
|
||
| /** | ||
| Status types for an STPPaymentIntent | ||
| */ | ||
| typedef NS_ENUM(NSInteger, STPPaymentIntentStatus) { | ||
| /** | ||
| Unknown status | ||
| */ | ||
| STPPaymentIntentStatusUnknown, | ||
|
|
||
| /** | ||
| This PaymentIntent requires a Source | ||
| */ | ||
| STPPaymentIntentStatusRequiresSource, | ||
|
|
||
| /** | ||
| This PaymentIntent needs to be confirmed | ||
| */ | ||
| STPPaymentIntentStatusRequiresConfirmation, | ||
|
|
||
| /** | ||
| The selected Source requires additional authentication steps. | ||
| Additional actions found via `next_source_action` | ||
| */ | ||
| STPPaymentIntentStatusRequiresSourceAction, | ||
|
|
||
| /** | ||
| Stripe is processing this PaymentIntent | ||
| */ | ||
| STPPaymentIntentStatusProcessing, | ||
|
|
||
| /** | ||
| The payment has succeeded | ||
| */ | ||
| STPPaymentIntentStatusSucceeded, | ||
|
|
||
| /** | ||
| Indicates the payment must be captured, for STPPaymentIntentCaptureMethodManual | ||
|
There was a problem hiding this comment. "Indicates the payment must be captured. The There was a problem hiding this comment. I guess what you have is fine, I'm just wondering what's the intention behind having a separate There was a problem hiding this comment.
|
||
| */ | ||
| STPPaymentIntentStatusRequiresCapture, | ||
|
|
||
| /** | ||
| This PaymentIntent was canceled and cannot be changed. | ||
| */ | ||
| STPPaymentIntentStatusCanceled, | ||
| }; | ||
|
|
||
| /** | ||
| Capture methods for a STPPaymentIntent | ||
| */ | ||
| typedef NS_ENUM(NSInteger, STPPaymentIntentCaptureMethod) { | ||
| /** | ||
| Unknown capture method | ||
| */ | ||
| STPPaymentIntentCaptureMethodUnknown, | ||
|
|
||
| /** | ||
| The PaymentIntent will be automatically captured | ||
| */ | ||
| STPPaymentIntentCaptureMethodAutomatic, | ||
|
|
||
| /** | ||
| The PaymentIntent must be manually captured once it has the status | ||
| `STPPaymentIntentStatusRequiresCapture` | ||
| */ | ||
| STPPaymentIntentCaptureMethodManual, | ||
| }; | ||
|
|
||
| /** | ||
| Confirmation methods for a STPPaymentIntent | ||
| */ | ||
| typedef NS_ENUM(NSInteger, STPPaymentIntentConfirmationMethod) { | ||
| /** | ||
| Unknown confirmation method | ||
| */ | ||
| STPPaymentIntentConfirmationMethodUnknown, | ||
|
|
||
| /** | ||
| Confirmed via publishable key | ||
| */ | ||
| STPPaymentIntentConfirmationMethodPublishable, | ||
|
|
||
| /** | ||
| Confirmed via secret key | ||
| */ | ||
| STPPaymentIntentConfirmationMethodSecret, | ||
| }; | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks like the docs for the other extension interface definitions in this file say "STPAPIClient extensions..."
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's actually a mix of extensions on
STPAPIClientand onStripe, which I didn't realize at first. Great catch, thanks!