Coinbase.API.Orders
SourceSummary↑
create(coinbase, button) | Create an order |
get(coinbase, id_or_custom_field) | Show an order |
list(coinbase, optionals \\ %{}) | List orders |
refund(coinbase, id_or_custom_field, optionals \\ %{}) | Refund an order |
Functions
Specs:
- create(pid, %{}) :: Coinbase.response
Create an order
This endpoint is a shortcut combining two other endpoints: Coinbase.API.Buttons.create and Coinbase.API.Buttons.create_order
For more information on what this endpoin does read the official documentation… https://developers.coinbase.com/api#create-an-order
Optional params: account_id (string): Specify which account is used for fetching data. The default is your primary account.
Specs:
- get(pid, binary) :: Coinbase.response
Show an order
Specs:
- list(pid, %{}) :: Coinbase.response
List orders
Optional params: account_id (string): Specify which account is used for fetching data. The default is your primary account. 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.
Specs:
- refund(pid, binary, %{}) :: Coinbase.response
Refund an order
Optional params: mispayment_id (string): The ID of a mispayment to be refunded. If left blank, the original order transaction will be refunded, if the order status is completed. external_refund_address (string): This field is required if the order or mispayment does not already have a value for refund_address. Must be a valid bitcoin address. If this field is specified but the order or mispayment already has a refund_address that was automatically added by Coinbase, the already-present refund_address will take precendence over the external_refund_address specified. instant_buy (boolean): If true, will make an instant purchase for any amount of bitcoin attempting to be sent that is not already available in the account balance.