File: //usr/local/ssl/local/share/man/man3/Business::OnlinePayment::HTTPS.3
.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. | will give a
.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. nr % 0
. rr F
.\}
.\"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "OnlinePayment::HTTPS 3"
.TH OnlinePayment::HTTPS 3 "2008-07-10" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
Business::OnlinePayment::HTTPS \- Base class for HTTPS payment APIs
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\& package Business::OnlinePayment::MyProcessor;
\& use base qw(Business::OnlinePayment::HTTPS);
.Ve
.PP
.Vb 2
\& sub submit {
\& my $self = shift;
.Ve
.PP
.Vb 1
\& #...
.Ve
.PP
.Vb 3
\& # pass a list (order is preserved, if your gateway needs that)
\& ( $page, $response, %reply_headers )
\& = $self->https_get( field => 'value', ... );
.Ve
.PP
.Vb 4
\& # or a hashref
\& my %hash = ( field => 'value', ... );
\& ( $page, $response_code, %reply_headers )
\& = $self->https_get( \e%hash );
.Ve
.PP
.Vb 2
\& #...
\& }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This is a base class for \s-1HTTPS\s0 based gateways, providing useful code
for implementors of \s-1HTTPS\s0 payment APIs.
.PP
It depends on Net::SSLeay _or_ ( Crypt::SSLeay and LWP::UserAgent ).
.SH "METHODS"
.IX Header "METHODS"
.IP "https_get [ \e%options ] \s-1HASHREF\s0 | \s-1FIELD\s0 => \s-1VALUE\s0, ..." 4
.IX Item "https_get [ %options ] HASHREF | FIELD => VALUE, ..."
Accepts parameters as either a hashref or a list of fields and values.
In the latter case, ordering is preserved (see Tie::IxHash to do so
when passing a hashref).
.Sp
Returns a list consisting of the page content as a string, the \s-1HTTP\s0
response code and message (i.e. \*(L"200 \s-1OK\s0\*(R" or \*(L"404 Not Found\*(R"), and a list of
key/value pairs representing the \s-1HTTP\s0 response headers.
.Sp
The options hashref supports setting headers and Content\-Type:
.Sp
.Vb 4
\& {
\& headers => { 'X-Header1' => 'value', ... },
\& Content-Type => 'text/namevalue',
\& }
.Ve
.IP "https_post [ \e%options ] \s-1SCALAR\s0 | \s-1HASHREF\s0 | \s-1FIELD\s0 => \s-1VALUE\s0, ..." 4
.IX Item "https_post [ %options ] SCALAR | HASHREF | FIELD => VALUE, ..."
Accepts form fields and values as either a hashref or a list. In the
latter case, ordering is preserved (see Tie::IxHash to do so when
passing a hashref).
.Sp
Also accepts instead a simple scalar containing the raw content.
.Sp
Returns a list consisting of the page content as a string, the \s-1HTTP\s0
response code and message (i.e. \*(L"200 \s-1OK\s0\*(R" or \*(L"404 Not Found\*(R"), and a list of
key/value pairs representing the \s-1HTTP\s0 response headers.
.Sp
The options hashref supports setting headers and Content\-Type:
.Sp
.Vb 4
\& {
\& headers => { 'X-Header1' => 'value', ... },
\& Content-Type => 'text/namevalue',
\& }
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Business::OnlinePayment