1 package FS::cust_pay_pending;
4 use vars qw( @ISA @encrypted_fields );
5 use FS::Record qw( qsearch qsearchs dbh ); #dbh for _upgrade_data
6 use FS::payinfo_transaction_Mixin;
7 use FS::cust_main_Mixin;
12 @ISA = qw( FS::payinfo_transaction_Mixin FS::cust_main_Mixin FS::Record );
14 @encrypted_fields = ('payinfo');
15 sub nohistory_fields { ('payinfo'); }
19 FS::cust_pay_pending - Object methods for cust_pay_pending records
23 use FS::cust_pay_pending;
25 $record = new FS::cust_pay_pending \%hash;
26 $record = new FS::cust_pay_pending { 'column' => 'value' };
28 $error = $record->insert;
30 $error = $new_record->replace($old_record);
32 $error = $record->delete;
34 $error = $record->check;
38 An FS::cust_pay_pending object represents an pending payment. It reflects
39 local state through the multiple stages of processing a real-time transaction
40 with an external gateway. FS::cust_pay_pending inherits from FS::Record. The
41 following fields are currently supported:
51 Customer (see L<FS::cust_main>)
55 Amount of this payment
59 Specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
60 L<Time::Local> and L<Date::Parse> for conversion functions.
64 Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
68 Payment Information (See L<FS::payinfo_Mixin> for data format)
72 Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
80 Unique identifer to prevent duplicate transactions.
84 Desired pkgnum when using experimental package balances.
88 Pending transaction status, one of the following:
94 Aquires basic lock on payunique
98 Transaction is pending with the gateway
102 Customer has been sent to an off-site payment gateway to complete processing
106 Only used for two-stage transactions that require a separate capture step
110 Transaction completed with payment gateway (sucessfully), not yet recorded in
115 Transaction completed with payment gateway (declined), not yet recorded in
120 Transaction recorded in database
126 Additional status information.
130 L<FS::payment_gateway> id.
134 Payment number (L<FS::cust_pay>) of the completed payment.
138 Invoice number (L<FS::cust_bill>) to try to apply this payment to.
142 Flag for whether this is a "manual" payment (i.e. initiated through
143 self-service or the back-office web interface, rather than from an event
144 or a payment batch). "Manual" payments will cause the customer to be
145 sent a payment receipt rather than a statement.
149 Number of months the customer tried to prepay for.
159 Creates a new pending payment. To add the pending payment to the database, see L<"insert">.
161 Note that this stores the hash reference, not a distinct copy of the hash it
162 points to. You can ask the object for a copy with the I<hash> method.
166 # the new method can be inherited from FS::Record, if a table method is defined
168 sub table { 'cust_pay_pending'; }
172 Adds this record to the database. If there is an error, returns the error,
173 otherwise returns false.
177 # the insert method can be inherited from FS::Record
181 Delete this record from the database.
185 # the delete method can be inherited from FS::Record
187 =item replace OLD_RECORD
189 Replaces the OLD_RECORD with this one in the database. If there is an error,
190 returns the error, otherwise returns false.
194 # the replace method can be inherited from FS::Record
198 Checks all fields to make sure this is a valid pending payment. If there is
199 an error, returns the error, otherwise returns false. Called by the insert
204 # the check method should currently be supplied - FS::Record contains some
205 # data checking routines
211 $self->ut_numbern('paypendingnum')
212 || $self->ut_foreign_key('custnum', 'cust_main', 'custnum')
213 || $self->ut_money('paid')
214 || $self->ut_numbern('_date')
215 || $self->ut_textn('payunique')
216 || $self->ut_text('status')
217 #|| $self->ut_textn('statustext')
218 || $self->ut_anything('statustext')
219 #|| $self->ut_money('cust_balance')
220 || $self->ut_hexn('session_id')
221 || $self->ut_foreign_keyn('paynum', 'cust_pay', 'paynum' )
222 || $self->ut_foreign_keyn('pkgnum', 'cust_pkg', 'pkgnum')
223 || $self->ut_foreign_keyn('invnum', 'cust_bill', 'invnum')
224 || $self->ut_flag('manual')
225 || $self->ut_numbern('discount_term')
226 || $self->payinfo_check() #payby/payinfo/paymask/paydate
228 return $error if $error;
230 $self->_date(time) unless $self->_date;
232 # UNIQUE index should catch this too, without race conditions, but this
233 # should give a better error message the other 99.9% of the time...
234 if ( length($self->payunique) ) {
235 my $cust_pay_pending = qsearchs('cust_pay_pending', {
236 'payunique' => $self->payunique,
237 'paypendingnum' => { op=>'!=', value=>$self->paypendingnum },
239 if ( $cust_pay_pending ) {
240 #well, it *could* be a better error message
241 return "duplicate transaction - a payment with unique identifer ".
242 $self->payunique. " already exists";
251 Returns the associated L<FS::cust_main> record if any. Otherwise returns false.
257 qsearchs('cust_main', { custnum => $self->custnum } );
261 #these two are kind-of false laziness w/cust_main::realtime_bop
262 #(currently only used when resolving pending payments manually)
264 =item insert_cust_pay
266 Sets the status of this pending pament to "done" (with statustext
267 "captured (manual)"), and inserts a payment record (see L<FS::cust_pay>).
269 Currently only used when resolving pending payments manually.
273 sub insert_cust_pay {
276 my $cust_pay = new FS::cust_pay ( {
277 'custnum' => $self->custnum,
278 'paid' => $self->paid,
279 '_date' => $self->_date, #better than passing '' for now
280 'payby' => $self->payby,
281 'payinfo' => $self->payinfo,
282 'paybatch' => $self->paybatch,
283 'paydate' => $self->paydate,
286 my $oldAutoCommit = $FS::UID::AutoCommit;
287 local $FS::UID::AutoCommit = 0;
290 #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
292 my $error = $cust_pay->insert;#($options{'manual'} ? ( 'manual' => 1 ) : () );
296 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
300 $self->status('done');
301 $self->statustext('captured (manual)');
302 $self->paynum($cust_pay->paynum);
303 my $cpp_done_err = $self->replace;
305 if ( $cpp_done_err ) {
307 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
308 return $cpp_done_err;
312 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
319 =item approve OPTIONS
321 Sets the status of this pending payment to "done" and creates a completed
322 payment (L<FS::cust_pay>). This should be called when a realtime or
323 third-party payment has been approved.
325 OPTIONS may include any of 'processor', 'payinfo', 'discount_term', 'auth',
326 and 'order_number' to set those fields on the completed payment, as well as
327 'apply' to apply payments for this customer after inserting the new payment.
336 my $oldAutoCommit = $FS::UID::AutoCommit;
337 local $FS::UID::AutoCommit = 0;
339 my $cust_pay = FS::cust_pay->new({
340 'custnum' => $self->custnum,
341 'invnum' => $self->invnum,
342 'pkgnum' => $self->pkgnum,
343 'paid' => $self->paid,
345 'payby' => $self->payby,
346 'payinfo' => $self->payinfo,
347 'gatewaynum' => $self->gatewaynum,
349 foreach my $opt_field (qw(processor payinfo auth order_number))
351 $cust_pay->set($opt_field, $opt{$opt_field}) if exists $opt{$opt_field};
355 'manual' => $self->manual,
356 'discount_term' => $self->discount_term,
358 my $error = $cust_pay->insert( %insert_opt );
360 # try it again without invnum or discount
361 # (both of those can make payments fail to insert, and at this point
362 # the payment is a done deal and MUST be recorded)
364 my $error2 = $cust_pay->insert('manual' => $self->manual);
366 # attempt to void the payment?
367 # no, we'll just stop digging at this point.
368 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
369 my $e = "WARNING: payment captured but not recorded - error inserting ".
370 "payment (". ($opt{processor} || $self->payby) .
371 ": $error2\n(previously tried insert with invnum#".$self->invnum.
372 ": $error)\npending payment saved as paypendingnum#".
373 $self->paypendingnum."\n\n";
378 if ( my $jobnum = $self->jobnum ) {
379 my $placeholder = FS::queue->by_key($jobnum);
382 $error = "not found";
384 $error = $placeholder->delete;
388 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
389 my $e = "WARNING: payment captured but could not delete job $jobnum ".
390 "for paypendingnum #" . $self->paypendingnum . ": $error\n\n";
396 if ( $opt{'paynum_ref'} ) {
397 ${ $opt{'paynum_ref'} } = $cust_pay->paynum;
400 $self->status('done');
401 $self->statustext('captured');
402 $self->paynum($cust_pay->paynum);
403 my $cpp_done_err = $self->replace;
405 if ( $cpp_done_err ) {
407 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
408 my $e = "WARNING: payment captured but could not update pending status ".
409 "for paypendingnum ".$self->paypendingnum.": $cpp_done_err \n\n";
415 # commit at this stage--we don't want to roll back if applying
417 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
419 if ( $opt{'apply'} ) {
420 my $apply_error = $self->apply_payments_and_credits;
421 if ( $apply_error ) {
422 warn "WARNING: error applying payment: $apply_error\n\n";
429 =item decline [ STATUSTEXT ]
431 Sets the status of this pending payment to "done" (with statustext
432 "declined (manual)" unless otherwise specified).
434 Currently only used when resolving pending payments manually.
440 my $statustext = shift || "declined (manual)";
442 #could send decline email too? doesn't seem useful in manual resolution
444 $self->status('done');
445 $self->statustext($statustext);
451 # Used by FS::Upgrade to migrate to a new database.
453 sub _upgrade_data { #class method
454 my ($class, %opts) = @_;
457 "DELETE FROM cust_pay_pending WHERE status = 'new' AND _date < ".(time-600);
459 my $sth = dbh->prepare($sql) or die dbh->errstr;
460 $sth->execute or die $sth->errstr;
470 L<FS::Record>, schema.html from the base documentation.