Mark Rushing
and 1 contributors

NAME

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

SYNOPSIS

  use Finance::GDAX::API::Withdraw;

  $withdraw = Finance::GDAX::API::Withdraw->new(
              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('1PtbhinXWpKZjD7CXfFR7kG8RF8vJTMCxA');

DESCRIPTION

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

Both 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 $string

ID of the payment method.

coinbase_account_id $string

ID of the coinbase account.

crypto_address $string

Withdraw funds to a crypto address.

amount $number

The amount to be withdrawn.

currency $currency_string

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

METHODS

to_payment

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

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

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 <mark@orbislumen.net>

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.