File Coverage

blib/lib/Net/API/Stripe/Payment/Source/CodeVerification.pm
Criterion Covered Total %
statement 7 9 77.7
branch n/a
condition n/a
subroutine 3 5 60.0
pod 2 2 100.0
total 12 16 75.0


line stmt bran cond sub pod time code
1             ##----------------------------------------------------------------------------
2             ## Stripe API - ~/lib/Net/API/Stripe/Payment/Source/CodeVerification.pm
3             ## Version v0.100.0
4             ## Copyright(c) 2019 DEGUEST Pte. Ltd.
5             ## Author: Jacques Deguest <@sitael.tokyo.deguest.jp>
6             ## Created 2019/11/02
7             ## Modified 2020/05/15
8             ##
9             ##----------------------------------------------------------------------------
10             package Net::API::Stripe::Payment::Source::CodeVerification;
11             BEGIN
12             {
13 1     1   871 use strict;
  1         2  
  1         28  
14 1     1   5 use parent qw( Net::API::Stripe::Generic );
  1         1  
  1         5  
15 1     1   103 our( $VERSION ) = 'v0.100.0';
16             };
17              
18 0     0 1   sub attempts_remaining { shift->_set_get_scalar( 'attempts_remaining', @_ ); }
19              
20 0     0 1   sub status { shift->_set_get_scalar( 'status', @_ ); }
21              
22             1;
23              
24             __END__
25              
26             =encoding utf8
27              
28             =head1 NAME
29              
30             Net::API::Stripe::Payment::Source::CodeVerification - A Stripe Code Verification Object
31              
32             =head1 SYNOPSIS
33              
34             my $code = $stripe->source->code_verification({
35             attempts_remaining => 2,
36             status => 'pending',
37             });
38              
39             =head1 VERSION
40              
41             v0.100.0
42              
43             =head1 DESCRIPTION
44              
45             Information related to the code verification flow. Present if the source is authenticated by a verification code (flow is code_verification).
46              
47             This is part of the L<Net::API::Stripe::Payment::Source> object
48              
49             =head1 CONSTRUCTOR
50              
51             =over 4
52              
53             =item B<new>( %ARG )
54              
55             Creates a new L<Net::API::Stripe::Payment::Source::CodeVerification> object.
56             It may also take an hash like arguments, that also are method of the same name.
57              
58             =back
59              
60             =head1 METHODS
61              
62             =over 4
63              
64             =item B<attempts_remaining> integer
65              
66             The number of attempts remaining to authenticate the source object with a verification code.
67              
68             =item B<status> string
69              
70             The status of the code verification, either pending (awaiting verification, attempts_remaining should be greater than 0), succeeded (successful verification) or failed (failed verification, cannot be verified anymore as attempts_remaining should be 0).
71              
72             =back
73              
74             =head1 API SAMPLE
75              
76             {
77             "id": "src_fake123456789",
78             "object": "source",
79             "ach_credit_transfer": {
80             "account_number": "test_52796e3294dc",
81             "routing_number": "110000000",
82             "fingerprint": "kabvkbmvbmbv",
83             "bank_name": "TEST BANK",
84             "swift_code": "TSTEZ122"
85             },
86             "amount": null,
87             "client_secret": "src_client_secret_fake123456789",
88             "created": 1571314413,
89             "currency": "jpy",
90             "flow": "receiver",
91             "livemode": false,
92             "metadata": {},
93             "owner": {
94             "address": null,
95             "email": "jenny.rosen@example.com",
96             "name": null,
97             "phone": null,
98             "verified_address": null,
99             "verified_email": null,
100             "verified_name": null,
101             "verified_phone": null
102             },
103             "receiver": {
104             "address": "121042882-38381234567890123",
105             "amount_charged": 0,
106             "amount_received": 0,
107             "amount_returned": 0,
108             "refund_attributes_method": "email",
109             "refund_attributes_status": "missing"
110             },
111             "statement_descriptor": null,
112             "status": "pending",
113             "type": "ach_credit_transfer",
114             "usage": "reusable"
115             }
116              
117             =head1 HISTORY
118              
119             =head2 v0.1
120              
121             Initial version
122              
123             =head1 AUTHOR
124              
125             Jacques Deguest E<lt>F<jack@deguest.jp>E<gt>
126              
127             =head1 SEE ALSO
128              
129             Stripe API documentation:
130              
131             L<https://stripe.com/docs/api/sources/object>
132              
133             =head1 COPYRIGHT & LICENSE
134              
135             Copyright (c) 2019-2020 DEGUEST Pte. Ltd.
136              
137             You can use, copy, modify and redistribute this package and associated
138             files under the same terms as Perl itself.
139              
140             =cut