File Coverage

lib/Net/API/Stripe/Payment/Source/Receiver.pm
Criterion Covered Total %
statement 19 25 76.0
branch n/a
condition n/a
subroutine 7 13 53.8
pod 6 6 100.0
total 32 44 72.7


line stmt bran cond sub pod time code
1             ##----------------------------------------------------------------------------
2             ## Stripe API - ~/lib/Net/API/Stripe/Payment/Source/Receiver.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 2     2   24029167 use warnings;
  2         13  
  2         68  
14 2     2   10 use parent qw( Net::API::Stripe::Generic );
  2         6  
  2         64  
15 2     2   9 use vars qw( $VERSION );
  2         5  
  2         10  
16 2     2   140 our( $VERSION ) = 'v0.100.0';
  2         10  
  2         126  
17 2     2   40 };
18              
19             use strict;
20 2     2   12 use warnings;
  2         6  
  2         56  
21 2     2   11  
  2         4  
  2         392  
22              
23 0     0 1    
24              
25 0     0 1    
26              
27 0     0 1    
28             1;
29 0     0 1    
30              
31 0     0 1   =encoding utf8
32              
33 0     0 1   =head1 NAME
34              
35             Net::API::Stripe::Payment::Source::Receiver - A Stripe Payment Receiver Object
36              
37             =head1 SYNOPSIS
38              
39             my $rcv = $stripe->source->receiver({
40             address => '1-2-3 Kudan-Minami, Chiyoda-ku, Tokyo 123-4567 Japan',
41             amount_charged => 2000,
42             });
43              
44             =head1 VERSION
45              
46             v0.100.0
47              
48             =head1 DESCRIPTION
49              
50             Information related to the receiver flow. Present if the source is a receiver (flow is receiver).
51              
52             This is part of the L<Net::API::Stripe::Payment::Source> object
53              
54             =head1 CONSTRUCTOR
55              
56             =head2 new( %ARG )
57              
58             Creates a new L<Net::API::Stripe::Payment::Source::Receiver> 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 address string
64              
65             The address of the receiver source. This is the value that should be communicated to the customer to send their funds to.
66              
67             =head2 amount_charged integer
68              
69             The total amount that was charged by you. The amount charged is expressed in the source’s currency.
70              
71             =head2 amount_received integer
72              
73             The total amount received by the receiver source. amount_received = amount_returned + amount_charged is true at all time. The amount received is expressed in the source’s currency.
74              
75             =head2 amount_returned integer
76              
77             The total amount that was returned to the customer. The amount returned is expressed in the source’s currency.
78              
79             =head2 refund_attributes_method string
80              
81             Type of refund attribute method, one of email, manual, or none.
82              
83             =head2 refund_attributes_status string
84              
85             Type of refund attribute status, one of missing, requested, or available.
86              
87             =head1 API SAMPLE
88              
89             {
90             "id": "src_fake123456789",
91             "object": "source",
92             "ach_credit_transfer": {
93             "account_number": "test_52796e3294dc",
94             "routing_number": "110000000",
95             "fingerprint": "avmabmnabvmnvb",
96             "bank_name": "TEST BANK",
97             "swift_code": "TSTEZ122"
98             },
99             "amount": null,
100             "client_secret": "src_client_secret_fake123456789",
101             "created": 1571314413,
102             "currency": "jpy",
103             "flow": "receiver",
104             "livemode": false,
105             "metadata": {},
106             "owner": {
107             "address": null,
108             "email": "jenny.rosen@example.com",
109             "name": null,
110             "phone": null,
111             "verified_address": null,
112             "verified_email": null,
113             "verified_name": null,
114             "verified_phone": null
115             },
116             "receiver": {
117             "address": "121042882-38381234567890123",
118             "amount_charged": 0,
119             "amount_received": 0,
120             "amount_returned": 0,
121             "refund_attributes_method": "email",
122             "refund_attributes_status": "missing"
123             },
124             "statement_descriptor": null,
125             "status": "pending",
126             "type": "ach_credit_transfer",
127             "usage": "reusable"
128             }
129              
130             =head1 HISTORY
131              
132             =head2 v0.1
133              
134             Initial version
135              
136             =head1 AUTHOR
137              
138             Jacques Deguest E<lt>F<jack@deguest.jp>E<gt>
139              
140             =head1 SEE ALSO
141              
142             Stripe API documentation:
143              
144             L<https://stripe.com/docs/api/sources/object>
145              
146             =head1 COPYRIGHT & LICENSE
147              
148             Copyright (c) 2019-2020 DEGUEST Pte. Ltd.
149              
150             You can use, copy, modify and redistribute this package and associated
151             files under the same terms as Perl itself.
152              
153             =cut