File Coverage

lib/Net/API/Stripe/Treasury/CreditReversal.pm
Criterion Covered Total %
statement 7 20 35.0
branch n/a
condition n/a
subroutine 3 16 18.7
pod 13 13 100.0
total 23 49 46.9


line stmt bran cond sub pod time code
1             ##----------------------------------------------------------------------------
2             ## Stripe API - ~/lib/Net/API/Stripe/Treasury/CreditReversal.pm
3             ## Version v0.1.0
4             ## Copyright(c) 2022 DEGUEST Pte. Ltd.
5             ## Author: Jacques Deguest <jack@deguest.jp>
6             ## Created 2022/10/29
7             ## Modified 2022/10/29
8             ##
9             ##----------------------------------------------------------------------------
10             package Net::API::Stripe::Treasury::CreditReversal;
11             BEGIN
12             {
13 2     2   21367079 use strict;
  2         19  
  2         81  
14 2     2   11 use parent qw( Net::API::Stripe::Generic );
  2         5  
  2         12  
15 2     2   796 our( $VERSION ) = 'v0.1.0';
16             };
17              
18 0     0 1   sub id { return( shift->_set_get_scalar( 'id', @_ ) ); }
19              
20 0     0 1   sub object { return( shift->_set_get_scalar( 'object', @_ ) ); }
21              
22 0     0 1   sub amount { return( shift->_set_get_number( 'amount', @_ ) ); }
23              
24 0     0 1   sub currency { return( shift->_set_get_number( 'currency', @_ ) ); }
25              
26 0     0 1   sub financial_account { return( shift->_set_get_scalar( 'financial_account', @_ ) ); }
27              
28 0     0 1   sub hosted_regulatory_receipt_url { return( shift->_set_get_scalar( 'hosted_regulatory_receipt_url', @_ ) ); }
29              
30 0     0 1   sub livemode { return( shift->_set_get_boolean( 'livemode', @_ ) ); }
31              
32 0     0 1   sub metadata { return( shift->_set_get_hash( 'metadata', @_ ) ); }
33              
34 0     0 1   sub network { return( shift->_set_get_scalar( 'network', @_ ) ); }
35              
36 0     0 1   sub received_credit { return( shift->_set_get_scalar( 'received_credit', @_ ) ); }
37              
38 0     0 1   sub status { return( shift->_set_get_scalar( 'status', @_ ) ); }
39              
40 0     0 1   sub status_transitions { return( shift->_set_get_class( 'status_transitions',
41             { posted_at => { type => "datetime" } }, @_ ) ); }
42              
43 0     0 1   sub transaction { return( shift->_set_get_scalar_or_object( 'transaction', 'Net::API::Stripe::Treasury::Transaction', @_ ) ); }
44              
45             1;
46             # NOTE: POD
47             __END__
48              
49             =encoding utf8
50              
51             =head1 NAME
52              
53             Net::API::Stripe::Treasury::CreditReversal - The CreditReversal object
54              
55             =head1 SYNOPSIS
56              
57             =head1 VERSION
58              
59             v0.1.0
60              
61             =head1 DESCRIPTION
62              
63             You can reverse some L<ReceivedCredits|https://stripe.com/docs/api/treasury/received_credits> depending on their network and source flow. Reversing a ReceivedCredit leads to the creation of a new object known as a CreditReversal.
64              
65             =head1 METHODS
66              
67             =head2 id string
68              
69             Unique identifier for the object.
70              
71             =head2 object string
72              
73             String representing the object's type. Objects of the same type share the same value.
74              
75             =head2 amount integer
76              
77             Amount (in cents) transferred.
78              
79             =head2 currency currency
80              
81             Three-letter L<ISO currency code|https://www.iso.org/iso-4217-currency-codes.html>, in lowercase. Must be a L<supported currency|https://stripe.com/docs/currencies>.
82              
83             =head2 financial_account string
84              
85             The FinancialAccount to reverse funds from.
86              
87             =head2 hosted_regulatory_receipt_url string
88              
89             A L<hosted transaction receipt|https://stripe.com/docs/treasury/moving-money/regulatory-receipts> URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
90              
91             =head2 livemode boolean
92              
93             Has the value C<true> if the object exists in live mode or the value C<false> if the object exists in test mode.
94              
95             =head2 metadata hash
96              
97             Set of L<key-value pairs|https://stripe.com/docs/api/metadata> that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
98              
99             =head2 network string
100              
101             The rails used to reverse the funds.
102              
103             =head2 received_credit string
104              
105             The ReceivedCredit being reversed.
106              
107             =head2 status string
108              
109             Status of the CreditReversal
110              
111             =head2 status_transitions hash
112              
113             Hash containing timestamps of when the object transitioned to a particular C<status>.
114              
115             It has the following properties:
116              
117             =over 4
118              
119             =item C<posted_at> timestamp
120              
121             Timestamp describing when the CreditReversal changed status to C<posted>
122              
123             =back
124              
125             =head2 transaction expandable
126              
127             The Transaction associated with this object.
128              
129             When expanded this is an L<Net::API::Stripe::Treasury::Transaction> object.
130              
131             =head1 API SAMPLE
132              
133             [
134             {
135             "amount" : "1000",
136             "currency" : "usd",
137             "financial_account" : "fa_1Le9F32eZvKYlo2CjbQcDQUE",
138             "hosted_regulatory_receipt_url" : "https://payments.stripe.com/regulatory-receipt/CBQaFwoVYWNjdF8xMDMyRDgyZVp2S1lsbzJDKN6u0JgGMgZ5OcNPutk6NpPqyGNMSnPeYuICbWV_67gyzu-WhKrtnutbIUkZW186FSWoCzhS4mHPYChKMkLzDubrcfUuiQ",
139             "id" : "credrev_1Le9F42eZvKYlo2CHPmAdXSp",
140             "livemode" : 0,
141             "metadata" : {},
142             "network" : "ach",
143             "object" : "treasury.credit_reversal",
144             "received_credit" : "rc_1Le9F42eZvKYlo2CM2wIU5bz",
145             "status" : "processing",
146             "status_transitions" : {
147             "posted_at" : null
148             },
149             "transaction" : "trxn_1Le9F32eZvKYlo2C2dtkse82"
150             }
151             ]
152              
153             =head1 HISTORY
154              
155             =head2 v0.1.0
156              
157             Initial version
158              
159             =head1 AUTHOR
160              
161             Jacques Deguest E<lt>F<jack@deguest.jp>E<gt>
162              
163             =head1 SEE ALSO
164              
165             L<Stripe API documentation|https://stripe.com/docs/api/treasury/credit_reversals>
166              
167             =head1 COPYRIGHT & LICENSE
168              
169             Copyright (c) 2019-2022 DEGUEST Pte. Ltd.
170              
171             You can use, copy, modify and redistribute this package and associated
172             files under the same terms as Perl itself.
173              
174             =cut