File Coverage

blib/lib/Net/API/Stripe/Connect/Account/Settings/CardPayments.pm
Criterion Covered Total %
statement 7 9 77.7
branch n/a
condition n/a
subroutine 3 5 60.0
pod 2 2 100.0
total 12 16 75.0


line stmt bran cond sub pod time code
1             ##----------------------------------------------------------------------------
2             ## Stripe API - ~/lib/Net/API/Stripe/Connect/Account/Settings/CardPayments.pm
3             ## Version v0.100.0
4             ## Copyright(c) 2019 DEGUEST Pte. Ltd.
5             ## Author: Jacques Deguest <@sitael.tokyo.deguest.jp>
6             ## Created 2019/11/02
7             ## Modified 2020/05/15
8             ##
9             ##----------------------------------------------------------------------------
10             package Net::API::Stripe::Connect::Account::Settings::CardPayments;
11             BEGIN
12             {
13 1     1   848 use strict;
  1         1  
  1         30  
14 1     1   5 use parent qw( Net::API::Stripe::Generic );
  1         2  
  1         4  
15 1     1   110 our( $VERSION ) = 'v0.100.0';
16             };
17              
18 0     0 1   sub decline_on { return( shift->_set_get_hash( 'decline_on', @_ ) ); }
19              
20 0     0 1   sub statement_descriptor_prefix { return( shift->_set_get_scalar( 'statement_descriptor_prefix', @_ ) ); }
21              
22             1;
23              
24             __END__
25              
26             =encoding utf8
27              
28             =head1 NAME
29              
30             Net::API::Stripe::Connect::Account::Settings::CardPayments - A Stripe Account Settings Object for Card Payments
31              
32             =head1 SYNOPSIS
33              
34             my $obj = $stripe->account->settings->card_payments({
35             decline_on =>
36             {
37             avs_failure => 0,
38             cvc_failure => 1,
39             },
40             statement_descriptor_prefix => 'Big Corp',
41             });
42              
43             =head1 VERSION
44              
45             v0.100.0
46              
47             =head1 DESCRIPTION
48              
49             Settings used to apply the account’s branding to email receipts, invoices, Checkout, and other products.
50              
51             This can be instantiated from method B<card_payments> in module L<Net::API::Stripe::Connect::Account::Settings>
52              
53             =head1 CONSTRUCTOR
54              
55             =over 4
56              
57             =item B<new>( %ARG )
58              
59             Creates a new L<Net::API::Stripe::Connect::Account::Settings::CardPayments> object.
60             It may also take an hash like arguments, that also are method of the same name.
61              
62             =back
63              
64             =head1 METHODS
65              
66             =over 4
67              
68             =item B<decline_on> hash
69              
70             Automatically declines certain charge types regardless of whether the card issuer accepted or declined the charge.
71              
72             =over 8
73              
74             =item I<avs_failure> boolean
75              
76             Whether Stripe automatically declines charges with an incorrect ZIP or postal code. This setting only applies when a ZIP or postal code is provided and they fail bank verification.
77              
78             =item I<cvc_failure> boolean
79              
80             Whether Stripe automatically declines charges with an incorrect CVC. This setting only applies when a CVC is provided and it fails bank verification.
81              
82             =back
83              
84             =item B<statement_descriptor_prefix> string
85              
86             The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic statement_descriptor specified on the charge. statement_descriptor_prefix is useful for maximizing descriptor space for the dynamic portion.
87              
88             =back
89              
90             =head1 API SAMPLE
91              
92             {
93             "id": "acct_fake123456789",
94             "object": "account",
95             "business_profile": {
96             "mcc": null,
97             "name": "My Shop, Inc",
98             "product_description": "Great products shipping all over the world",
99             "support_address": {
100             "city": "Tokyo",
101             "country": "JP",
102             "line1": "1-2-3 Kudan-minami, Chiyoda-ku",
103             "line2": "",
104             "postal_code": "100-0012",
105             "state": ""
106             },
107             "support_email": "billing@example.com",
108             "support_phone": "+81312345678",
109             "support_url": "",
110             "url": "https://www.example.com"
111             },
112             "business_type": "company",
113             "capabilities": {
114             "card_payments": "active"
115             },
116             "charges_enabled": true,
117             "country": "JP",
118             "default_currency": "jpy",
119             "details_submitted": true,
120             "email": "tech@example.com",
121             "metadata": {},
122             "payouts_enabled": true,
123             "settings": {
124             "branding": {
125             "icon": "file_fake123456789",
126             "logo": null,
127             "primary_color": "#0e77ca"
128             },
129             "card_payments": {
130             "decline_on": {
131             "avs_failure": false,
132             "cvc_failure": false
133             },
134             "statement_descriptor_prefix": null
135             },
136             "dashboard": {
137             "display_name": "myshop-inc",
138             "timezone": "Asia/Tokyo"
139             },
140             "payments": {
141             "statement_descriptor": "MYSHOP, INC",
142             "statement_descriptor_kana": "マイショップインク",
143             "statement_descriptor_kanji": "マイショップインク"
144             },
145             "payouts": {
146             "debit_negative_balances": true,
147             "schedule": {
148             "delay_days": 4,
149             "interval": "weekly",
150             "weekly_anchor": "thursday"
151             },
152             "statement_descriptor": null
153             }
154             },
155             "type": "standard"
156             }
157              
158             =head1 HISTORY
159              
160             =head2 v0.1
161              
162             Initial version
163              
164             =head1 AUTHOR
165              
166             Jacques Deguest E<lt>F<jack@deguest.jp>E<gt>
167              
168             =head1 SEE ALSO
169              
170             Stripe API documentation:
171              
172             L<https://stripe.com/docs/api/accounts/object>
173              
174             =head1 COPYRIGHT & LICENSE
175              
176             Copyright (c) 2019-2020 DEGUEST Pte. Ltd.
177              
178             You can use, copy, modify and redistribute this package and associated
179             files under the same terms as Perl itself.
180              
181             =cut