Coinbase.API.Transactions

Source

Summary

cancel_request(coinbase, id, optionals \\ %{})

Cancel bitcoin request

complete_request(coinbase, id, optionals \\ %{})

Complete bitcoin request

get(coinbase, id, optionals \\ %{})

Show a transaction

list(coinbase, optionals \\ %{})

Lists transactions

request_money(coinbase, transaction, optionals \\ %{})

Request money

resend_request(coinbase, id, optionals \\ %{})

Resend bitcoin request

send_money(coinbase, transaction, optionals \\ %{})

Send money

sighashes(coinbase, id, optionals \\ %{})

Get signature hashes for each input that needs signing in a spend from multisig transaction (multisig)

signatures(coinbase, id, signatures)

Submit required signatures for a multisig spend transaction (multisig)

transfer_money(coinbase, transaction, optionals \\ %{})

Transfer money between two accounts

Functions

cancel_request(coinbase, id, optionals \\ %{})

Specs:

Cancel bitcoin request

Optional params: account_id (string): Specify which account is used for fetching data. The default is your primary account.

Source
complete_request(coinbase, id, optionals \\ %{})

Specs:

Complete bitcoin request

Optional params: account_id (string): Specify which account is used for fetching data. The default is your primary account.

Source
get(coinbase, id, optionals \\ %{})

Specs:

Show a transaction

Optional params: account_id (string): Specify which account is used for fetching data. THe default is your primary account

Source
list(coinbase, optionals \\ %{})

Specs:

Lists transactions

Optional params: page (integer): Can be used to page through results. Default value is 1. limit (integer): Number of records to return. Maximum is 1000. Default value is 25. account_id (string): Specify which account is used for fetching data. The default is your primary account

Source
request_money(coinbase, transaction, optionals \\ %{})

Specs:

Request money

Optional params: account_id (string): Specify which account is used for fetching data. The default is your primary account. transaction[amount] (string): A string amount that will be converted to BTC, such as 1 or 1.234567. If you want to use a different currency you can set amount_string and amount_currency_iso instead. This will automatically convert the amount to BTC and that converted amount will show in the transaction. transaction[amount_string] (string): A string amount that can be in any currency. If you use this with amount_currency_iso you should leave amount blank. transaction[amount_currency_iso] (string): A currency symbol such as USD, EUR, or BTC transaction[notes] (string): Notes to be included in the email that the recipient receives.

Source
resend_request(coinbase, id, optionals \\ %{})

Specs:

Resend bitcoin request

Optional params: account_id (string): Specify which account is used for fetching data. The default is your primary account.

Source
send_money(coinbase, transaction, optionals \\ %{})

Specs:

Send money

Optional params: account_id (string): Specify which account is used for fetching data. The default is your primary account. transaction[amount] (string): A string amount that will be converted to BTC, such as 1 or 1.234567. If you want to use a different currency you can set amount_string and amount_currency_iso instead. This will automatically convert the amount to BTC and that converted amount will show in the transaction. transaction[amount_string] (string): A string amount that can be in any currency. If you use this with amount_currency_iso you should leave amount blank. transaction[amount_currency_iso] (string): A currency symbol such as USD, EUR, or BTC transaction[notes] (string): Notes to be included in the email that the recipient receives. transaction[user_fee] (string): Optional transaction fee in BTC if you would like to pay it. Coinbase pays transaction fees on payments greater than or equal to 0.001 BTC. But for smaller amounts you may want to add your own amount. Fees can be added as a string, such as 0.0005. transaction[referrer_id] (string): Optional id of the user to get a referral credit in the case that this transaction makes the user eligible. The referring user is eligible for a credit if the address in the to field is an email address for which there is currently no registered account and the recipient proceeds to buy or sell at least 100 USD worth of BTC. transaction[idem] (string): An optional token to ensure idempotence. If a previous transaction with the same idem parameter already exists for this sender, that previous transaction will be returned and a new one will not be created. Max length 100 characters. transaction[instant_buy] (boolean): Optional parameter signaling that if your account does not currently have enough funds to cover the amount, first purchase the difference with an instant buy, then send the bitcoin. For example, if you want to send 1.25 BTC, but your account only has 0.5 BTC, typically you would get an error. If you pass instant_buy as true and also have Instant Buy enabled on your account, then first an instant purchase will be made for 0.75 BTC, and once purchased, the full 1.25 BTC will be sent. If the instant buy is successful, the response will come back with an additional transfer field representing the purchase transaction[order_id] (string): Use this field to associate this transaction with an order as a refund. This transaction’s ID will appear in the order’s manual_refund_tx_ids field.

Source
sighashes(coinbase, id, optionals \\ %{})

Specs:

Get signature hashes for each input that needs signing in a spend from multisig transaction (multisig)

Optional params: account_id (string): Specify which account is used for fetching data. The default is your primary account.

Source
signatures(coinbase, id, signatures)

Specs:

Submit required signatures for a multisig spend transaction (multisig)

‘signatures’ object is an list of Coinbase.Signature

Source
transfer_money(coinbase, transaction, optionals \\ %{})

Specs:

Transfer money between two accounts

Optional params: account_id (string): Specify which account is used for fetching data. The default is your primary account. transaction[amount] (string): A string amount that will be converted to BTC, such as 1 or 1.234567. Also must be >= 0.01 or it will shown an error

Source