{"_id":"5d2431a79e1a0e00e54e0bd6","version":{"_id":"56326e9cdf556c0d00cd08ca","project":"544fc17e698ab40800b4f891","__v":22,"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","5ab2fcf66a1d77001230b47e","5afc2943bd2ef4000330bca7","5d1d87419a969a00141c6b4c","5d1d8948ef26b2002c6468d1","5d1d8afe7b2b24005bec7de0","5d1d8b24f5cfcb00201490bb","5d1d8bb82d46d1004a02581f","5d1d8de1e4edb0019ed63acd","5d1d8f6b613fb90050d0d3e0","5d1d934ed377870191039d28","5d1d99810b2e4600500eb5ff","5d1da14e613fb90050d0d491","5d229a846cf323005a7fa998","5d229a8c8abf65001cc4768d","5d229a9494b856002e26b6e1","5d229a9bf77bb900507ccb04","5d229aa88abf65001cc4768e","5d24310a9ca8c80054786177","5d24359101cc3a00508e7482","5d24418fa791b20050733b32"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"collector","version_clean":"2.1.0","version":"2.1"},"updatedAt":"2019-07-09T06:18:25.102Z","project":"544fc17e698ab40800b4f891","category":{"_id":"5d24310a9ca8c80054786177","project":"544fc17e698ab40800b4f891","version":"56326e9cdf556c0d00cd08ca","isAPI":false,"__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2019-07-09T06:15:38.687Z","from_sync":false,"order":18,"slug":"payout-outlets-1","title":"Payout Outlets"},"user":"5d19a189b4596f0072f571d4","__v":1,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-07-09T06:18:15.812Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"5d1d8bb82d46d1004a02581d","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","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"}]},"results":{"codes":[{"name":"","code":"{\n    \"meta\": {\n        \"total_count\": 5,\n        \"next_page\": null,\n        \"previous_page\": null\n    },\n    \"payout-outlets\": [\n        {\n            \"id\": \"coins_exchange_bch\",\n            \"outlet_category\": \"bills_payment_exchange\",\n            \"payment_outlet_provider\": null,\n            \"amount_limits\": [\n                {\n                    \"currency\": \"BCH\",\n                    \"minimum\": 0.00025,\n                    \"maximum\": 100000000,\n                    \"increment\": 1e-8\n                }\n            ],\n            \"default_currency\": \"BCH\",\n            \"denominations\": [],\n            \"products\": [],\n            \"product_categories\": [],\n            \"name\": \"Coins Pro (BCH)\",\n            \"fields\": [],\n            \"remittance_fields\": [\n                {","language":"json","status":200}]},"method":"get","auth":"required","params":[{"_id":"5d2431a79e1a0e00e54e0bdc","ref":"","in":"path","required":false,"desc":"A payment outlet category ID used to filter results.","default":"","type":"string","name":"outlet_category"},{"_id":"5d2431a79e1a0e00e54e0bdb","ref":"","in":"path","required":false,"desc":"Filter results by the given name.","default":"","type":"string","name":"name"},{"_id":"5d2431a79e1a0e00e54e0bda","ref":"","in":"path","required":false,"desc":"Filter results based on the given region.","default":"","type":"string","name":"region"},{"_id":"5d2431a79e1a0e00e54e0bd9","ref":"","in":"path","required":false,"desc":"If `True`, results will not include disabled outlets.","default":"","type":"string","name":"is_enabled"},{"_id":"5d2431a79e1a0e00e54e0bd8","ref":"","in":"path","required":false,"desc":"Filter results based on the view the outlet usually appears.","default":"","type":"string","name":"ui_view"},{"_id":"5d2431a79e1a0e00e54e0bd7","ref":"","in":"path","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":"string","name":"denominations"}],"url":"/d/api/payout-outlets/"},"isReference":true,"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.\n\n# UI Views\n\nYou can specify a UI view to get filtered result. This should return a list of outlets which are setup for a particular purpose.\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"partner_disbursement\",\n    \"0-1\": \"Supported disbursement options.\",\n    \"h-0\": \"Code\",\n    \"h-1\": \"Description\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]","excerpt":"Retrieve supported payout-outlets","slug":"payout-outlets-1","type":"endpoint","title":"payout-outlets"}

getpayout-outlets

Retrieve supported payout-outlets

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path 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:
string
If `True`, results will not include disabled outlets.
ui_view:
string
Filter results based on the view the outlet usually appears.
denominations:
string
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. # UI Views You can specify a UI view to get filtered result. This should return a list of outlets which are setup for a particular purpose. [block:parameters] { "data": { "0-0": "partner_disbursement", "0-1": "Supported disbursement options.", "h-0": "Code", "h-1": "Description" }, "cols": 2, "rows": 1 } [/block]