File Coverage

blib/lib/Net/API/Stripe/Issuing/Authorization/VerificationData.pm
Criterion Covered Total %
statement 7 14 50.0
branch n/a
condition n/a
subroutine 3 10 30.0
pod 7 7 100.0
total 17 31 54.8


line stmt bran cond sub pod time code
1             ##----------------------------------------------------------------------------
2             ## Stripe API - ~/lib/Net/API/Stripe/Issuing/Authorization/VerificationData.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::Issuing::Authorization::VerificationData;
11             BEGIN
12             {
13 1     1   878 use strict;
  1         3  
  1         28  
14 1     1   5 use parent qw( Net::API::Stripe::Generic );
  1         2  
  1         88  
15 1     1   182 our( $VERSION ) = 'v0.100.0';
16             };
17              
18 0     0 1   sub address_line1_check { return( shift->_set_get_scalar( 'address_line1_check', @_ ) ); }
19              
20 0     0 1   sub address_postal_code_check { return( shift->_set_get_scalar( 'address_postal_code_check', @_ ) ); }
21              
22 0     0 1   sub address_zip_check { return( shift->_set_get_scalar( 'address_zip_check', @_ ) ); }
23              
24 0     0 1   sub authentication { return( shift->_set_get_scalar( 'authentication', @_ ) ); }
25              
26 0     0 1   sub cvc_check { return( shift->_set_get_scalar( 'cvc_check', @_ ) ); }
27              
28 0     0 1   sub expiry_check { return( shift->_set_get_scalar( 'expiry_check', @_ ) ); }
29              
30 0     0 1   sub three_d_secure { return( shift->_set_get_hash( 'three_d_secure', @_ ) ); }
31              
32             1;
33              
34             __END__
35              
36             =encoding utf8
37              
38             =head1 NAME
39              
40             Net::API::Stripe::Issuing::Authorization::VerificationData - A Stripe Authorization Verification Date Object
41              
42             =head1 SYNOPSIS
43              
44             my $data = $stripe->authorization->verification_data({
45             address_line1_check => 'match',
46             address_postal_code_check => 'match',
47             address_zip_check => 'match',
48             authentication => 'success',
49             cvc_check => 'match',
50             expiry_check => 'match',
51             three_d_secure => { result => 'authenticated' },
52             });
53              
54             =head1 VERSION
55              
56             v0.100.0
57              
58             =head1 DESCRIPTION
59              
60             Verification data used by method B<verification_data> in module L<Net::API::Stripe::Issuing::Authorization>
61              
62             =head1 CONSTRUCTOR
63              
64             =over 4
65              
66             =item B<new>( %ARG )
67              
68             Creates a new L<Net::API::Stripe::Issuing::Authorization::VerificationData> object.
69             It may also take an hash like arguments, that also are method of the same name.
70              
71             =back
72              
73             =head1 METHODS
74              
75             =over 4
76              
77             =item B<address_line1_check> string
78              
79             One of match, mismatch, or not_provided.
80              
81             =item B<address_postal_code_check>
82              
83             Whether the cardholder provided a postal code and if it matched the cardholder’s billing.address.postal_code.
84              
85             Possible enum values
86              
87             =over 4
88              
89             =item I<match>
90              
91             Verification succeeded, values matched.
92              
93             =item I<mismatch>
94              
95             Verification failed, values didn’t match.
96              
97             =item I<not_provided>
98              
99             Verification was not performed because no value was provided.
100              
101             =back
102              
103             =item B<address_zip_check> string
104              
105             One of match, mismatch, or not_provided.
106              
107             =item B<authentication> string
108              
109             One of success, failure, exempt, or none.
110              
111             =item B<cvc_check> string
112              
113             One of match, mismatch, or not_provided.
114              
115             =item B<expiry_check>
116              
117             Whether the cardholder provided an expiry date and if it matched Stripe’s record.
118              
119             Possible enum values
120              
121             =over 4
122              
123             =item I<match>
124              
125             Verification succeeded, values matched.
126              
127             =item I<mismatch>
128              
129             Verification failed, values didn’t match.
130              
131             =item I<not_provided>
132              
133             Verification was not performed because no value was provided.
134              
135             =back
136              
137             =item B<three_d_secure> hash
138              
139             3D Secure details on this authorization.
140              
141             It has the one following property
142              
143             =over 8
144              
145             =item I<result>
146              
147             With following possible enum values
148              
149             =over 12
150              
151             =item I<authenticated>
152              
153             Authentication successful.
154              
155             =item I<failed>
156              
157             Authentication failed.
158              
159             =item I<attempt_acknowledged>
160              
161             The merchant attempted to authenticate the authorization, but the cardholder is not enrolled or was unable to reach Stripe.
162              
163             =back
164              
165             =back
166              
167             =back
168              
169             =head1 API SAMPLE
170              
171             {
172             "id": "iauth_fake123456789",
173             "object": "issuing.authorization",
174             "approved": true,
175             "authorization_method": "online",
176             "authorized_amount": 500,
177             "authorized_currency": "usd",
178             "balance_transactions": [],
179             "card": null,
180             "cardholder": null,
181             "created": 1540642827,
182             "held_amount": 0,
183             "held_currency": "usd",
184             "is_held_amount_controllable": false,
185             "livemode": false,
186             "merchant_data": {
187             "category": "taxicabs_limousines",
188             "city": "San Francisco",
189             "country": "US",
190             "name": "Rocket Rides",
191             "network_id": "1234567890",
192             "postal_code": "94107",
193             "state": "CA",
194             "url": null
195             },
196             "metadata": {},
197             "pending_authorized_amount": 0,
198             "pending_held_amount": 0,
199             "request_history": [],
200             "status": "reversed",
201             "transactions": [
202             {
203             "id": "ipi_fake123456789",
204             "object": "issuing.transaction",
205             "amount": -100,
206             "authorization": "iauth_fake123456789",
207             "balance_transaction": null,
208             "card": "ic_fake123456789",
209             "cardholder": null,
210             "created": 1540642827,
211             "currency": "usd",
212             "dispute": null,
213             "livemode": false,
214             "merchant_amount": null,
215             "merchant_currency": null,
216             "merchant_data": {
217             "category": "taxicabs_limousines",
218             "city": "San Francisco",
219             "country": "US",
220             "name": "Rocket Rides",
221             "network_id": "1234567890",
222             "postal_code": "94107",
223             "state": "CA",
224             "url": null
225             },
226             "metadata": {},
227             "type": "capture"
228             },
229             {
230             "id": "ipi_fake123456789",
231             "object": "issuing.transaction",
232             "amount": -100,
233             "authorization": "iauth_fake123456789",
234             "balance_transaction": null,
235             "card": "ic_fake123456789",
236             "cardholder": null,
237             "created": 1540642827,
238             "currency": "usd",
239             "dispute": null,
240             "livemode": false,
241             "merchant_amount": null,
242             "merchant_currency": null,
243             "merchant_data": {
244             "category": "taxicabs_limousines",
245             "city": "San Francisco",
246             "country": "US",
247             "name": "Rocket Rides",
248             "network_id": "1234567890",
249             "postal_code": "94107",
250             "state": "CA",
251             "url": null
252             },
253             "metadata": {},
254             "type": "capture"
255             }
256             ],
257             "verification_data": {
258             "address_line1_check": "not_provided",
259             "address_zip_check": "match",
260             "authentication": "none",
261             "cvc_check": "match"
262             },
263             "wallet_provider": null
264             }
265              
266             =head1 HISTORY
267              
268             =head2 v0.1
269              
270             Initial version
271              
272             =head1 AUTHOR
273              
274             Jacques Deguest E<lt>F<jack@deguest.jp>E<gt>
275              
276             =head1 SEE ALSO
277              
278             Stripe API documentation:
279              
280             L<https://stripe.com/docs/api/issuing/authorizations/object>
281              
282             =head1 COPYRIGHT & LICENSE
283              
284             Copyright (c) 2019-2020 DEGUEST Pte. Ltd.
285              
286             You can use, copy, modify and redistribute this package and associated
287             files under the same terms as Perl itself.
288              
289             =cut