NAME

Net::API::Stripe::Payment::Intent - A Stripe Payment Intent Object

SYNOPSIS

    my $intent = $stripe->payment_intent({
        amount => 2000,
        amount_capturable => 2000,
        application => $connect_account_object,
        application_fee_amount => 20,
        capture_method => 'automatic',
        customer => $customer_object,
        description => 'Preparation for payment',
        invoice => $invoice_object,
        metadata => { transaction_id => 123, customer_id => 456 },
        receipt_email => 'john.doe@example.com',
    });

See documentation in Net::API::Stripe for example to make api calls to Stripe to create those objects.

VERSION

    v0.100.0

DESCRIPTION

A PaymentIntent guides you through the process of collecting a payment from your customer. Stripe recommends that you create exactly one PaymentIntent for each order or customer session in your system. You can reference the PaymentIntent later to see the history of payment attempts for a particular session.

A PaymentIntent transitions through multiple statuses throughout its lifetime as it interfaces with Stripe.js to perform authentication flows and ultimately creates at most one successful charge.

Creating payments takes five steps:

1. Create a PaymentIntent on the server
2. Pass the PaymentIntent’s client secret to the client
3. Collect payment method details on the client
4. Submit the payment to Stripe from the client
5. Asynchronously fulfill the customer’s order

More info here: https://stripe.com/docs/payments/payment-intents/web

CONSTRUCTOR

new( %ARG ): Creates a new Net::API::Stripe::Payment::Intent object. It may also take an hash like arguments, that also are method of the same name.

METHODS

id retrievable with publishable key string

Unique identifier for the object.

object retrievable with publishable key string, value is "payment_intent"

String representing the object’s type. Objects of the same type share the same value.

amount retrievable with publishable key integer

Amount intended to be collected by this PaymentIntent.

amount_capturable integer

Amount that can be captured from this PaymentIntent.

amount_received integer

Amount that was collected by this PaymentIntent.

application string expandable "application"

ID of the Connect application that created the PaymentIntent.

This is a Net::API::Stripe::Connect::Account object.

application_fee_amount integer

The amount of the application fee (if any) for the resulting payment. See the PaymentIntents use case for connected accounts for details.

canceled_at retrievable with publishable key timestamp

Populated when status is canceled, this is the time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch.

cancellation_reason retrievable with publishable key string

Reason for cancellation of this PaymentIntent, either user-provided (duplicate, fraudulent, requested_by_customer, or abandoned) or generated by Stripe internally (failed_invoice, void_invoice, or automatic).

capture_method retrievable with publishable key string

One of automatic (default) or manual.

When the capture method is automatic, Stripe automatically captures funds when the customer authorizes the payment.

Change capture_method to manual if you wish to separate authorization and capture for payment methods that support this.

charges list

Charges that were created by this PaymentIntent, if any.

This is a Net::API::Stripe::Payment::Intent::Charges object.

client_secret retrievable with publishable key string

The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key.

The client secret can be used to complete a payment 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.

Please refer to Stripe quickstart guide to learn about how client_secret should be handled. confirmation_method retrievable with publishable key string

One of automatic (default) or manual.

When the confirmation method is automatic, a PaymentIntent can be confirmed using a publishable key. After next_actions are handled, no additional confirmation is required to complete the payment.

When the confirmation method is manual, all payment attempts must be made using a secret key. The PaymentIntent returns to the requires_confirmation state after handling next_actions, and requires your server to initiate each payment attempt with an explicit confirmation.

Learn more about the different confirmation flows.

created retrievable with publishable key timestamp

Time at which the object was created. Measured in seconds since the Unix epoch. currency retrievable with publishable key currency

Three-letter ISO currency code, in lowercase. Must be a supported currency.

customer string (expandable)

ID of the Customer this PaymentIntent belongs to, if one exists.

If present, payment methods used with this PaymentIntent can only be attached to this Customer, and payment methods attached to other Customers cannot be used with this PaymentIntent.

This is a customer id or a Net::API::Stripe::Customer object.

description retrievable with publishable key string

An arbitrary string attached to the object. Often useful for displaying to users.

invoice string (expandable)

ID of the invoice that created this PaymentIntent, if it exists.

When expanded, this is a ::API::Stripe::Billing::Invoice object.

last_payment_error retrievable with publishable key hash

The payment error encountered in the previous PaymentIntent confirmation.

This is a Net::API::Stripe::Error object.

livemode retrievable with publishable key boolean

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

metadata hash

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. For more information, see the documentation.

next_action retrievable with publishable key hash

If present, this property tells you what actions you need to take in order for your customer to fulfill a payment using the provided source.

This is a Net::API::Stripe::Payment::Intent::NextAction object with the following properties:

redirect_to_url hash

Contains instructions for authenticating a payment by redirecting your customer to another page or application.

See module Net::API::Stripe::Payment::Intent::NextAction for more information.

return_url string: If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion.
url string: The URL you must redirect your customer to in order to authenticate the payment.

type string

Type of the next action to perform, one of redirect_to_url or use_stripe_sdk.

use_stripe_sdk hash

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.

on_behalf_of string (expandable)

The account (if any) for which the funds of the PaymentIntent are intended. See the PaymentIntents use case for connected accounts for details.

When expanded, this is a Net::API::Stripe::Connect::Account object.

payment_method retrievable with publishable key string (expandable)

ID of the payment method used in this PaymentIntent.

payment_method_options hash

Payment-method-specific configuration for this PaymentIntent.

This is a virtual Net::API::Stripe::Payment::Method::Options object, ie a package created on the fly to allow the hash keys to be accessed as methods.

card hash: If the PaymentIntent’s payment_method_types includes card, this hash contains the configurations that will be applied to each payment attempt of that type.

payment_method_types retrievable with publishable key array containing strings

The list of payment method types (e.g. card) that this PaymentIntent is allowed to use.

receipt_email retrievable with publishable key string

Email address that the receipt for the resulting payment will be sent to.

review string (expandable)

ID of the review associated with this PaymentIntent, if any.

This is a Net::API::Stripe::Fraud::Review object.

setup_future_usage retrievable with publishable key string

Indicates that you intend to make future payments with this PaymentIntent’s payment method.

If present, the payment method used with this PaymentIntent can be attached to a Customer, even after the transaction completes.

Use on_session if you intend to only reuse the payment method when your customer is present in your checkout flow. Use off_session if your customer may or may not be in your checkout flow. See Saving card details after a payment to learn more.

Stripe uses setup_future_usage to dynamically optimize your payment flow and comply with regional legislation and network rules. For example, if your customer is impacted by SCA, using off_session will ensure that they are authenticated while processing this PaymentIntent. You will then be able to collect off-session payments for this customer.

shipping retrievable with publishable key hash

Shipping information for this PaymentIntent.

This is a Net::API::Stripe::Shipping object.

source

This is a Net::API::Stripe::Payment::Source, but it seems it is not documented on the Stripe API although it is found in its response.

statement_descriptor string

For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters.

statement_descriptor_suffix string

Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.

status retrievable with publishable key string

Status of this PaymentIntent, one of requires_payment_method, requires_confirmation, requires_action, processing, requires_capture, canceled, or succeeded. Read more about each PaymentIntent status.

transfer_data hash

The data with which to automatically create a Transfer when the payment is finalized. See the PaymentIntents use case for connected accounts for details.

This is a Net::API::Stripe::Payment::Intent::TransferData object.

transfer_group string

A string that identifies the resulting payment as part of a group. See the PaymentIntents use case for connected accounts for details.

API SAMPLE

        {
          "id": "pi_fake123456789",
          "object": "payment_intent",
          "amount": 1099,
          "amount_capturable": 0,
          "amount_received": 0,
          "application": null,
          "application_fee_amount": null,
          "canceled_at": null,
          "cancellation_reason": null,
          "capture_method": "automatic",
          "charges": {
                "object": "list",
                "data": [],
                "has_more": false,
                "url": "/v1/charges?payment_intent=pi_fake123456789"
          },
          "client_secret": "pi_fake123456789_secret_nvsnvmsbfmsbfmbfm",
          "confirmation_method": "automatic",
          "created": 1556596976,
          "currency": "jpy",
          "customer": null,
          "description": null,
          "invoice": null,
          "last_payment_error": null,
          "livemode": false,
          "metadata": {},
          "next_action": null,
          "on_behalf_of": null,
          "payment_method": null,
          "payment_method_options": {},
          "payment_method_types": [
                "card"
          ],
          "receipt_email": null,
          "review": null,
          "setup_future_usage": null,
          "shipping": null,
          "statement_descriptor": null,
          "statement_descriptor_suffix": null,
          "status": "requires_payment_method",
          "transfer_data": null,
          "transfer_group": null
        }

HISTORY

v0.1

Initial version

STRIPE HISTORY

2019-02-11

allowed_source_types has been renamed to payment_method_types.

2019-02-11

The next_source_action property on PaymentIntent has been renamed to next_action, and the authorize_with_url within has been renamed to redirect_to_url.

AUTHOR

Jacques Deguest <jack@deguest.jp>

COPYRIGHT & LICENSE

You can use, copy, modify and redistribute this package and associated files under the same terms as Perl itself.

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.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)

NAME

SYNOPSIS

VERSION

DESCRIPTION

CONSTRUCTOR

METHODS

API SAMPLE

HISTORY

v0.1

STRIPE HISTORY

2019-02-11

2019-02-11

AUTHOR

SEE ALSO

COPYRIGHT & LICENSE

Module Install Instructions