coinpayments v0.5.2 Coinpayments View Source

This is a wrapper for the Coinpayments API. The function names and parameters are the same as the API calls. See Coinpayments API Documentation for details.

Link to this section Summary

Functions

Get nonzero balances

Get all balances (including nonzero) — Coinpayments.balances(:all)

Claim $PayByName Tag — required params: %{tag_id: "unused_tagid", name: "newname"}

Convert coins — required params: %{amount: "NN.NN", from: "XXX", to: "YYY" }

Create mass withdrawal — required params: %{wd: "[[]]" } — this is an associative array. Please see Coinpayments.com API documentation for details

Create a transaction — required params: %{amount: "NN.NN", currency1: "XXX, currency2: "YYY" }

Create transfer (with a Merchant name) — required params: %{amount: "NN.NN", currency: "XXX, merchant: "Merchant" }

Create withdrawal — required params: %{amount: "NN.NN", currency: "XXX" }

Get basic account info

Get a callback address — required params: %{currency: "XXX"}

Get conversion information — required params: %{id: "conversion_id"}

Get deposit address — required params: %{currency: "XXX"}

Get $PayByName Profile Information —

Get $PayByName tag list

Get Transaction Information — required params: %{txid: "aaaaaa"}

Get multiple transactions information - Lets you query up to 25 transaction IDs. — required params: %{txid: "aaaaaa"}

Get withdrawal history

Get withdrawal history — optional params: limit, start, newer

Get withdrawal information — required params: %{id: "withdrawal_id"}

Get exchange rates / supported coins

Get exchange rates / supported coins — optional params: short, accepted

Update $PayByName Profile — required params: %{tag_id: "tagid"}

Link to this section Functions

Get nonzero balances

Get all balances (including nonzero) — Coinpayments.balances(:all)

Claim $PayByName Tag — required params: %{tag_id: "unused_tagid", name: "newname"}

Convert coins — required params: %{amount: "NN.NN", from: "XXX", to: "YYY" }

Link to this function create_mass_withdrawal(params) View Source

Create mass withdrawal — required params: %{wd: "[[]]" } — this is an associative array. Please see Coinpayments.com API documentation for details.

Link to this function create_transaction(params) View Source

Create a transaction — required params: %{amount: "NN.NN", currency1: "XXX, currency2: "YYY" }

Create transfer (with a Merchant name) — required params: %{amount: "NN.NN", currency: "XXX, merchant: "Merchant" }

Link to this function create_withdrawal(params) View Source

Create withdrawal — required params: %{amount: "NN.NN", currency: "XXX" }

Get basic account info.

Link to this function get_callback_address(params) View Source

Get a callback address — required params: %{currency: "XXX"}

Link to this function get_conversion_info(params) View Source

Get conversion information — required params: %{id: "conversion_id"}

Link to this function get_deposit_address(map) View Source

Get deposit address — required params: %{currency: "XXX"}

Get $PayByName Profile Information —

required params: %{pbntag: "$PbnName"}

Get $PayByName tag list

Get Transaction Information — required params: %{txid: "aaaaaa"}

Link to this function get_tx_info_multi(params) View Source

Get multiple transactions information - Lets you query up to 25 transaction IDs. — required params: %{txid: "aaaaaa"}

Link to this function get_withdrawal_history() View Source

Get withdrawal history

Link to this function get_withdrawal_history(params) View Source

Get withdrawal history — optional params: limit, start, newer

Link to this function get_withdrawal_info(params) View Source

Get withdrawal information — required params: %{id: "withdrawal_id"}

Get exchange rates / supported coins

Get exchange rates / supported coins — optional params: short, accepted

Update $PayByName Profile — required params: %{tag_id: "tagid"}