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 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553
|
package Business::PayPal::API::ExpressCheckout;
use 5.008001;
use strict;
use warnings;
use SOAP::Lite 0.67;
use Business::PayPal::API ();
our @ISA = qw(Business::PayPal::API);
our $VERSION = '0.14';
our $CVS_VERSION = '$Id: ExpressCheckout.pm,v 1.13 2009/07/28 18:00:59 scott Exp $';
our @EXPORT_OK = qw( SetExpressCheckout GetExpressCheckoutDetails DoExpressCheckoutPayment );
## if you specify an InvoiceID, PayPal seems to remember it and not
## allow you to bill twice with it.
sub SetExpressCheckout {
my $self = shift;
my %args = @_;
my %types = ( Token => 'ebl:ExpressCheckoutTokenType',
OrderTotal => 'cc:BasicAmountType',
currencyID => '',
MaxAmount => 'cc:BasicAmountType',
OrderDescription => 'xs:string',
Custom => 'xs:string',
InvoiceID => 'xs:string',
ReturnURL => 'xs:string',
CancelURL => 'xs:string',
Address => 'ebl:AddressType',
ReqConfirmShipping => 'xs:string',
NoShipping => 'xs:string',
AddressOverride => 'xs:string',
LocaleCode => 'xs:string',
PageStyle => 'xs:string',
'cpp-header-image' => 'xs:string',
'cpp-header-border-color' => 'xs:string',
'cpp-header-back-color' => 'xs:string',
'cpp-payflow-color' => 'xs:string',
PaymentAction => '',
BuyerEmail => 'ebl:EmailAddressType' );
## billing agreement details type
my %badtypes = ( BillingType => '', #'ns:BillingCodeType',
BillingAgreementDescription => 'xs:string',
PaymentType => '', #'ns:MerchantPullPaymentCodeType',
BillingAgreementCustom => 'xs:string', );
## set some defaults
$args{PaymentAction} ||= 'Sale';
$args{currencyID} ||= 'USD';
my $currencyID = delete $args{currencyID};
## SetExpressCheckoutRequestDetails
my @secrd =
( SOAP::Data->name( OrderTotal => delete $args{OrderTotal} )->type( $types{OrderTotal} )
->attr( {currencyID => $currencyID, xmlns => $self->C_xmlns_ebay}),
SOAP::Data->name( ReturnURL => delete $args{ReturnURL} )->type( $types{ReturnURL} ),
SOAP::Data->name( CancelURL => delete $args{CancelURL} )->type( $types{CancelURL} ),
);
## add all the other fields
for my $field ( keys %types ) {
next unless defined $args{$field};
if( $field eq 'MaxAmount' ) {
push @secrd, SOAP::Data->name( $field => $args{$field} )->type( $types{$field} )
->attr( {currencyID => $currencyID, xmlns => $self->C_xmlns_ebay} );
}
else {
push @secrd, SOAP::Data->name( $field => $args{$field} )->type( $types{$field} );
}
}
my @btypes = ();
for my $field ( keys %badtypes ) {
next unless $args{$field};
push @btypes, SOAP::Data->name( $field => $args{$field} )->type( $badtypes{$field} );
}
push @secrd, SOAP::Data->name( BillingAgreementDetails => \SOAP::Data->value(@btypes) )
if $args{'BillingType'};
my $request = SOAP::Data
->name( SetExpressCheckoutRequest => \SOAP::Data->value
( $self->version_req,
SOAP::Data->name( SetExpressCheckoutRequestDetails => \SOAP::Data->value(@secrd) )
->attr( {xmlns => $self->C_xmlns_ebay} ),
)
)->type( 'ns:SetExpressCheckoutRequestType' );
my $som = $self->doCall( SetExpressCheckoutReq => $request )
or return;
my $path = '/Envelope/Body/SetExpressCheckoutResponse';
my %response = ();
unless( $self->getBasic($som, $path, \%response) ) {
$self->getErrors($som, $path, \%response);
return %response;
}
$self->getFields($som, $path, \%response, { Token => 'Token' });
return %response;
}
sub GetExpressCheckoutDetails {
my $self = shift;
my $token = shift;
my $request = SOAP::Data
->name( GetExpressCheckoutDetailsRequest => \SOAP::Data->value
( $self->version_req,
SOAP::Data->name( Token => $token )
->type('xs:string')->attr( {xmlns => $self->C_xmlns_ebay} ),
)
)->type( 'ns:GetExpressCheckoutRequestType' );
my $som = $self->doCall( GetExpressCheckoutDetailsReq => $request )
or return;
my $path = '/Envelope/Body/GetExpressCheckoutDetailsResponse';
my %details = ();
unless( $self->getBasic($som, $path, \%details) ) {
$self->getErrors($som, $path, \%details);
return %details;
}
$self->getFields($som,
"$path/GetExpressCheckoutDetailsResponseDetails",
\%details,
{ Token => 'Token',
Custom => 'Custom',
InvoiceID => 'InvoiceID',
ContactPhone => 'ContactPhone',
Payer => 'PayerInfo/Payer',
PayerID => 'PayerInfo/PayerID',
PayerStatus => 'PayerInfo/PayerStatus',
FirstName => 'PayerInfo/PayerName/FirstName',
LastName => 'PayerInfo/PayerName/LastName',
PayerBusiness => 'PayerInfo/PayerBusiness',
AddressStatus => 'PayerInfo/Address/AddressStatus',
Name => 'PayerInfo/Address/Name',
Street1 => 'PayerInfo/Address/Street1',
Street2 => 'PayerInfo/Address/Street2',
CityName => 'PayerInfo/Address/CityName',
StateOrProvince => 'PayerInfo/Address/StateOrProvince',
PostalCode => 'PayerInfo/Address/PostalCode',
Country => 'PayerInfo/Address/Country',
} );
return %details;
}
sub DoExpressCheckoutPayment {
my $self = shift;
my %args = @_;
my %types = ( Token => 'xs:string',
PaymentAction => '', ## NOTA BENE!
PayerID => 'ebl:UserIDType',
currencyID => '',
);
## PaymentDetails
my %pd_types = ( OrderTotal => 'ebl:BasicAmountType',
OrderDescription => 'xs:string',
ItemTotal => 'ebl:BasicAmountType',
ShippingTotal => 'ebl:BasicAmountType',
HandlingTotal => 'ebl:BasicAmountType',
TaxTotal => 'ebl:BasicAmountType',
Custom => 'xs:string',
InvoiceID => 'xs:string',
ButtonSource => 'xs:string',
NotifyURL => 'xs:string',
);
## ShipToAddress
my %st_types = ( ST_Name => 'xs:string',
ST_Street1 => 'xs:string',
ST_Street2 => 'xs:string',
ST_CityName => 'xs:string',
ST_StateOrProvince => 'xs:string',
ST_Country => 'xs:string',
ST_PostalCode => 'xs:string',
);
##PaymentDetailsItem
my %pdi_types = ( PDI_Name => 'xs:string',
PDI_Amount => 'ebl:BasicAmountType',
PDI_Number => 'xs:string',
PDI_Quantity => 'xs:string',
PDI_Tax => 'ebl:BasicAmountType',
);
$args{PaymentAction} ||= 'Sale';
$args{currencyID} ||= 'USD';
my @payment_details = ( );
## push OrderTotal here and delete it (i.e., and all others that have special attrs)
push @payment_details, SOAP::Data->name( OrderTotal => $args{OrderTotal} )
->type( $pd_types{OrderTotal} )
->attr( { currencyID => $args{currencyID},
xmlns => $self->C_xmlns_ebay } );
## don't process it again
delete $pd_types{OrderTotal};
for my $field ( keys %pd_types ) {
if( $args{$field} ) {
push @payment_details,
SOAP::Data->name( $field => $args{$field} )
->type( $pd_types{$field} );
}
}
##
## ShipToAddress
##
my @ship_types = ();
for my $field ( keys %st_types ) {
if( $args{$field} ) {
(my $name = $field) =~ s/^ST_//;
push @ship_types,
SOAP::Data->name( $name => $args{$field} )
->type( $st_types{$field} );
}
}
if( scalar @ship_types ) {
push @payment_details,
SOAP::Data->name( ShipToAddress => \SOAP::Data->value
( @ship_types )->type('ebl:AddressType')
->attr( {xmlns => $self->C_xmlns_ebay} ),
);
}
##
## PaymentDetailsItem
##
my @payment_details_item = ();
for my $field ( keys %pdi_types ) {
if( $args{$field} ) {
(my $name = $field) =~ s/^PDI_//;
push @payment_details_item,
SOAP::Data->name( $name => $args{$field} )
->type( $pdi_types{$field} );
}
}
if( scalar @payment_details_item ) {
push @payment_details,
SOAP::Data->name( PaymentDetailsItem => \SOAP::Data->value
( @payment_details_item )->type('ebl:PaymentDetailsItemType')
->attr( {xmlns => $self->C_xmlns_ebay} ),
);
}
##
## ExpressCheckoutPaymentDetails
##
my @express_details = (
SOAP::Data->name( Token => $args{Token} )
->type($types{Token})->attr( {xmlns => $self->C_xmlns_ebay} ),
SOAP::Data->name( PaymentAction => $args{PaymentAction} )
->type($types{PaymentAction})->attr( {xmlns => $self->C_xmlns_ebay} ),
SOAP::Data->name( PayerID => $args{PayerID} )
->type($types{PayerID})->attr( {xmlns => $self->C_xmlns_ebay} ),
SOAP::Data->name( PaymentDetails => \SOAP::Data->value
( @payment_details )->type('ebl:PaymentDetailsType')
->attr( {xmlns => $self->C_xmlns_ebay} ),
), );
##
## the main request object
##
my $request = SOAP::Data
->name( DoExpressCheckoutPaymentRequest => \SOAP::Data->value
( $self->version_req,
SOAP::Data->name( DoExpressCheckoutPaymentRequestDetails => \SOAP::Data->value
( @express_details )->type( 'ns:DoExpressCheckoutPaymentRequestDetailsType' )
)->attr( {xmlns => $self->C_xmlns_ebay} ),
)
);
my $som = $self->doCall( DoExpressCheckoutPaymentReq => $request )
or return;
my $path = '/Envelope/Body/DoExpressCheckoutPaymentResponse';
my %response = ();
unless( $self->getBasic($som, $path, \%response) ) {
$self->getErrors($som, $path, \%response);
return %response;
}
$self->getFields( $som,
"$path/DoExpressCheckoutPaymentResponseDetails",
\%response,
{ Token => 'Token',
BillingAgreementID => 'BillingAgreementID',
TransactionID => 'PaymentInfo/TransactionID',
TransactionType => 'PaymentInfo/TransactionType',
PaymentType => 'PaymentInfo/PaymentType',
PaymentDate => 'PaymentInfo/PaymentDate',
GrossAmount => 'PaymentInfo/GrossAmount',
FeeAmount => 'PaymentInfo/FeeAmount',
SettleAmount => 'PaymentInfo/SettleAmount',
TaxAmount => 'PaymentInfo/TaxAmount',
ExchangeRate => 'PaymentInfo/ExchangeRate',
PaymentStatus => 'PaymentInfo/PaymentStatus',
PendingReason => 'PaymentInfo/PendingReason',
} );
return %response;
}
1;
__END__
=head1 NAME
Business::PayPal::API::ExpressCheckout - PayPal Express Checkout API
=head1 SYNOPSIS
use Business::PayPal::API::ExpressCheckout;
## see Business::PayPal::API documentation for parameters
my $pp = new Business::PayPal::API::ExpressCheckout ( ... );
my %resp = $pp->SetExpressCheckout
( OrderTotal => '55.43', ## defaults to USD
ReturnURL => 'http://site.tld/return.html',
CancelURL => 'http://site.tld/canceltation.html', );
... time passes, buyer validates the token with PayPal ...
my %details = $pp->GetExpressCheckoutDetails($resp{Token});
## now ask PayPal to xfer the money
my %payinfo = $pp->DoExpressCheckoutPayment( Token => $details{Token},
PaymentAction => 'Sale',
PayerID => $details{PayerID},
OrderTotal => '55.43' );
=head1 DESCRIPTION
B<Business::PayPal::API::ExpressCheckout> implements PayPal's
B<Express Checkout API> using SOAP::Lite to make direct API calls to
PayPal's SOAP API server. It also implements support for testing via
PayPal's I<sandbox>. Please see L<Business::PayPal::API> for details
on using the PayPal sandbox.
=head2 SetExpressCheckout
Implements PayPal's "Website Payment Pro" B<SetExpressCheckout> API call. Supported
parameters include:
Token
OrderTotal
currencyID
MaxAmount
OrderDescription
Custom
InvoiceID
ReturnURL
CancelURL
Address
ReqConfirmShipping
NoShipping
AddressOverride
LocaleCode
PageStyle
'cpp-header-image'
'cpp-header-border-color'
'cpp-header-back-color'
'cpp-payflow-color'
PaymentAction
BuyerEmail
BillingType
BillingAgreementDescription
PaymentType
BillingAgreementCustom
as described in the PayPal "Web Services API Reference" document. The
default currency setting is 'USD' if not otherwise specified.
Returns a hash containing a 'Token' key, whose value represents the
PayPal transaction token.
Required fields:
OrderTotal, ReturnURL, CancelURL.
my %resp = $pp->SetExpressCheckout();
my $token = $resp{Token};
Example (courtesy Ollie Ready):
my $address = {
Name => 'Some Customer',
Street1 => '888 Test St.',
Street2 => 'Suite 9',
CityName => 'San Diego',
StateOrProvince => 'CA',
PostalCode => '92111',
Country => 'US',
Phone => '123-123-1234',
};
my %response = $pp->SetExpressCheckout(
OrderTotal => '11.01',
ReturnURL => '<![CDATA[http://example.com/p?cmd=checkout]]>',
CancelURL => 'http://example.com',
PaymentAction => 'Authorization',
AddressOverride => 1,
Address => $address,
);
=head2 GetExpressCheckoutDetails
Implements PayPal's WPP B<SetExpressCheckout> API call. Supported
parameters include:
Token
as described in the PayPal "Web Services API Reference" document. This
is the same token you received from B<SetExpressCheckout>.
Returns a hash with the following keys:
Token
Custom
InvoiceID
ContactPhone
Payer
PayerID
PayerStatus
FirstName
LastName
PayerBusiness
AddressStatus
Name
Street1
Street2
CityName
StateOrProvince
PostalCode
Country
Required fields:
Token
=head2 DoExpressCheckoutPayment
Implements PayPal's WPP B<SetExpressCheckout> API call. Supported
parameters include:
Token
PaymentAction (defaults to 'Sale' if not supplied)
PayerID
currencyID (defaults to 'USD' if not supplied)
OrderTotal
OrderDescription
ItemTotal
ShippingTotal
HandlingTotal
TaxTotal
Custom
InvoiceID
ButtonSource
NotifyURL
ST_Name
ST_Street1
ST_Street2
ST_CityName
ST_StateOrProvince
ST_Country
ST_PostalCode
PDI_Name
PDI_Amount
PDI_Number
PDI_Quantity
PDI_Tax
as described in the PayPal "Web Services API Reference" document.
Returns a hash with the following keys:
Token
TransactionID
TransactionType
PaymentType
PaymentDate
GrossAmount
FeeAmount
SettleAmount
TaxAmount
ExchangeRate
PaymentStatus
PendingReason
BillingAgreementID (if BillingType 'MerchantInitiatedBilling'
was specified during SetExpressCheckout)
Required fields:
Token, PayerID, OrderTotal
=head2 ERROR HANDLING
See the B<ERROR HANDLING> section of B<Business::PayPal::API> for
information on handling errors.
=head1 EXAMPLES
Andy Spiegl <paypalcheckout.Spiegl@kascada.com> has kindly donated
some example code (in German) which may be found in the F<eg>
directory of this archive. Additional code examples may be found in
the F<t> test directory.
=head2 EXPORT
None by default.
=head1 SEE ALSO
L<SOAP::Lite>, L<Business::PayPal::API>,
L<https://www.paypal.com/IntegrationCenter/ic_expresscheckout.html>,
L<https://developer.paypal.com/en_US/pdf/PP_APIReference.pdf>
=head1 AUTHOR
Scott Wiersdorf, E<lt>scott@perlcode.orgE<gt>
=head1 COPYRIGHT AND LICENSE
Copyright (C) 2006 by Scott Wiersdorf
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.8.6 or,
at your option, any later version of Perl 5 you may have available.
=cut
|