.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" 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 >0, 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
.\"
.\" 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 "LWP::Authen::OAuth2::ServiceProvider::Dwolla 3pm"
.TH LWP::Authen::OAuth2::ServiceProvider::Dwolla 3pm "2023-02-04" "perl v5.36.0" "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"
LWP::Authen::OAuth2::ServiceProvider::Dwolla \- Access Dwolla API v2
.SH "VERSION"
.IX Header "VERSION"
version 0.20
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 12
\&  my $oauth_dwolla = LWP::Authen::OAuth2\->new(
\&    # client_id/client_secret come from your Dwolla account, under API Keys in
\&    # Registered Applications
\&    client_id        => DWOLLA_APP_KEY,
\&    client_secret    => DWOLLA_APP_SECRET,
\&    service_provider => \*(AqDwolla\*(Aq,
\&    # $use_test = 1 to use uat.dwolla.com in your dev sandbox, for test transactions
\&    use_test_urls    => $use_test ? 1 : 0,
\&    redirect_uri     => \*(Aqhttp://my.host/dwolla_redirect_handler\*(Aq,
\&    # scope for reading funding sources and sending money; see Dwolla docs for other scopes
\&    scope            => \*(AqSend|Funding\*(Aq,
\&  );
\&
\&  # read user\*(Aqs list of funding sources
\&  my $account = $oauth_dwolla\->access_token()\->{\*(Aq_links\*(Aq}\->{\*(Aqaccount\*(Aq}\->{\*(Aqhref\*(Aq};
\&  my $funding_sources = eval { $oauth_dwolla\->make_api_call($account.\*(Aq/funding\-sources\*(Aq) };
\&
\&  # get all verified bank accounts
\&  my @verified_sources = grep {
\&    $_\->{\*(Aqstatus\*(Aq} eq \*(Aqverified\*(Aq && $_\->{\*(Aqtype\*(Aq} ne \*(Aqbalance\*(Aq
\&  } @{ $funding_sources\->{\*(Aq_embedded\*(Aq}\->{\*(Aqfunding\-sources\*(Aq} };
\&
\&  # get user\*(Aqs Dwolla balance, if it has a positive balance
\&  my ($balance_source) = grep {
\&    $_\->{\*(Aqtype\*(Aq} eq \*(Aqbalance\*(Aq
\&  } @{ $funding_sources\->{\*(Aq_embedded\*(Aq}\->{\*(Aqfunding\-sources\*(Aq} };
\&
\&  my $dwolla_balance = eval {
\&    $oauth_dwolla\->make_api_call($balance_source\->{\*(Aq_links\*(Aq}\->{\*(Aqwith\-available\-balance\*(Aq}\->{\*(Aqhref\*(Aq})
\&  };
\&  print \*(AqDwolla balance = \*(Aq.$dwolla_balance\->{\*(Aqbalance\*(Aq}\->{\*(Aqvalue\*(Aq}."\en";
\&
\&  # send 100USD from first verified bank account to $recipient_account_id
\&  my $success = eval { $oauth2\->make_api_call(\*(Aq/transfers\*(Aq, {
\&    _links => {
\&      destination => { href => $oauth2\->api_url_base().\*(Aq/accounts/\*(Aq.$recipient_account_id },
\&      source      => { href => $verified_sources[0]\->{\*(Aq_links\*(Aq}\->{\*(Aqaccount\*(Aq}\->{\*(Aqhref\*(Aq} },
\&    },
\&    amount => { currency => \*(AqUSD\*(Aq, value => \*(Aq100.00\*(Aq },
\&  }) };
\&
\&  # (to send via Dwolla balance, use $balance_source\->{\*(Aq_links\*(Aq}\->{\*(Aqaccount\*(Aq}\->{\*(Aqhref\*(Aq}
\&  # as source href instead)
.Ve
.SH "REGISTERING"
.IX Header "REGISTERING"
First get a Dwolla account, by signing up at dwolla.com.  Then create a new application
via \s-1API\s0 Keys \-> Create an application.  Set up the OAuth Redirect to match the \f(CW\*(C`redirect_uri\*(C'\fR
in your LWP::Authen::OAuth2 object, and use the application's Key and Secret values
in client_id and client_secret.
.PP
Full Dwolla \s-1API\s0 v2 docs can be found here:
.PP
<https://docsv2.dwolla.com/>,
<https://developers.dwolla.com/>
.SH "AUTHOR"
.IX Header "AUTHOR"
Adi Fairbank, \f(CW\*(C`<https://github.com/adifairbank>\*(C'\fR
.SH "AUTHORS"
.IX Header "AUTHORS"
.IP "\(bu" 4
Ben Tilly, <btilly at gmail.com>
.IP "\(bu" 4
Thomas Klausner <domm@plix.at>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2013 \- 2022 by Ben Tilly, Rent.com, Thomas Klausner.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.