Business::CPI::Gateway::Base - Father of all gateways
version 0.908
ID, login or e-mail of the business owner. The way the gateway uniquely identifies the account owner.
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.
receiver_email
Currency code, such as BRL, EUR, USD, etc.
Provide a logger to the gateway. It's the user's responsibility to configure the logger. By default, nothing is logged.
The url for the gateway to postback, notifying payment changes.
The url for the customer to return to, after they finished the payment.
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.
The url the application will post the form to. Defined by the gateway.
Defaults to post.
Defaults to submit.
Defaults to ''.
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).
Defaults to UTF-8.
Simply makes the receiver_id alias work.
Creates a new Business::CPI::Cart connected to this gateway.
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.
create_account
Get the form to checkout. Use the method in Business::CPI::Cart, don't use this method directly.
Generates a payment token for a given cart. Do not call this method directly. Instead, see "get_checkout_code" in Business::CPI::Cart.
Get the payment notification (such as PayPal's IPN), and return a hashref with the details.
Search past transactions.
Get more details about a given transaction.
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.
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.
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.
André Walker <andre@andrewalker.net>
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.
To install Business::CPI, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Business::CPI
CPAN shell
perl -MCPAN -e shell install Business::CPI
For more information on module installation, please visit the detailed CPAN module installation guide.