File Coverage

lib/Net/API/Stripe/Balance/Pending.pm
Criterion Covered Total %
statement 19 22 86.3
branch n/a
condition n/a
subroutine 7 10 70.0
pod 3 3 100.0
total 29 35 82.8


line stmt bran cond sub pod time code
1             ##----------------------------------------------------------------------------
2             ## Stripe API - ~/lib/Net/API/Stripe/Balance/Pending.pm
3             ## Version v0.100.0
4             ## Copyright(c) 2019 DEGUEST Pte. Ltd.
5             ## Author: Jacques Deguest <jack@deguest.jp>
6             ## Created 2019/11/02
7             ## Modified 2020/05/15
8             ##
9             ##----------------------------------------------------------------------------
10             BEGIN
11             {
12             use strict;
13 1     1   974 use warnings;
  1         2  
  1         32  
14 1     1   5 use parent qw( Net::API::Stripe::Generic );
  1         2  
  1         28  
15 1     1   10 use vars qw( $VERSION );
  1         2  
  1         5  
16 1     1   64 our( $VERSION ) = 'v0.100.0';
  1         2  
  1         45  
17 1     1   17 };
18              
19             use strict;
20 1     1   5 use warnings;
  1         2  
  1         16  
21 1     1   5  
  1         1  
  1         93  
22              
23 0     0 1    
24              
25 0     0 1   1;
26              
27 0     0 1    
28             =encoding utf8
29              
30             =head1 NAME
31              
32             Net::API::Stripe::Balance::Pending - A Stripe Pending Fund Object
33              
34             =head1 SYNOPSIS
35              
36             my $pending = $stripe->balance->pending({
37             amount => 100000,
38             currency => 'jpy',
39             source_types =>
40             {
41             bank_account => 1000000,
42             card => 10000,
43             },
44             });
45              
46             =head1 VERSION
47              
48             v0.100.0
49              
50             =head1 DESCRIPTION
51              
52             This is called from L<Net::API::Stripe::Balance> by B<pending> method.
53              
54             =head1 CONSTRUCTOR
55              
56             =head2 new( %ARG )
57              
58             Creates a new L<Net::API::Stripe::Balance::Pending> object.
59             It may also take an hash like arguments, that also are method of the same name.
60              
61             =head1 METHODS
62              
63             =head2 amount integer
64              
65             Balance amount.
66              
67             =head2 currency currency
68              
69             Three-letter ISO currency code, in lowercase. Must be a supported currency.
70              
71             =head2 source_types hash
72              
73             Breakdown of balance by source types. This is a virtual L<Net::API::Stripe::Payment::Source::Types> module that contains the following properties:
74              
75             =over 4
76              
77             =item I<bank_account> integer
78              
79             Amount for bank account.
80              
81             =item I<card> integer
82              
83             Amount for card.
84              
85             =back
86              
87             =head1 API SAMPLE
88              
89             {
90             "object": "balance",
91             "available": [
92             {
93             "amount": 7712,
94             "currency": "jpy",
95             "source_types": {
96             "card": 7712
97             }
98             }
99             ],
100             "connect_reserved": [
101             {
102             "amount": 0,
103             "currency": "jpy"
104             }
105             ],
106             "livemode": false,
107             "pending": [
108             {
109             "amount": 0,
110             "currency": "jpy",
111             "source_types": {
112             "card": 0
113             }
114             }
115             ]
116             }
117              
118             =head1 HISTORY
119              
120             =head2 v0.1
121              
122             Initial version
123              
124             =head1 AUTHOR
125              
126             Jacques Deguest E<lt>F<jack@deguest.jp>E<gt>
127              
128             =head1 SEE ALSO
129              
130             Stripe API documentation:
131              
132             L<https://stripe.com/docs/api>
133              
134             =head1 COPYRIGHT & LICENSE
135              
136             Copyright (c) 2019-2020 DEGUEST Pte. Ltd.
137              
138             You can use, copy, modify and redistribute this package and associated
139             files under the same terms as Perl itself.
140              
141             =cut