{"_id":"56326ea1df556c0d00cd08f3","editedParams2":true,"project":"544fc17e698ab40800b4f891","category":{"_id":"56326e9ddf556c0d00cd08ce","__v":1,"pages":["56326ea1df556c0d00cd08f2","56326ea1df556c0d00cd08f3","56326ea1df556c0d00cd08f4"],"project":"544fc17e698ab40800b4f891","version":"56326e9cdf556c0d00cd08ca","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-10-28T16:17:37.944Z","from_sync":false,"order":3,"slug":"cash-in","title":"Cash In"},"user":"544fc065698ab40800b4f888","version":{"_id":"56326e9cdf556c0d00cd08ca","project":"544fc17e698ab40800b4f891","__v":2,"createdAt":"2015-10-29T19:08:12.724Z","releaseDate":"2015-10-29T19:08:12.724Z","categories":["56326e9ddf556c0d00cd08cb","56326e9ddf556c0d00cd08cc","56326e9ddf556c0d00cd08cd","56326e9ddf556c0d00cd08ce","56326e9ddf556c0d00cd08cf","56326e9ddf556c0d00cd08d0","56326e9ddf556c0d00cd08d1","56326e9ddf556c0d00cd08d2","56326e9ddf556c0d00cd08d3","56326e9ddf556c0d00cd08d4","56d942ac337fd11300d6a251"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"collector","version_clean":"2.1.0","version":"2.1"},"editedParams":true,"__v":1,"parentDoc":null,"updates":["5697d8db8d2a770d00d2fce9"],"next":{"pages":[],"description":""},"createdAt":"2015-05-01T06:28:55.284Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"name":"","language":"python","code":"import requests\n\nTOKEN = 'YOUR TOKEN'\nurl = 'https://coins.ph/api/v2/buyorder'\n\nheaders = {\n    'Authorization': 'Bearer {}'.format(TOKEN),\n    'Accept': 'application/json'\n}\n\nrequests.get(url, headers=headers)"}]},"method":"get","results":{"codes":[{"status":200,"language":"json","code":"{\n    \"order\": {\n        \"btc_amount\": \"0.025\",\n        \"btc_released\": \"0\",\n        \"canceled_time\": null,\n        \"created_at\": \"1409207466\",\n        \"currency_amount\": \"624\",\n        \"expiration_time\": \"1409211066\",\n        \"id\": \"1o2r3d4e5r\",\n        \"instructions\": \"Deposit to our BDO bank account for your cash-in order\",\n        \"marked_paid_time\": null,\n        \"payment_method\": \"bdo_deposit\",\n        \"rate\": \"24489\",\n        \"status\": \"pending_payment\",\n        \"wallet_address\": \"kfkffh32432\"\n    },\n    \"success\": true\n}\n","name":""}]},"settings":"","auth":"required","params":[{"_id":"55431d2762b30e0d004b16a3","ref":"","in":"path","required":false,"desc":"Optional. ID of a specific buyorder record to retrieve. Buy order transaction history will be returned if this is not provided.","default":"","type":"string","name":"buyorder_id"}],"url":"/api/v2/buyorder/:buyorder_id"},"isReference":false,"order":1,"body":"Buy orders allow users to cash in for bitcoins. Supported cash in options can be retrieved from [payin-outlets](doc:payin-outlets).\n\n## Properties\n\n* **id** - A unique identifier for the buyorder.\n* **btc_amount** - The amount of BTC transaction.\n* **btc_released** - If the buyorder is already processed, specifies the amount released to the target account or address.\n* **canceled_time** - If the buyorder is canceled, specifies the time when it was cancelled.\n* **created_at** - Specifies the time when the buyorder was created\n* **currency_amount** - The equivalent amount of the `btc_amount` in fiat, based on the rate when the order was created.\n* **marked_paid_time** - Specifies the time when the user marked the buyorder as paid.\n* **payment_method** - The [payin-outlet](doc:payin-outlets) used to pay for the buyorder.\n* **rate** - BTC->Fiat exchange rate at the time when the buyorder was created.\n* **status** - Specifies whether the order is `released`, `payment_received`, `canceled`, or `escrow_expired`.\n* **wallet_address** - The BTC wallet address where the funds will be `released` after the buyorder is fullfiled.","excerpt":"Retrieve an existing buyorder","slug":"buyorder","type":"endpoint","title":"buyorder"}

getbuyorder

Retrieve an existing buyorder

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

buyorder_id:
string
Optional. ID of a specific buyorder record to retrieve. Buy order transaction history will be returned if this is not provided.

Examples


Result Format


Documentation

Buy orders allow users to cash in for bitcoins. Supported cash in options can be retrieved from [payin-outlets](doc:payin-outlets). ## Properties * **id** - A unique identifier for the buyorder. * **btc_amount** - The amount of BTC transaction. * **btc_released** - If the buyorder is already processed, specifies the amount released to the target account or address. * **canceled_time** - If the buyorder is canceled, specifies the time when it was cancelled. * **created_at** - Specifies the time when the buyorder was created * **currency_amount** - The equivalent amount of the `btc_amount` in fiat, based on the rate when the order was created. * **marked_paid_time** - Specifies the time when the user marked the buyorder as paid. * **payment_method** - The [payin-outlet](doc:payin-outlets) used to pay for the buyorder. * **rate** - BTC->Fiat exchange rate at the time when the buyorder was created. * **status** - Specifies whether the order is `released`, `payment_received`, `canceled`, or `escrow_expired`. * **wallet_address** - The BTC wallet address where the funds will be `released` after the buyorder is fullfiled.