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

class Finance::GDAX::API::MarginTransfer does Finance::GDAX::API
{
    has                    $.margin-profile-id is rw is required;
    has MarginTransferType $.type              is rw is required;
    has PositiveNum        $.amount            is rw is required;
    has                    $.currency          is rw is required;

    method initiate {	
	$.path   = 'profiles/margin-transfer';
	$.method = 'POST';
	$.body   = { amount            => $.amount,
		     currency          => $.currency,
		     type              => $.type,
		     margin_profile_id => $.margin-profile-id };

	return self.send;
    }
}



head

Finance::GDAX::API::MarginTransfer - Transfer funds between margin and
standard GDAX profiles


code

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

  $xfer = Finance::GDAX::API::MarginTransfer.new(
          type     => 'withdrawl',
          currency => 'USD',
          amount   => 250.00);

  $xfer.margin_profile_id = 'kwji-wefwe-ewrgeurg-wef';

  %response = $xfer.initiate;
  =end code


Used to transfer funds between the GDAX standard/default profile and
the margin account. All attributes are required to be set before
calling the "initiate" method.


Transfer funds between your standard/default profile and a margin
profile. A deposit will transfer funds from the default profile into
the margin profile. A withdraw will transfer funds from the margin
profile to the default profile. Withdraws will fail if they would set
your margin ratio below the initial margin ratio requirement.


The id of the margin profile you'd like to deposit to or withdraw from.


Currently "deposit" or "withdraw" are valid.


Deposit transfers out from the default profile, into the margin
profile.


Withdraw transfers out of the margin account and into the default
profile.


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


All attributed must be set before calling this method. The return
value is a hash that will describe the result of the transfer.


From the current GDAX API documentation, this is how that returned hash is
keyed:


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

Order

Funding

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


MarginTransfer

NAME

SYNOPSIS

DESCRIPTION

ATTRIBUTES

margin-profile-id

type

amount

currency

METHODS

initiate

AUTHOR

COPYRIGHT AND LICENSE