use v6;
use Finance::GDAX::API::TypeConstraints;
use Finance::GDAX::API;

class Finance::GDAX::API::Funding does Finance::GDAX::API
{
    # List funding
    has FundingStatus $.status is rw;

    # Repay funding
    has PositiveNum $.amount   is rw;
    has             $.currency is rw;

    method get(:$!status = $.status) {
	$.path = 'funding';
	self.add-to-url('?status=' ~ $.status) if $.status;
	$.method = 'GET';
	return self.send;
    }

    method repay(:$!amount, :$!currency) {
	
	unless $.amount and $.currency {
	    fail 'repay must specify an amount and currency';
	}
	
	$.method('POST');
	$.body({ amount   => $.amount,
		 currency => $.currency });
	
	$.path('funding/repay');
	return self.send;
    }
}



head

Finance::GDAX::API::Funding - List GDAX margin funding records


code

  =begin code :skip-test
  use Finance::GDAX::API::Funding;

  $funding = Finance::GDAX::API::Funding.new;
  @records = $funding.get;

  # To limit records based on current status
  $funding.status = 'settled';
  @records = $funding.get;

  # To repay some margin funding
  $funding->repay(amount   => 255.45,
		  currency => 'USD' );
  =end code


Returns an array of funding records from GDAX for orders placed with a
margin profile. Also repays margin funding.


Every order placed with a margin profile that draws funding will
create a funding record.


Limit the records returned to those records of given status.


Currently the GDAX API states these status must be "outstanding",
"settled" or "rejected".


The currency of the amount -- for example "USD".


You must specify currency and amount when calling the repay method.


Returns an array of funding records from GDAX.


Repays the margin, from the oldest funding records first.


Specifying the optional ordered parameters $amount and $currency on
the method call will override any attribute values set for amount and
currency.


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


root

MarginTransfer

Fill

React

=begin React :component<HeaderCol> :id<menu> 
=para L<Documentation|/doc/introduction>
=para L<Modules| /mods>
=para L<Examples| file:../examples/index.podlite>
=para L<Download |file:../download/index.podlite>
=para L<About|file:../about/index.podlite>
=para 🔍 K<⌘K>/K<ctrl-K>
=end React


=begin React :component<HeaderCol> :id<footer>  
=begin nested :!nested
=item1 B<Language>
    =item2 L<Get started|file:../getting-started/getting-started.podlite>
    =item2 L<Why Raku?|/doc/language/faq#Why-should-I-learn-Raku-What's-so-great-about-it>
    =item2 L<Try Raku|https://glot.io/new/raku>
    =item2 L<Raku cheat sheet|https://github.com/Raku/mu/blob/master/docs/Perl6/Cheatsheet/cheatsheet.txt>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<Raku on Exercism|https://exercism.org/tracks/raku>
    =item2 L<Wikipedia|https://en.wikipedia.org/wiki/Raku_(programming_language)>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=end nested
=begin nested :!nested

=item1 B<L<Documentation|/doc>>
    =item2 L<Getting started, Migration guides from other languages, & Tutorials | file:../doc/introduction.podlite>
    =item2 L<Language References|file:../doc/reference.podlite>
    =item2 L<Type Reference| file:../doc/types.podlite>
    =item2 L<Miscellaneous| file:../doc/miscellaneous.podlite>
    =item2 L<FAQs (Frequently Asked Questions)|/doc/language/faq>
    =item2 L<Community|/doc/language/community>
    =item2 L<The list of all documents|file:../doc/index.podlite>

=item1 B<Resources>
    =item2 L<The Raku Guide|https://raku.guide/>
    =item2 L<Books |https://perl6book.com/>
    =item2 L<Rosetta Code | https://www.raku.org/community/rosettacode>

=end nested
=begin nested :!nested

=item1 B<Resoures>
    =item2 L<Download | file:../download/index.podlite>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=item1 B<Learning>
    =item2 L<The Raku Guide|https://raku.guide/>
    =item2 L<Wikibook |https://en.wikibooks.org/wiki/Raku_Programming>
    =item2 L<Books |https://perl6book.com/>
    =item2 L<Rosetta Code | https://www.raku.org/community/rosettacode>
    =item2 L<Learn Raku in Y minutes|https://learnxinyminutes.com/docs/raku/>
    =item2 L<Golfing |https://github.com/AlexDaniel/raku-golf-cheatsheet>
=end nested
=begin nested :!nested

=item1 B<Explore>
    =item2 L<Raku Blog Aggregator|https://planet.raku.org/>
    =item2 L<Rakudo Weekly|https://rakudoweekly.blog/>
    =item2 L<The Weekly Challenge |https://perlweeklychallenge.org/>
    =item2 L<Raku Advent Calendar|https://raku-advent.blog/>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=end nested
=end React


=begin React :component<CookieConsent> :id<CookieConsent> :buttonCaption("Got it!")
=para
This website uses cookies for analytics.
=end React


Funding

NAME

SYNOPSIS

DESCRIPTION

ATTRIBUTES

status

amount

currency

METHODS

get (:$status?)

repay (:$amount!, :$currency!)

AUTHOR

COPYRIGHT AND LICENSE