Net::API::Stripe::Payment::Intent::Setup - A Stripe Charge Setup Intent
0.1
A SetupIntent guides you through the process of setting up a customer's payment credentials for future payments. For example, you could use a SetupIntent to set up your customer's card without immediately collecting a payment. Later, you can use PaymentIntents (Net::API::Stripe::Payment::Intent / https://stripe.com/docs/api/setup_intents#payment_intents) to drive the payment flow.
Net::API::Stripe::Payment::Intent
Create a SetupIntent as soon as you're ready to collect your customer's payment credentials. Do not maintain long-lived, unconfirmed SetupIntents as they may no longer be valid. The SetupIntent then transitions through multiple statuses as it guides you through the setup process.
Successful SetupIntents result in payment credentials that are optimized for future payments. For example, cardholders in certain regions may need to be run through Strong Customer Authentication at the time of payment method collection in order to streamline later off-session payments.
By using SetupIntents, you ensure that your customers experience the minimum set of required friction, even as regulations change over time.
Creates a new Net::API::Stripe objects. It may also take an hash like arguments, that also are method of the same name.
Net::API::Stripe
Toggles verbose mode on/off
Toggles debug mode on/off
Unique identifier for the object.
String representing the object’s type. Objects of the same type share the same value.
ID of the Connect application that created the SetupIntent. This is a string of the account or a Net::API::Stripe::Connect::Account object.
Net::API::Stripe::Connect::Account
Reason for cancellation of this SetupIntent, one of abandoned, requested_by_customer, or duplicate.
The client secret of this SetupIntent. Used for client-side retrieval using a publishable key.
The client secret can be used to complete payment setup from your frontend. It should not be stored, logged, embedded in URLs, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.
Time at which the object was created. Measured in seconds since the Unix epoch.
ID of the Customer this SetupIntent belongs to, if one exists, or the corresponding Net::API::Stripe::Customer object.
Net::API::Stripe::Customer
If present, payment methods used with this SetupIntent can only be attached to this Customer, and payment methods attached to other Customers cannot be used with this SetupIntent.
An arbitrary string attached to the object. Often useful for displaying to users.
The error encountered in the previous SetupIntent confirmation.
This is a Net::API::Stripe::Error object.
Net::API::Stripe::Error
Has the value true if the object exists in live mode or the value false if the object exists in test mode.
ID of the multi use Mandate generated by the SetupIntent. When expanded, this is a Net::API::Stripe::Mandate object.
Net::API::Stripe::Mandate
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
If present, this property tells you what actions you need to take in order for your customer to continue payment setup.
This is a Net::API::Stripe::Payment::Intent::NextAction object with the following properties:
Net::API::Stripe::Payment::Intent::NextAction
Contains instructions for authenticating a payment by redirecting your customer to another page or application. Show child attributes
If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion.
The URL you must redirect your customer to in order to authenticate the payment.
Type of the next action to perform, one of redirect_to_url or use_stripe_sdk.
When confirming a PaymentIntent 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.
The account (if any) for which the setup is intended.
ID of the payment method used with this SetupIntent.
When expanded, this is a Net::API::Stripe::Payment::Method object.
Net::API::Stripe::Payment::Method
Payment-method-specific configuration for this SetupIntent. Show child attributes
The list of payment method types (e.g. card) that this SetupIntent is allowed to set up.
ID of the single_use Mandate generated by the SetupIntent. When expanded, this is a Net::API::Stripe::Mandate object.
Status of this SetupIntent, one of requires_payment_method, requires_confirmation, requires_action, processing, canceled, or succeeded.
Indicates how the payment method is intended to be used in the future.
Use on_session if you intend to only reuse the payment method when the customer is in your checkout flow. Use off_session if your customer may or may not be in your checkout flow. If not provided, this value defaults to off_session.
{ "id": "seti_123456789", "object": "setup_intent", "application": null, "cancellation_reason": null, "client_secret": null, "created": 123456789, "customer": null, "description": null, "last_setup_error": null, "livemode": false, "metadata": { "user_id": "guest" }, "next_action": null, "on_behalf_of": null, "payment_method": null, "payment_method_options": {}, "payment_method_types": [ "card" ], "status": "requires_payment_method", "usage": "off_session" }
Initial version
Stripe has added 2 new properties: mandate and single_use_mandate
Jacques Deguest <jack@deguest.jp>
Stripe API documentation:
https://stripe.com/docs/api/setup_intents
Copyright (c) 2018-2019 DEGUEST Pte. Ltd.
You can use, copy, modify and redistribute this package and associated files under the same terms as Perl itself.
1 POD Error
The following errors were encountered while parsing the POD:
You forgot a '=back' before '=head1'
To install Net::API::Stripe, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Net::API::Stripe
CPAN shell
perl -MCPAN -e shell install Net::API::Stripe
For more information on module installation, please visit the detailed CPAN module installation guide.