File Coverage

lib/Net/API/Stripe/Customer/TaxInfoVerification.pm
Criterion Covered Total %
statement 19 26 73.0
branch n/a
condition n/a
subroutine 7 14 50.0
pod 7 7 100.0
total 33 47 70.2


line stmt bran cond sub pod time code
1             ##----------------------------------------------------------------------------
2             ## Stripe API - ~/lib/Net/API/Stripe/Customer/TaxInfoVerification.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 1     1   945 use warnings;
  1         2  
  1         29  
14 1     1   5 use parent qw( Net::API::Stripe::Generic );
  1         2  
  1         27  
15 1     1   4 use vars qw( $VERSION );
  1         2  
  1         5  
16 1     1   64 our( $VERSION ) = 'v0.100.0';
  1         2  
  1         47  
17 1     1   19 };
18              
19             use strict;
20 1     1   5 use warnings;
  1         2  
  1         18  
21 1     1   5  
  1         1  
  1         230  
22              
23 0     0 1    
24              
25 0     0 1    
26             ## Can be either pending, unavailable, unverified, or verified
27 0     0 1    
28              
29 0     0 1    
30             1;
31              
32 0     0 1    
33             =encoding utf8
34 0     0 1    
35             =head1 NAME
36 0     0 1    
37             Net::API::Stripe::Customer::TaxInfoVerification - A Customer Tax Verification Object
38              
39             =head1 SYNOPSIS
40              
41             my $tx_info = $stripe->customer->tax_info_verification({
42             additional_document => $account_document_object,
43             details => 'Provided identity information could not be verified',
44             details_code => 'document_name_mismatch',
45             document => $account_document_object,
46             status => 'pending',
47             });
48              
49             =head1 VERSION
50              
51             v0.100.0
52              
53             =head1 DESCRIPTION
54              
55             This is instantiated by method B<tax_info_verification> in module B<Net::API::Stripe::Customer>
56              
57             =head1 CONSTRUCTOR
58              
59             =head2 new( %ARG )
60              
61             Creates a new L<Net::API::Stripe::Customer::TaxInfoVerification> object.
62             It may also take an hash like arguments, that also are method of the same name.
63              
64             =head1 METHODS
65              
66             =head2 additional_document hash
67              
68             A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.
69              
70             This is a L<Net::API::Stripe::Connect::Account::Document> object.
71              
72             =head2 details string
73              
74             A user-displayable string describing the verification state for the person. For example, this may say “Provided identity information could not be verified”.
75              
76             =head2 details_code string
77              
78             One of document_address_mismatch, document_dob_mismatch, document_duplicate_type, document_id_number_mismatch, document_name_mismatch, document_nationality_mismatch, failed_keyed_identity, or failed_other. A machine-readable code specifying the verification state for the person.
79              
80             =head2 document hash
81              
82             An identifying document for the person, either a passport or local ID card.
83              
84             This is a L<Net::API::Stripe::Connect::Account::Document> object.
85              
86             =head2 status string
87              
88             Verification status, one of pending, unavailable, unverified, or verified.
89              
90             =head2 verified_address string
91              
92             Verified address.
93              
94             =head2 verified_name string
95              
96             Verified name.
97              
98             =head1 API SAMPLE
99              
100             {
101             "id": "txi_123456789",
102             "object": "tax_id",
103             "country": "DE",
104             "created": 123456789,
105             "customer": "cus_fake123456789",
106             "livemode": false,
107             "type": "eu_vat",
108             "value": "DE123456789",
109             "verification": {
110             "status": "pending",
111             "verified_address": null,
112             "verified_name": null
113             }
114             }
115              
116             =head1 HISTORY
117              
118             =head2 v0.1
119              
120             Initial version
121              
122             =head1 AUTHOR
123              
124             Jacques Deguest E<lt>F<jack@deguest.jp>E<gt>
125              
126             =head1 SEE ALSO
127              
128             Stripe API documentation:
129              
130             L<https://stripe.com/docs/api/customers/>, L<https://stripe.com/docs/api/persons/object#person_object-relationship>
131              
132             =head1 COPYRIGHT & LICENSE
133              
134             Copyright (c) 2019-2020 DEGUEST Pte. Ltd.
135              
136             You can use, copy, modify and redistribute this package and associated
137             files under the same terms as Perl itself.
138              
139             =cut