File Coverage

lib/Net/API/Stripe/Treasury/DebitReversal.pm
Criterion Covered Total %
statement 7 21 33.3
branch n/a
condition n/a
subroutine 3 17 17.6
pod 14 14 100.0
total 24 52 46.1


line stmt bran cond sub pod time code
1             ##----------------------------------------------------------------------------
2             ## Stripe API - ~/lib/Net/API/Stripe/Treasury/DebitReversal.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   24222926 use parent qw( Net::API::Stripe::Generic );
  2         16  
  2         73  
14 2     2   12 our( $VERSION ) = 'v0.1.0';
  2         5  
  2         10  
15 2     2   801 };
16              
17              
18 0     0 1    
19              
20 0     0 1    
21              
22 0     0 1    
23             { issuing_dispute => { type => "scalar" } }, @_ ) ); }
24 0     0 1    
25              
26 0     0 1    
27              
28 0     0 1    
29              
30 0     0 1    
31              
32             1;
33 0     0 1   # NOTE: POD
34              
35 0     0 1   =encoding utf8
36              
37 0     0 1   =head1 NAME
38              
39 0     0 1   Net::API::Stripe::Treasury::DebitReversal - The DebitReversal object
40              
41 0     0 1   =head1 SYNOPSIS
42              
43 0     0 1   =head1 VERSION
44              
45 0     0 1   v0.1.0
46              
47             =head1 DESCRIPTION
48              
49             You can reverse some L<ReceivedDebits|https://stripe.com/docs/api/treasury/received_debits> depending on their network and source flow. Reversing a ReceivedDebit leads to the creation of a new object known as a DebitReversal.
50              
51             =head1 METHODS
52              
53             =head2 id string
54              
55             Unique identifier for the object.
56              
57             =head2 object string
58              
59             String representing the object's type. Objects of the same type share the same value.
60              
61             =head2 amount integer
62              
63             Amount (in cents) transferred.
64              
65             =head2 currency currency
66              
67             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>.
68              
69             =head2 financial_account string
70              
71             The FinancialAccount to reverse funds from.
72              
73             =head2 hosted_regulatory_receipt_url string
74              
75             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.
76              
77             =head2 linked_flows hash
78              
79             Other flows linked to a DebitReversal.
80              
81             It has the following properties:
82              
83             =over 4
84              
85             =item C<issuing_dispute> string
86              
87             Set if there is an Issuing dispute associated with the DebitReversal.
88              
89             =back
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_debit string
104              
105             The ReceivedDebit being reversed.
106              
107             =head2 status string
108              
109             Status of the DebitReversal
110              
111             =head2 status_transitions object
112              
113             Hash containing timestamps of when the object transitioned to a particular C<status>.
114              
115             This is a L<Net::API::Stripe::Billing::Subscription::Schedule> object.
116              
117             =head2 transaction expandable
118              
119             The Transaction associated with this object.
120              
121             When expanded this is an L<Net::API::Stripe::Treasury::Transaction> object.
122              
123             =head1 API SAMPLE
124              
125             [
126             {
127             "amount" : "1000",
128             "currency" : "usd",
129             "financial_account" : "fa_1Le9F32eZvKYlo2CjbQcDQUE",
130             "hosted_regulatory_receipt_url" : "https://payments.stripe.com/regulatory-receipt/CBQaFwoVYWNjdF8xMDMyRDgyZVp2S1lsbzJDKN6u0JgGMgZ5wklFW6A6NpM6vaRPqAA3MfviuxTVdP3EJG4azU5gXKVEXCmp3Kb06tC0LoZCqWCdfl0iQhcDzdQfLekmyQ",
131             "id" : "debrev_1Le9F42eZvKYlo2Cb7q6jmDW",
132             "linked_flows" : null,
133             "livemode" : 0,
134             "metadata" : {},
135             "network" : "ach",
136             "object" : "treasury.debit_reversal",
137             "received_debit" : "rd_1Le9F42eZvKYlo2C0TIJJqNP",
138             "status" : "processing",
139             "status_transitions" : {
140             "completed_at" : null
141             },
142             "transaction" : "trxn_1Le9F32eZvKYlo2C2dtkse82"
143             }
144             ]
145              
146             =head1 HISTORY
147              
148             =head2 v0.1.0
149              
150             Initial version
151              
152             =head1 AUTHOR
153              
154             Jacques Deguest E<lt>F<jack@deguest.jp>E<gt>
155              
156             =head1 SEE ALSO
157              
158             L<Stripe API documentation|https://stripe.com/docs/api/treasury/debit_reversals>
159              
160             =head1 COPYRIGHT & LICENSE
161              
162             Copyright (c) 2019-2022 DEGUEST Pte. Ltd.
163              
164             You can use, copy, modify and redistribute this package and associated
165             files under the same terms as Perl itself.
166              
167             =cut