1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
|
package FS::cust_pay_pending;
use strict;
use vars qw( @ISA @encrypted_fields );
use FS::Record qw( qsearch qsearchs );
use FS::payby;
use FS::payinfo_Mixin;
use FS::cust_main;
use FS::cust_pay;
@ISA = qw(FS::Record FS::payinfo_Mixin);
@encrypted_fields = ('payinfo');
=head1 NAME
FS::cust_pay_pending - Object methods for cust_pay_pending records
=head1 SYNOPSIS
use FS::cust_pay_pending;
$record = new FS::cust_pay_pending \%hash;
$record = new FS::cust_pay_pending { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
=head1 DESCRIPTION
An FS::cust_pay_pending object represents an pending payment. It reflects
local state through the multiple stages of processing a real-time transaction
with an external gateway. FS::cust_pay_pending inherits from FS::Record. The
following fields are currently supported:
=over 4
=item paypendingnum
Primary key
=item custnum
Customer (see L<FS::cust_main>)
=item paid
Amount of this payment
=item _date
Specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
L<Time::Local> and L<Date::Parse> for conversion functions.
=item payby
Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
=item payinfo
Payment Information (See L<FS::payinfo_Mixin> for data format)
=item paymask
Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
=item paydate
Expiration date
=item payunique
Unique identifer to prevent duplicate transactions.
=item status
Pending transaction status, one of the following:
=over 4
=item new
Aquires basic lock on payunique
=item pending
Transaction is pending with the gateway
=item authorized
Only used for two-stage transactions that require a separate capture step
=item captured
Transaction completed with payment gateway (sucessfully), not yet recorded in
the database
=item declined
Transaction completed with payment gateway (declined), not yet recorded in
the database
=item done
Transaction recorded in database
=back
=item statustext
Additional status information.
=cut
#=item cust_balance -
=item paynum -
=back
=head1 METHODS
=over 4
=item new HASHREF
Creates a new pending payment. To add the pending payment to the database, see L<"insert">.
Note that this stores the hash reference, not a distinct copy of the hash it
points to. You can ask the object for a copy with the I<hash> method.
=cut
# the new method can be inherited from FS::Record, if a table method is defined
sub table { 'cust_pay_pending'; }
=item insert
Adds this record to the database. If there is an error, returns the error,
otherwise returns false.
=cut
# the insert method can be inherited from FS::Record
=item delete
Delete this record from the database.
=cut
# the delete method can be inherited from FS::Record
=item replace OLD_RECORD
Replaces the OLD_RECORD with this one in the database. If there is an error,
returns the error, otherwise returns false.
=cut
# the replace method can be inherited from FS::Record
=item check
Checks all fields to make sure this is a valid pending payment. If there is
an error, returns the error, otherwise returns false. Called by the insert
and replace methods.
=cut
# the check method should currently be supplied - FS::Record contains some
# data checking routines
sub check {
my $self = shift;
my $error =
$self->ut_numbern('paypendingnum')
|| $self->ut_foreign_key('custnum', 'cust_main', 'custnum')
|| $self->ut_money('paid')
|| $self->ut_numbern('_date')
|| $self->ut_textn('payunique')
|| $self->ut_text('status')
#|| $self->ut_textn('statustext')
|| $self->ut_anything('statustext')
#|| $self->ut_money('cust_balance')
|| $self->ut_foreign_keyn('paynum', 'cust_pay', 'paynum' )
|| $self->payinfo_check() #payby/payinfo/paymask/paydate
;
return $error if $error;
$self->_date(time) unless $self->_date;
# UNIQUE index should catch this too, without race conditions, but this
# should give a better error message the other 99.9% of the time...
if ( length($self->payunique) ) {
my $cust_pay_pending = qsearchs('cust_pay_pending', {
'payunique' => $self->payunique,
'paypendingnum' => { op=>'!=', value=>$self->paypendingnum },
});
if ( $cust_pay_pending ) {
#well, it *could* be a better error message
return "duplicate transaction - a payment with unique identifer ".
$self->payunique. " already exists";
}
}
$self->SUPER::check;
}
=back
=head1 BUGS
=head1 SEE ALSO
L<FS::Record>, schema.html from the base documentation.
=cut
1;
|