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             BEGIN
11             {
12             use strict;
13 2     2   24119002 use parent qw( Net::API::Stripe::Generic );
  2         17  
  2         79  
14 2     2   14 our( $VERSION ) = 'v0.1.0';
  2         6  
  2         10  
15 2     2   796 };
16              
17              
18 0     0 1    
19              
20 0     0 1    
21              
22 0     0 1    
23              
24 0     0 1    
25              
26 0     0 1    
27              
28 0     0 1   { posted_at => { type => "datetime" } }, @_ ) ); }
29              
30 0     0 1    
31             1;
32 0     0 1   # NOTE: POD
33              
34 0     0 1   =encoding utf8
35              
36 0     0 1   =head1 NAME
37              
38 0     0 1   Net::API::Stripe::Treasury::CreditReversal - The CreditReversal object
39              
40 0     0 1   =head1 SYNOPSIS
41              
42             =head1 VERSION
43 0     0 1    
44             v0.1.0
45              
46             =head1 DESCRIPTION
47              
48             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.
49              
50             =head1 METHODS
51              
52             =head2 id string
53              
54             Unique identifier for the object.
55              
56             =head2 object string
57              
58             String representing the object's type. Objects of the same type share the same value.
59              
60             =head2 amount integer
61              
62             Amount (in cents) transferred.
63              
64             =head2 currency currency
65              
66             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>.
67              
68             =head2 financial_account string
69              
70             The FinancialAccount to reverse funds from.
71              
72             =head2 hosted_regulatory_receipt_url string
73              
74             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.
75              
76             =head2 livemode boolean
77              
78             Has the value C<true> if the object exists in live mode or the value C<false> if the object exists in test mode.
79              
80             =head2 metadata hash
81              
82             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.
83              
84             =head2 network string
85              
86             The rails used to reverse the funds.
87              
88             =head2 received_credit string
89              
90             The ReceivedCredit being reversed.
91              
92             =head2 status string
93              
94             Status of the CreditReversal
95              
96             =head2 status_transitions hash
97              
98             Hash containing timestamps of when the object transitioned to a particular C<status>.
99              
100             It has the following properties:
101              
102             =over 4
103              
104             =item C<posted_at> timestamp
105              
106             Timestamp describing when the CreditReversal changed status to C<posted>
107              
108             =back
109              
110             =head2 transaction expandable
111              
112             The Transaction associated with this object.
113              
114             When expanded this is an L<Net::API::Stripe::Treasury::Transaction> object.
115              
116             =head1 API SAMPLE
117              
118             [
119             {
120             "amount" : "1000",
121             "currency" : "usd",
122             "financial_account" : "fa_1Le9F32eZvKYlo2CjbQcDQUE",
123             "hosted_regulatory_receipt_url" : "https://payments.stripe.com/regulatory-receipt/CBQaFwoVYWNjdF8xMDMyRDgyZVp2S1lsbzJDKN6u0JgGMgZ5OcNPutk6NpPqyGNMSnPeYuICbWV_67gyzu-WhKrtnutbIUkZW186FSWoCzhS4mHPYChKMkLzDubrcfUuiQ",
124             "id" : "credrev_1Le9F42eZvKYlo2CHPmAdXSp",
125             "livemode" : 0,
126             "metadata" : {},
127             "network" : "ach",
128             "object" : "treasury.credit_reversal",
129             "received_credit" : "rc_1Le9F42eZvKYlo2CM2wIU5bz",
130             "status" : "processing",
131             "status_transitions" : {
132             "posted_at" : null
133             },
134             "transaction" : "trxn_1Le9F32eZvKYlo2C2dtkse82"
135             }
136             ]
137              
138             =head1 HISTORY
139              
140             =head2 v0.1.0
141              
142             Initial version
143              
144             =head1 AUTHOR
145              
146             Jacques Deguest E<lt>F<jack@deguest.jp>E<gt>
147              
148             =head1 SEE ALSO
149              
150             L<Stripe API documentation|https://stripe.com/docs/api/treasury/credit_reversals>
151              
152             =head1 COPYRIGHT & LICENSE
153              
154             Copyright (c) 2019-2022 DEGUEST Pte. Ltd.
155              
156             You can use, copy, modify and redistribute this package and associated
157             files under the same terms as Perl itself.
158              
159             =cut