NAME
Net::API::Stripe::Connect::Account::Settings::Payouts - A Stripe Account Settings Object for Payouts
SYNOPSIS
my $payouts = $stripe->account->settings->payouts({
debit_negative_balances => $stripe->false,
schedule =>
{
delay_days => 7,
interval => 'weekly',
weekly_anchor => 'monday',
},
statement_descriptor => 'Weekly payout',
});VERSION
v0.100.0DESCRIPTION
Settings used to configure the account within the Stripe dashboard.
This is instantiated by method payouts from module Net::API::Stripe::Connect::Account::Settings
CONSTRUCTOR
new( %ARG )
Creates a new Net::API::Stripe::Connect::Account::Settings::Payouts object. It may also take an hash like arguments, that also are method of the same name.
METHODS
debit_negative_balances boolean
A Boolean indicating if Stripe should try to reclaim negative balances from an attached bank account. See Stripe Understanding Connect Account Balances documentation for details. Default value is true for Express accounts and false for Custom accounts.
schedule hash
Details on when funds from charges are available, and when they are paid out to an external account. See Stripe Setting Bank and Debit Card Payouts documentation for details.
This is a dynamic class with name Net::API::Stripe::Connect::Account::Settings::Payouts::Schedule. It is created using method _set_get_class from module Module::Generic
- delay_days positive integer or zero
-
The number of days charges for the account will be held before being paid out.
- interval string
-
How frequently funds will be paid out. One of manual (payouts only created via API call), daily, weekly, or monthly.
- monthly_anchor positive integer or zero
-
The day of the month funds will be paid out. Only shown if interval is monthly. Payouts scheduled between the 29th and 31st of the month are sent on the last day of shorter months.
- weekly_anchor string
-
The day of the week funds will be paid out, of the style ‘monday’, ‘tuesday’, etc. Only shown if interval is weekly.
statement_descriptor string
The text that appears on the bank account statement for payouts. If not set, this defaults to the platform’s bank descriptor as set in the Dashboard.
API SAMPLE
{
"id": "acct_fake123456789",
"object": "account",
"business_profile": {
"mcc": null,
"name": "My Shop, Inc",
"product_description": "Great products shipping all over the world",
"support_address": {
"city": "Tokyo",
"country": "JP",
"line1": "1-2-3 Kudan-minami, Chiyoda-ku",
"line2": "",
"postal_code": "100-0012",
"state": ""
},
"support_email": "billing@example.com",
"support_phone": "+81312345678",
"support_url": "",
"url": "https://www.example.com"
},
"business_type": "company",
"capabilities": {
"card_payments": "active"
},
"charges_enabled": true,
"country": "JP",
"default_currency": "jpy",
"details_submitted": true,
"email": "tech@example.com",
"metadata": {},
"payouts_enabled": true,
"settings": {
"branding": {
"icon": "file_fake123456789",
"logo": null,
"primary_color": "#0e77ca"
},
"card_payments": {
"decline_on": {
"avs_failure": false,
"cvc_failure": false
},
"statement_descriptor_prefix": null
},
"dashboard": {
"display_name": "myshop-inc",
"timezone": "Asia/Tokyo"
},
"payments": {
"statement_descriptor": "MYSHOP, INC",
"statement_descriptor_kana": "ﾏｲｼｮｯﾌﾟｲﾝｸ",
"statement_descriptor_kanji": "マイショップインク"
},
"payouts": {
"debit_negative_balances": true,
"schedule": {
"delay_days": 4,
"interval": "weekly",
"weekly_anchor": "thursday"
},
"statement_descriptor": null
}
},
"type": "standard"
}HISTORY
v0.1
Initial version
AUTHOR
Jacques Deguest <jack@deguest.jp>
SEE ALSO
Stripe API documentation:
https://stripe.com/docs/api/accounts/object
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.