Net::API::Stripe::Payment::Intent::NextAction - A Stripe Payment Next Action Object
my $next = $stripe->payment_intent->next_action({ redirect_to_url => { return_url => 'https://example.com/pay/return', url => 'https://example.com/pay/auth', }, type => 'redirect_to_url', });
v0.101.0
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.
It used to be NextSourceAction, but the naming changed in Stripe API as of 2019-02-11
This is instantiated by method next_action in module Net::API::Stripe::Payment::Intent
Creates a new Net::API::Stripe::Payment::Intent::NextAction object. It may also take an hash like arguments, that also are method of the same name.
Contains Boleto details necessary for the customer to complete the payment.
It has the following properties:
expires_at
The timestamp after which the boleto expires.
hosted_voucher_url
The URL to the hosted boleto voucher page, which allows customers to view the boleto voucher.
number
The boleto number.
pdf
The URL to the downloadable boleto voucher PDF.
Contains instructions for processing off session recurring payments with Indian issued cards.
charge_attempt_at
The time that payment will be attempted. If customer approval is required, they need to provide approval before this time.
customer_approval_required
For payments greater than INR 15000, the customer must provide explicit approval of the payment with their bank. For payments of lower amount, no customer action is required.
Contains the bank transfer details necessary for the customer to complete the payment.
amount_remaining
The remaining amount that needs to be transferred to complete the payment.
currency
Three-letter ISO currency code, in lowercase. Must be a supported currency.
financial_addresses
A list of financial addresses that can be used to fund the customer balance
iban
An IBAN-based FinancialAddress
account_holder_name
The name of the person or business that owns the bank account
bic
The BIC/SWIFT code of the account.
country
Two-letter country code (ISO 3166-1 alpha-2.
The IBAN of the account.
sort_code
An account number and sort code-based FinancialAddress
account_number
The account number
The six-digit sort code
spei
A SPEI-based FinancialAddress
bank_code
The three-digit bank code
bank_name
The short banking institution name
clabe
The CLABE number
supported_networks
The payment networks supported by this FinancialAddress
type
The type of financial address
zengin
A Zengin-based FinancialAddress
The account holder name
account_type
The bank account type. In Japan, this can only be futsu or toza.
futsu
toza
The bank code of the account
The bank name of the account
branch_code
The branch code of the account
branch_name
The branch name of the account
hosted_instructions_url
A link to a hosted page that guides your customer through completing the transfer.
reference
A string identifying this payment. Instruct your customer to include this code in the reference or memo field of their bank transfer.
Type of bank transfer
Contains Konbini details necessary for the customer to complete the payment.
The timestamp at which the pending Konbini payment expires.
The URL for the Konbini payment instructions page, which allows customers to view and print a Konbini voucher.
stores
Payment instruction details grouped by convenience store chain.
familymart
FamilyMart instruction details.
confirmation_number
The confirmation number.
payment_code
The payment code.
lawson
Lawson instruction details.
ministop
Ministop instruction details.
seicomart
Seicomart instruction details.
The field that contains PayNow QR code info
data
The raw data string used to generate QR code, it should be used together with QR code library.
image_url_png
The image_url_png string used to render QR code
image_url_svg
The image_url_svg string used to render QR code
The field that contains PromptPay QR code info
The URL to the hosted PromptPay instructions page, which allows customers to view the PromptPay QR code.
The imageurlpng string used to render QR code, can be used as <img src="…" />
The imageurlsvg string used to render QR code, can be used as <img src="…" />
Contains instructions for authenticating a payment by redirecting your customer to another page or application.
This is actually a dynamic class Net::API::Stripe::Payment::Intent::NextAction::RedirectToUrl so the following property can be accessed as methods:
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.
Contains details describing microdeposits verification flow.
arrival_date
The timestamp when the microdeposits are expected to land.
hosted_verification_url
The URL for the hosted verification page, which allows customers to verify their bank account.
microdeposit_type
The type of the microdeposit sent to the customer. Used to distinguish between different verification methods.
The field that contains WeChat Pay QR code info
The data being used to generate QR code
image_data_url
The base64 image data for a pre-generated QR code
Info required for android app to app redirect
app_id
app_id is the APP ID registered on WeChat open platform
nonce_str
nonce_str is a random string
package
package is static value
partner_id
an unique merchant ID assigned by WeChat Pay
prepay_id
an unique trading ID assigned by WeChat Pay
sign
A signature
timestamp
Specifies the current time in epoch format
Info required for iOS app to app redirect
native_url
An universal link that redirect to WeChat Pay app
{ "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_ksjfjfbsjbfsmbfmf", "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 }
Initial version
Jacques Deguest <jack@deguest.jp>
Stripe API documentation:
https://stripe.com/docs/api/payment_intents/object
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.
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.