{"_id":"56326ea1df556c0d00cd08ef","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"},"editedParams2":true,"parentDoc":null,"project":"544fc17e698ab40800b4f891","__v":1,"category":{"_id":"56326e9ddf556c0d00cd08d1","version":"56326e9cdf556c0d00cd08ca","pages":["56326ea1df556c0d00cd08ef","56326ea1df556c0d00cd08f0","56326ea1df556c0d00cd08f1"],"project":"544fc17e698ab40800b4f891","__v":1,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-05-01T05:24:43.401Z","from_sync":false,"order":6,"slug":"payout-outlets","title":"Payout Outlets"},"editedParams":true,"updates":["56320e8bfa40240d007c8d05","56320ef6c3b04b0d00ba9c08","56320ffbc3b04b0d00ba9c0a"],"next":{"pages":[],"description":""},"createdAt":"2015-05-01T04:48:32.205Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","examples":{"codes":[{"code":"import requests\n\nurl = 'https://coins.ph/d/api/payout-outlets'\n\nheaders = {\n    'Authorization': 'Bearer {}'.format(TOKEN),\n    'Content-Type': 'application/json;charset=UTF-8',\n    'Accept': 'application/json'\n}\n\nrequests.get(url, {'region': 'PH'}, headers=headers)\n","name":"","language":"python"},{"code":"curl -X GET \\\n    -H 'Content-Type: application/json;charset=UTF-8' \\\n    -H 'Authorization: Bearer YOUR_TOKEN' \\\n    -H 'Accept: application/json' \\\n    https://coins.ph/d/api/payout-outlets","language":"curl"}]},"method":"get","results":{"codes":[{"code":"{\n    \"meta\": {\n        \"total_count\": 74,\n        \"next_page\": 2,\n        \"previous_page\": null\n    },\n    \"payout-outlets\": [\n        {\n            \"id\": \"egivecash\",\n            \"outlet_category\": \"atm_pickup\",\n            \"name\": \"Security Bank eGiveCash\",\n            \"region\": \"PH\",\n            \"help_text\": \"\",\n            \"help_link\": \"\",\n            \"instructions\": \"Cash-out from any Security Bank ATM\"\n        },\n        {\n            \"id\": \"gcash\",\n            \"outlet_category\": \"phone_deposit\",\n            \"name\": \"Globe Cash\",\n            \"region\": \"PH\",\n            \"help_text\": \"\",\n            \"help_link\": \"\",\n            \"instructions\": \"Transfer from your Phone\"\n        }\n    ]\n}","name":"","status":200,"language":"json"}]},"auth":"required","params":[{"_id":"55430a7262b30e0d004b168a","ref":"","in":"query","required":false,"desc":"A payment outlet category ID used to filter results.","default":"","type":"string","name":"outlet_category"},{"_id":"55430a7262b30e0d004b1689","ref":"","in":"query","required":false,"desc":"Filter results by the given name.","default":"","type":"string","name":"name"},{"_id":"55430a7262b30e0d004b1688","ref":"","in":"query","required":false,"desc":"Filter results based on the given region.","default":"","type":"string","name":"region"},{"_id":"55430a7262b30e0d004b1687","ref":"","in":"query","required":false,"desc":"If `True`, results will not include disabled outlets.","default":"","type":"boolean","name":"is_enabled"},{"_id":"55430a7262b30e0d004b1686","ref":"","in":"query","required":false,"desc":"Filter results based on the view the outlet usually appears.","default":"","type":"string","name":"ui_view"},{"_id":"564da335f3171a0d0056e4b5","ref":"","in":"query","required":false,"desc":"An array of denominations which describe the outlet's supported currencies and amounts. An empty array means the outlet supports any amount.","default":"","type":"array_object","name":"denominations"}],"url":"/d/api/payout-outlets/"},"isReference":false,"order":0,"body":"A payout outlet is an establishment where users can cash out their bitcoins through either coins.ph, or coins.co.th.\n\n## Properties\n\n* **id** - A unique identifier for the payout outlet\n* **outlet_category** - The outlet's category id. These are usually establishments where the user can cash out their Bitcoins.\n* **name** - The outlet's name in human readable form.\n* **region** - An [ISO 3166-1 Alpha 2](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the region where the outlet is located.\n* **help_text** - Optional text that further describes the outlet. May be null.\n* **help_link** - Optional help article that further describes the outlet. May be null.\n* **instructions** - Instructions on how the user should process payment through the outlet.","excerpt":"Retrieve supported payout-outlets","slug":"payout-outlets","type":"endpoint","title":"payout-outlets"}

getpayout-outlets

Retrieve supported payout-outlets

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

outlet_category:
string
A payment outlet category ID used to filter results.
name:
string
Filter results by the given name.
region:
string
Filter results based on the given region.
is_enabled:
boolean
If `True`, results will not include disabled outlets.
ui_view:
string
Filter results based on the view the outlet usually appears.
denominations:
array of objects
An array of denominations which describe the outlet's supported currencies and amounts. An empty array means the outlet supports any amount.

Examples


Result Format


Documentation

A payout outlet is an establishment where users can cash out their bitcoins through either coins.ph, or coins.co.th. ## Properties * **id** - A unique identifier for the payout outlet * **outlet_category** - The outlet's category id. These are usually establishments where the user can cash out their Bitcoins. * **name** - The outlet's name in human readable form. * **region** - An [ISO 3166-1 Alpha 2](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the region where the outlet is located. * **help_text** - Optional text that further describes the outlet. May be null. * **help_link** - Optional help article that further describes the outlet. May be null. * **instructions** - Instructions on how the user should process payment through the outlet.