André Walker > Business-CPI-0.908 > Business::CPI::Gateway::Base

Download:
Business-CPI-0.908.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.908   Source   Latest Release: Business-CPI-0.924

NAME ^

Business::CPI::Gateway::Base - Father of all gateways

VERSION ^

version 0.908

ATTRIBUTES ^

receiver_id

ID, login or e-mail of the business owner. The way the gateway uniquely identifies the account owner.

receiver_email

E-mail of the business owner. Currently, this an alias for receiver_id, for backcompatibility. The attribute is called receiver_email only because some gateways set the account identification as the user's e-mail, but that's not always the case.

currency

Currency code, such as BRL, EUR, USD, etc.

log

Provide a logger to the gateway. It's the user's responsibility to configure the logger. By default, nothing is logged.

notification_url

The url for the gateway to postback, notifying payment changes.

return_url

The url for the customer to return to, after they finished the payment.

checkout_with_token

Boolean attribute to determine whether the form will hold the entire cart, or it will use the payment token generated for it. Defaults to false.

checkout_url

The url the application will post the form to. Defined by the gateway.

checkout_form_http_method

Defaults to post.

checkout_form_submit_name

Defaults to submit.

checkout_form_submit_value

Defaults to ''.

checkout_form_submit_image

If set, makes the submit button become an image. Set this to the URL of the image you want to display in the checkout button. Defaults to '' (i.e., no image, default brower submit button).

form_encoding

Defaults to UTF-8.

METHODS ^

BUILDARGS

Simply makes the receiver_id alias work.

new_cart

Creates a new Business::CPI::Cart connected to this gateway.

new_account

Creates a new instance of an account. In general, you shouldn't need to use this, except for testing. Use create_account, instead, if your driver provides it.

get_form

Get the form to checkout. Use the method in Business::CPI::Cart, don't use this method directly.

get_checkout_code

Generates a payment token for a given cart. Do not call this method directly. Instead, see "get_checkout_code" in Business::CPI::Cart.

get_notification_details

Get the payment notification (such as PayPal's IPN), and return a hashref with the details.

query_transactions

Search past transactions.

get_transaction_details

Get more details about a given transaction.

get_hidden_inputs

This method is called when building the checkout form. It will return a hashref with the field names and field values for the form. This way the gateway will implement only this method, while the rest of the form will be built by this class.

notify

This is supposed to be called when the gateway sends a notification about a payment status change to the application. Receives the request as a parameter (in a CGI-compatible format), and returns data about the payment. The format is still under discussion, and is soon to be documented.

map_object

Helper method for get_hidden_inputs to translate between Business::CPI and the gateway, using methods like checkout_form_items_map, checkout_form_buyer_map, etc.

AUTHOR ^

André Walker <andre@andrewalker.net>

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2013 by André Walker.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

syntax highlighting: