NAME

Finance::GDAX::API::Withdrawl - Withdraw funds to a Payment Method or Coinbase

SYNOPSIS

use Finance::GDAX::API::Withdraw;
$withdraw = Finance::GDAX::API::Withdraw.(
            currency => 'USD',
            amount   => 250.00);
$withdraw.payment-method-id = 'kwji-wefwe-ewrgeurg-wef';
%response = $withdraw.to-payment;
# Or, to a Coinbase account
$withdraw.coinbase-account-id = 'woifhe-i234h-fwikn-wfihwe';
%response = $withdraw.to-coinbase;
# Or, to a Crypto address
%withdraw->crypto-address(:crypto-address('1PtbhinXWpKZjD7CXfFR7kG8RF8vJTMCxA'));

DESCRIPTION

Used to transfer funds out of your GDAX account, either to a predefined Payment Method or your Coinbase account.

All methods require the same two attributes: "amount" and "currency" to be set, along with their corresponding payment or coinbase account id's.

ATTRIBUTES

payment-method-id

ID of the payment method.

coinbase-account-id

ID of the coinbase account.

crypto-address

Withdraw funds to a crypto address.

amount

The amount to be withdrawn.

currency

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

METHODS

to-payment (:$payment-method-id)

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

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

{
    "id":"593533d2-ff31-46e0-b22e-ca754147a96a",
    "amount": "10.00",
    "currency": "USD",
    "payout_at": "2016-08-20T00:31:09Z"
  }

to-coinbase (:$coinbase-account-id)

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

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

{
    "id":"593533d2-ff31-46e0-b22e-ca754147a96a",
    "amount":"10.00",
    "currency": "BTC",
  }

to-crypto (:$crypto-address)

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

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

{
    "id":"593533d2-ff31-46e0-b22e-ca754147a96a",
    "amount":"10.00",
    "currency": "BTC",
  }

AUTHOR

Mark Rushing <[email protected]>

COPYRIGHT AND LICENSE

This software is copyright (c) 2017 by Home Grown Systems, SPC.

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