NAME

Net::API::Stripe::Financial::Connections::Session - The Session object

SYNOPSIS

VERSION

v0.1.0

DESCRIPTION

A Financial Connections Session is the secure way to programmatically launch the client-side Stripe.js modal that lets your users link their accounts.

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.

account_holder object

The account holder for whom accounts are collected in this session.

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

accounts object

The accounts that were collected as part of this Session.

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

client_secret string

A value that will be passed to the client to launch the authentication flow.

filters hash

Filters applied to this session that restrict the kinds of accounts to collect.

It has the following properties:

countries string_array

List of countries from which to filter accounts.

livemode boolean

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

permissions array

Permissions requested for accounts collected during this session.

return_url string

For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.

API SAMPLE

[ { "accountholder" : { "account" : "acct_1KdUF8RhmIBPIfCO", "type" : "account" }, "client_secret" : "fcsess_client_secret_PZri8EdhlStQTdnecntKdjnx", "filters" : { "countries" : [ "US" ] }, "id" : "fcsess_1LE8to2eZvKYlo2CeCL5ftCO", "linked_accounts" : { "data" : [], "has_more" : 0, "object" : "list", "url" : "/v1/linked_accounts" }, "livemode" : 0, "object" : "link_account_session", "permissions" : [ "ownership", "payment_method" ] } ]

HISTORY

v0.1.0

Initial version

AUTHOR

Jacques Deguest <jack@deguest.jp>

SEE ALSO

Stripe API documentation

COPYRIGHT & LICENSE

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

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