The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
Net-API-Stripe-v2.0.4
River stage one • 1 direct dependent • 1 total dependent
3 ++
/ Net::API::Stripe::Payment::Intent

NAME

Net::API::Stripe::PaymentIntent - The PaymentIntent 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.102.0

DESCRIPTION

A PaymentIntent guides you through the process of collecting a payment from your customer. We recommend 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.

Related guide: Payment Intents API.

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

METHODS

id string

Unique identifier for the object.

object string

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

amount integer

Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or equivalent in charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).

amount_capturable integer

Amount that can be captured from this PaymentIntent.

amount_details hash

Details about items included in the amount

It has the following properties:

tip hash

Details about the tip.

When expanded, this is a Net::API::Stripe::Balance::ConnectReserved object.

amount_received integer

Amount that was collected by this PaymentIntent.

application expandable

ID of the Connect application that created the PaymentIntent.

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

application_fee_amount integer

The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents use case for connected accounts.

automatic_payment_methods object

Settings to configure compatible payment methods from the Stripe Dashboard

This is a Net::API::Stripe::Payment::Installment object.

canceled_at 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 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 string

Controls when the funds will be captured from the customer's account.

charges object

Charges that were created by this PaymentIntent, if any.

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

client_secret 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.

Refer to our docs to accept a payment and learn about how client_secret should be handled.

confirmation_method string

Possible enum values

automatic

(Default) PaymentIntent can be confirmed using a publishable key. After next_actions are handled, no additional confirmation is required to complete the payment.

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.

created timestamp

Time at which the object was created. Measured in seconds since the Unix epoch.

currency currency

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

customer expandable

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

Payment methods attached to other Customers cannot be used with this PaymentIntent.

If present in combination with setup_future_usage, this PaymentIntent's payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete.

When expanded this is an Net::API::Stripe::Customer object.

description string

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

invoice expandable

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

When expanded this is an Net::API::Stripe::Billing::Invoice object.

last_payment_error hash

The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason.

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

livemode 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 object

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.

on_behalf_of 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 an Net::API::Stripe::Connect::Account object.

payment_method expandable

ID of the payment method used in this PaymentIntent.

When expanded this is an Net::API::Stripe::Payment::Method object.

payment_method_options object

Payment-method-specific configuration for this PaymentIntent.

This is a Net::API::Stripe::Payment::Method object.

payment_method_types array of string

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

processing object

If present, this property tells you about the processing state of the payment.

This is a Net::API::Stripe::Issuing::Authorization::Transaction object.

receipt_email string

Email address that the receipt for the resulting payment will be sent to. If receipt_email is specified for a payment in live mode, a receipt will be sent regardless of your email settings.

review expandable

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

When expanded this is an Net::API::Stripe::Fraud::Review object.

setup_future_usage string

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

Providing this parameter will attach the payment method to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be attached to a Customer after the transaction completes.

When processing card payments, Stripe also uses setup_future_usage to dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.

shipping object

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 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 object

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::Connect::Transfer object.

It uses the following methods:

amount integer

Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or equivalent in charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).

destination string expandable

The account (if any) the payment will be attributed to for tax reporting, and where funds from the payment will be transferred to upon payment success.

When expanded this is an Net::API::Stripe::Connect::Account 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_1Dik5W2eZvKYlo2CDeNJH1A5",
      "object": "payment_intent",
      "amount": 1999,
      "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_1Dik5W2eZvKYlo2CDeNJH1A5"
      },
      "client_secret": "pi_1Dik5W2eZvKYlo2CDeNJH1A5_secret_YsxmIGlVxOrzmONrMv6KzeqGS",
      "confirmation_method": "automatic",
      "created": 1545145346,
      "currency": "gbp",
      "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.0

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>

SEE ALSO

Stripe API documentation:

https://stripe.com/docs/api/payment_intents, https://stripe.com/docs/payments/payment-intents/creating-payment-intents

COPYRIGHT & LICENSE

Copyright (c) 2019-2020 DEGUEST Pte. Ltd.

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