=head2 submit
-Dispatch to the appropriate hanlder based on the given action
+Dispatch to the appropriate handler based on the given action
=cut
'normal authorization' => 'submit_normal_authorization',
'authorization only' => 'submit_authorization_only',
'post authorization' => 'submit_post_authorization',
- 'reverse authorization' => 'rsubmit_everse_authorization',
- 'void' => 'submit_viod',
+ 'reverse authorization' => 'submit_reverse_authorization',
+ 'void' => 'submit_void',
'credit' => 'submit_credit',
'tokenize' => 'submit_tokenize',
'recurring authorization' => 'submit_recurring_authorization',
=head2 submit_normal_authorization
-Compliete a payment transaction by with an API POST to B</payments>
+Complete a payment transaction by with an API POST to B</payments>
See L<https://dev.na.bambora.com/docs/references/payment_APIs/v1-0-5>
sub submit_normal_authorization {
my $self = shift;
-
- # Series of methods to populate or format field values
- $self->make_invoice_number;
- $self->set_payment_method;
- $self->set_expiration;
-
my $content = $self->{_content};
- # Build a JSON string
- my $post_body = encode_json({
- order_number => $self->truncate( $content->{invoice_number}, 30 ),
- amount => $content->{amount},
- payment_method => $content->{payment_method},
+ # Use epoch time as invoice_number, if none is specified
+ $content->{invoice_number} ||= time();
+
+ # Clarifying Bambora API and Business::OnlinePayment naming conflict
+ #
+ # Bambora API:
+ # - order_number: user supplied identifier for the order, displayed on reports
+ # - transaction_id: bambora supplied identifier for the order.
+ # this number must be referenced for future actions like voids,
+ # auth captures, etc
+ #
+ # Business::OnlinePayment
+ # - invoice_number: contains the bambora order number
+ # - order_number: contains the bambora transaction id
+
+ my %post = (
+ order_number => $self->truncate( $content->{invoice_number}, 30 ),
+ amount => $content->{amount},
+ billing => $self->jhref_billing_address,
+ );
+
+ # Credit Card
+ if ( $content->{card_number} ) {
+ $post{payment_method} = 'card';
- billing => $self->jhref_billing_address,
+ # Parse the expiration date into expiry_month and expiry_year
+ $self->set_expiration;
- card => {
+ $post{card} = {
number => $self->truncate( $content->{card_number}, 20 ),
name => $self->truncate( $content->{owner}, 64 ),
expiry_month => sprintf( '%02d', $content->{expiry_month} ),
expiry_year => sprintf( '%02d', $content->{expiry_year} ),
cvd => $content->{cvv2},
recurring_payment => $content->{recurring_payment} ? 1 : 0,
+ complete => 1,
+ };
+
+ } else {
+ die 'unknown/unsupported payment method!';
+ }
+
+ my $action = lc $content->{action};
+
+ if ( $action eq 'normal authorization' ) {
+ $self->path('/v1/payments');
+ } elsif ( $action eq 'authorization only' ) {
+ $self->path('/v1/payments');
+ if ( ref $post{card} ) {
+ $post{card}->{complete} = 0;
}
- });
+ } elsif ( $action eq 'post authorization' ) {
+
+ croak 'post authorization cannot be completed - '.
+ 'bambora transaction_id must be set as order_number '.
+ 'before using submit()'
+ unless $content->{order_number};
+
+ $self->path(
+ sprintf '/v1/payments/%s/completions',
+ $content->{order_number}
+ );
+
+ if ( ref $post{card} ) {
+ $post{card}->{complete} = 1
+ }
+ } else {
+ die "unsupported action $action";
+ }
+ # Parse %post into a JSON string, to be attached to the request POST body
+ my $post_body = encode_json( \%post );
+
if ( $DEBUG ) {
- warn Dumper({ post_body => $post_body })."\n";
+ warn Dumper({
+ post_body => $post_body,
+ post_href => \%post,
+ });
}
- $self->path('/v1/payments');
+ my $response = $self->submit_api_request( $post_body );
+
+ # Error messages already populated upon failure
+ return unless $self->is_success;
+
+ # Populate transaction result values
+ $self->message_id( $response->{message_id} );
+ $self->authorization( $response->{auth_code} );
+ $self->order_number( $response->{id} );
+ $self->txn_date( $response->{created} );
+ $self->avs_code( $response->{card}{avs_result} );
+ $self->is_success( 1 );
+
+ $response;
+}
+
+=head2 submit_authorization_only
+
+Capture a card authorization, but do not complete transaction
+
+=cut
+
+sub submit_authorization_only {
+ my $self = shift;
+
+ $self->submit_normal_authorization;
+
+ my $response = $self->response_decoded;
+
+ if (
+ $self->is_success
+ && (
+ ref $response
+ && $response->{type} ne 'PA'
+ )
+ ) {
+ # Bambora API uses nearly identical API calls for normal
+ # card transactions and pre-authorization. Sanity check
+ # that response reported a pre-authorization code
+ die "Expected API Respose type=PA, but type=$response->{type}! ".
+ "Pre-Authorization attempt may have charged card!";
+ }
+}
+
+=head2 submit_post_authorization
+
+Complete a card pre-authorization
+
+=cut
+
+sub submit_post_authorization {
+ shift->submit_normal_authorization;
+}
+
+=head2 submit_reverse_authorization
+
+Reverse a pre-authorization
+
+=cut
+
+sub submit_reverse_authorization {
+ shift->submit_void;
+}
+
+=head2 submit_void
+
+Process a return against a transaction for the given amount
+
+=cut
+
+sub submit_void {
+ my $self = shift;
+ my $content = $self->{_content};
+
+ for my $f (qw/ order_number amount/) {
+ unless ( $content->{$f} ) {
+ $self->error_message("Cannot process void - missing required content $f");
+ warn $self->error_message if $DEBUG;
+
+ return $self->is_success(0);
+ }
+ }
+
+ my %post = (
+# order_number => $self->truncate( $content->{invoice_number}, 30 ),
+ amount => $content->{amount},
+ );
+ my $post_body = encode_json( \%post );
+
+ if ( $DEBUG ) {
+ warn Dumper({
+ post => \%post,
+ post_body => $post_body,
+ });
+ }
+ $self->path( sprintf '/v1/payments/%s/returns', $content->{order_number} );
+
+ my $response = $self->submit_api_request( $post_body );
+
+}
+
+=head2 submit_api_request json_string
+
+Make the appropriate API request with the given JSON string
+
+=cut
+
+sub submit_api_request {
+ my $self = shift;
+ my $post_body = shift
+ or die 'submit_api_request() requires a json_string parameter';
my ( $response_body, $response_code, %response_headers ) = $self->https_post(
{
});
}
- # API should always return a JSON response,
- die $response_body || 'connection error'
- if $@ || !$response;
+ # API should always return a JSON response, likely network problem
+ if ( $@ || !$response ) {
+ $self->error_message( $response_body || 'connection error' );
+ $self->is_success( 0 );
+ return;
+ }
}
$self->response_decoded( $response );
+ # Response returned an error
if ( $response->{code} && $response->{code} != 1 ) {
-
$self->is_success( 0 );
$self->result_code( $response->{code} );
+
return $self->error_message(
sprintf '%s %s',
$response->{code},
);
}
- # success
- # Populate transaction result values
- $self->message_id( $response->{message_id} );
- $self->authorization( $response->{auth_code} );
- $self->order_number( $response->{id} );
- $self->txn_date( $response->{created} );
- $self->avs_code( $response->{card}{avs_result} );
+ # Success
+ # Return the decoded json of the response back to handler
$self->is_success( 1 );
-}
-
-=head2 submit_api_request json_string
-
-Make the appropriate API request with the given JSON string
+ return $response;
-=cut
-
-sub submit_api_request {
- my $self = shift;
- my $json_string = shift
- or die 'submit_api_request() requires a json_string parameter';
-
-
}
=head2 submit_action_unsupported
=cut
sub submit_action_unsupported {
- croak sprintf 'Action %s unsupported', shift->action
+ croak sprintf 'Action %s unsupported', shift->{_content}{action}
}
=head2 authorization_header
-Bambora POST requests authenticate via a HTTP header of the format:
+Bambora REST requests authenticate via a HTTP header of the format:
Authorization: Passcode Base64Encoded(merchant_id:passcode)
Returns a hash representing the authorization header derived from
};
}
-=head2 make_invoice_number
-
-If an invoice number has not been specified, generate one using
-the current epoch timestamp
-
-=cut
-
-sub make_invoice_number {
- shift->{_content}{invoice_number} ||= time();
-}
-
=head2 set_country
Country is expected to be set as an ISO-3166-1 2-letter country code
Dies unless country is a two-letter string.
-In the future, could be extended to convert country names to their respective
+Could be extended to convert country names to their respective
country codes
See: L<https://en.wikipedia.org/wiki/ISO_3166-1>
=head2 set_expiration_month_year
-Split standard expiration field, which may be in the format
+Split B::OP expiration field, which may be in the format
MM/YY or MMYY, into separate expiry_month and expiry_year fields
Will die if values are not numeric
my $content = $self->{_content};
my $expiration = $content->{expiration};
+ unless ( $expiration ) {
+ $content->{expiry_month} = undef;
+ $content->{expiry_year} = undef;
+ return;
+ }
+
my ( $mm, $yy ) = (
$expiration =~ /\//
? split( /\//, $expiration )
=head2 set_phone_number
+Set value for field phone_number, from value in field phone
+
+Bambora API expects only digits in a phone number. Strips all non-digit
+characters
+
=cut
sub set_phone_number {
=head2 set_province
+Set value for field province, from value in field state
+
Outside the US/Canada, API expect province set to the string "--",
-otherwise to be a 2 character string
+otherwise expects a 2 character string. Value for province is
+formatted to upper case, and truncated to 2 characters.
=cut
projects / Business-OnlinePayment-Bambora.git / blobdiff