.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.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.  \*(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-
.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" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "OnlinePayment::HTTPS 3"
.TH OnlinePayment::HTTPS 3 "2012-05-05" "perl v5.16.3" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.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);
\&  
\&  sub submit {
\&      my $self = shift;
\&  
\&      #...
\&  
\&      # pass a list (order is preserved, if your gateway needs that)
\&      ( $page, $response, %reply_headers )
\&          = $self\->https_get( field => \*(Aqvalue\*(Aq, ... );
\&  
\&      # or a hashref
\&      my %hash = ( field => \*(Aqvalue\*(Aq, ... );
\&      ( $page, $response_code, %reply_headers )
\&            = $self\->https_get( \e%hash );
\&  
\&      #...
\&  }
.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::HTTPS::Any, which in turn 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\*(R"\s0 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:
.Sp
.Vb 3
\&  {
\&      headers => { \*(AqX\-Header1\*(Aq => \*(Aqvalue\*(Aq, ... },
\&  }
.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\*(R"\s0 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 => { \*(AqX\-Header1\*(Aq => \*(Aqvalue\*(Aq, ... },
\&      Content\-Type => \*(Aqtext/namevalue\*(Aq,
\&  }
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Business::OnlinePayment, Net::HTTPS::Any