NAME

Net::API::Stripe::Payment::Intent::NextAction - A Stripe Payment Next Action Object

SYNOPSIS

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',
});

VERSION

v0.101.0

DESCRIPTION

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

CONSTRUCTOR

new( %ARG )

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.

METHODS

boleto_display_details hash

Contains Boleto details necessary for the customer to complete the payment.

It has the following properties:

expires_at timestamp: The timestamp after which the boleto expires.
hosted_voucher_url string: The URL to the hosted boleto voucher page, which allows customers to view the boleto voucher.
number string: The boleto number.
pdf string: The URL to the downloadable boleto voucher PDF.

card_await_notification hash

Contains instructions for processing off session recurring payments with Indian issued cards.

It has the following properties:

charge_attempt_at timestamp: The time that payment will be attempted. If customer approval is required, they need to provide approval before this time.
customer_approval_required boolean: 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.

display_bank_transfer_instructions hash

Contains the bank transfer details necessary for the customer to complete the payment.

It has the following properties:

amount_remaining integer

The remaining amount that needs to be transferred to complete the payment.

currency currency

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

financial_addresses array

A list of financial addresses that can be used to fund the customer balance

iban hash

An IBAN-based FinancialAddress

account_holder_name string: The name of the person or business that owns the bank account
bic string: The BIC/SWIFT code of the account.
country string: Two-letter country code (ISO 3166-1 alpha-2.
iban string: The IBAN of the account.

sort_code hash

An account number and sort code-based FinancialAddress

account_holder_name string: The name of the person or business that owns the bank account
account_number string: The account number
sort_code string: The six-digit sort code

spei hash

A SPEI-based FinancialAddress

bank_code string: The three-digit bank code
bank_name string: The short banking institution name
clabe string: The CLABE number

supported_networks array

The payment networks supported by this FinancialAddress

type string

The type of financial address

zengin hash

A Zengin-based FinancialAddress

account_holder_name string: The account holder name
account_number string: The account number
account_type string: The bank account type. In Japan, this can only be futsu or toza.
bank_code string: The bank code of the account
bank_name string: The bank name of the account
branch_code string: The branch code of the account
branch_name string: The branch name of the account

hosted_instructions_url string

A link to a hosted page that guides your customer through completing the transfer.

reference string

A string identifying this payment. Instruct your customer to include this code in the reference or memo field of their bank transfer.

type string

Type of bank transfer

konbini_display_details hash

Contains Konbini details necessary for the customer to complete the payment.

It has the following properties:

expires_at timestamp

The timestamp at which the pending Konbini payment expires.

hosted_voucher_url string

The URL for the Konbini payment instructions page, which allows customers to view and print a Konbini voucher.

stores hash

Payment instruction details grouped by convenience store chain.

familymart hash

FamilyMart instruction details.

confirmation_number string: The confirmation number.
payment_code string: The payment code.

lawson hash

Lawson instruction details.

confirmation_number string: The confirmation number.
payment_code string: The payment code.

ministop hash

Ministop instruction details.

confirmation_number string: The confirmation number.
payment_code string: The payment code.

seicomart hash

Seicomart instruction details.

confirmation_number string: The confirmation number.
payment_code string: The payment code.

paynow_display_qr_code hash

The field that contains PayNow QR code info

It has the following properties:

data string: The raw data string used to generate QR code, it should be used together with QR code library.
image_url_png string: The image_url_png string used to render QR code
image_url_svg string: The image_url_svg string used to render QR code

promptpay_display_qr_code hash

The field that contains PromptPay QR code info

It has the following properties:

data string: The raw data string used to generate QR code, it should be used together with QR code library.
hosted_instructions_url string: The URL to the hosted PromptPay instructions page, which allows customers to view the PromptPay QR code.
image_url_png string: The imageurlpng string used to render QR code, can be used as <img src="…" />
image_url_svg string: The imageurlsvg string used to render QR code, can be used as <img src="…" />

redirect_to_url hash

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:

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.

verify_with_microdeposits hash

Contains details describing microdeposits verification flow.

It has the following properties:

arrival_date timestamp: The timestamp when the microdeposits are expected to land.
hosted_verification_url string: The URL for the hosted verification page, which allows customers to verify their bank account.
microdeposit_type string: The type of the microdeposit sent to the customer. Used to distinguish between different verification methods.

wechat_pay_display_qr_code hash

The field that contains WeChat Pay QR code info

It has the following properties:

data string: The data being used to generate QR code
image_data_url string: The base64 image data for a pre-generated QR code
image_url_png string: The image_url_png string used to render QR code
image_url_svg string: The image_url_svg string used to render QR code

wechat_pay_redirect_to_android_app hash

Info required for android app to app redirect

It has the following properties:

app_id string: app_id is the APP ID registered on WeChat open platform
nonce_str string: nonce_str is a random string
package string: package is static value
partner_id string: an unique merchant ID assigned by WeChat Pay
prepay_id string: an unique trading ID assigned by WeChat Pay
sign string: A signature
timestamp string: Specifies the current time in epoch format

wechat_pay_redirect_to_ios_app hash

Info required for iOS app to app redirect

It has the following properties:

native_url string: An universal link that redirect to WeChat Pay app

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_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
}

HISTORY

v0.1

Initial version

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

new( %ARG )

METHODS

boleto_display_details hash

card_await_notification hash

display_bank_transfer_instructions hash

konbini_display_details hash

paynow_display_qr_code hash

promptpay_display_qr_code hash

redirect_to_url hash

type string

use_stripe_sdk hash

verify_with_microdeposits hash

wechat_pay_display_qr_code hash

wechat_pay_redirect_to_android_app hash

wechat_pay_redirect_to_ios_app hash

API SAMPLE

HISTORY

v0.1

AUTHOR

SEE ALSO

COPYRIGHT & LICENSE

Module Install Instructions