{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/v1/payout-outlets/","auth":"required","apiSetting":"5d1d8bb82d46d1004a02581d","examples":{"codes":[{"language":"python","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":"curl","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"}]},"results":{"codes":[{"status":200,"language":"json","code":"\"payout-outlets\": [\n        {\n            \"id\": \"bdo\",\n            \"outlet_category\": \"bank\",\n            \"payment_outlet_provider\": null,\n            \"amount_limits\": [\n                {\n                    \"currency\": \"PHP\",\n                    \"minimum\": 50,\n                    \"maximum\": 100000000,\n                    \"increment\": 0.00001\n                },\n                {\n                    \"currency\": \"USD\",\n                    \"minimum\": 0,\n                    \"maximum\": 100000000,\n                    \"increment\": 0.00001\n                }\n            ],\n            \"default_currency\": \"PHP\",\n            \"denominations\": [],\n            \"products\": [],\n            \"product_categories\": [],\n            \"name\": \"BDO\",\n            \"fields\": [\n                {\n                    \"help_text\": \" \",\n                    \"placeholder\": \"\",\n                    \"id\": \"bank_bank_account_name\",\n                    \"help_link\": \"\",\n                    \"index\": \"\",\n                    \"name\": \"bank_account_name\",\n                    \"pattern\": \"\",\n                    \"label\": \"Account Holder Name\",\n                    \"is_required\": true,\n                    \"type\": \"\",\n                    \"options\": {}\n                },\n                {\n                    \"help_text\": \"\",\n                    \"placeholder\": \"\",\n                    \"id\": \"bank_bank_account_number\",\n                    \"help_link\": \"\",\n                    \"index\": \"\",\n                    \"name\": \"bank_account_number\",\n                    \"pattern\": \"\",\n                    \"label\": \"Bank Account Number\",\n                    \"is_required\": true,\n                    \"type\": \"\",\n                    \"options\": {}\n                },\n                {\n                    \"help_text\": \"An SMS will be sent to the recipient once they have received payment.\",\n                    \"placeholder\": \"\",\n                    \"id\": \"bank_recipient_phone_number\",\n                    \"help_link\": \"\",\n                    \"index\": \"\",\n                    \"name\": \"recipient_phone_number\",\n                    \"pattern\": \"\",\n                    \"label\": \"Recipient Mobile Number (Optional)\",\n                    \"is_required\": false,\n                    \"type\": \"mobile_number\",\n                    \"options\": {}\n                }\n            ],\n            \"remittance_fields\": [\n                {\n                    \"index\": \"\",\n                    \"is_required\": false,\n                    \"name\": \"sender_first_name\",\n                    \"type\": \"text\",\n                    \"help_text\": \"\",\n                    \"pattern\": \"\",\n                    \"help_link\": \"\",\n                    \"placeholder\": \"Sender first name\",\n                    \"id\": \"sender_first_name\",\n                    \"label\": \"Sender first name\"\n                },\n                {\n                    \"index\": \"\",\n                    \"is_required\": false,\n                    \"name\": \"sender_middle_name\",\n                    \"type\": \"text\",\n                    \"help_text\": \"\",\n                    \"pattern\": \"\",\n                    \"help_link\": \"\",\n                    \"placeholder\": \"Sender middle name\",\n                    \"id\": \"sender_middle_name\",\n                    \"label\": \"Sender middle name\"\n                }\n            ],\n            \"region\": \"PH\",\n            \"provider_region\": \"\",\n            \"verification_level_requirement\": 0,\n            \"help_text\": \"If account is based outside Metro Manila, deposit fees may be applied by the bank.\",\n            \"help_link\": \"https://coinsph.zendesk.com/hc/en-us/articles/201887310\",\n            \"disabled_notice\": \"\",\n            \"disclaimer_notice\": \"Please note that we are forced to introduce a fee for BDO cash-outs as BDO Unibank has been mounting difficulties in sending payments to and from their account holders, undermining our mission to provide low-cost and fair access to financial services. We encourage customers to consider other cash-out options at this time. All other bank cash-outs remain FREE.\",\n            \"logo_url\": \"\",\n            \"instructions\": \"\",\n            \"payout_duration\": \"\",\n            \"is_express\": false,\n            \"importance\": 100,\n            \"is_enabled\": true,\n            \"is_custom_denomination_allowed\": true,\n            \"is_email_required\": false\n        },","name":""}]},"params":[{"name":"outlet_category","type":"string","default":"","desc":"A payment outlet category ID used to filter results.","required":false,"in":"path","ref":"","_id":"5d2431a79e1a0e00e54e0bdc"},{"name":"name","type":"string","default":"","desc":"Filter results by the given name.","required":false,"in":"path","ref":"","_id":"5d2431a79e1a0e00e54e0bdb"},{"name":"region","type":"string","default":"","desc":"Filter results based on the given region.","required":false,"in":"path","ref":"","_id":"5d2431a79e1a0e00e54e0bda"},{"name":"is_enabled","type":"string","default":"","desc":"If `True`, results will not include disabled outlets.","required":false,"in":"path","ref":"","_id":"5d2431a79e1a0e00e54e0bd9"},{"name":"ui_view","type":"string","default":"","desc":"Filter results based on the view the outlet usually appears.","required":false,"in":"path","ref":"","_id":"5d2431a79e1a0e00e54e0bd8"},{"name":"denominations","type":"string","default":"","desc":"An array of denominations which describe the outlet's supported currencies and amounts. An empty array means the outlet supports any amount.","required":false,"in":"path","ref":"","_id":"5d2431a79e1a0e00e54e0bd7"}],"method":"get","settings":"5d2c16e9ab606a0056359c3c"},"next":{"description":"","pages":[]},"title":"payout-outlets","type":"endpoint","slug":"payout-outlets","excerpt":"Retrieve supported payout-outlets","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 wallet funds\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## amount_limits\n\nArray of currencies offered to cash out along with the respective limits.\n\n* **currency** - The currency whose limit is being specified.\n* **minimum** - The minimum value of that currency in order to be cashed out.\n* **maximum** The maximum value of that currency that can be cashed out in one order.\n* **increment** - The smallest value you can increase or decrease the cash out payment by. \n\n## fields and remittance_fields\n\nContains all the fields for the payout such as sender_first_name, sender_country, sender_email, etc. \n\n* **is_required** - Boolean value that states if a certain field is required for the specific payout outlet.\n* **name** - The name of the field, (i.e. \"sender_first_name\", \"sender_email).\n* **type** - The format of the field, will always show \"text\". \n* **placeholder/label** - The name of the field in a more readable format.\n\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]","updates":[],"order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5d2431a79e1a0e00e54e0bd6","version":{"version":"2.1","version_clean":"2.1.0","codename":"collector","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"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"],"_id":"56326e9cdf556c0d00cd08ca","project":"544fc17e698ab40800b4f891","releaseDate":"2015-10-29T19:08:12.724Z","__v":22,"createdAt":"2015-10-29T19:08:12.724Z"},"updatedAt":"2019-07-09T06:18:25.102Z","createdAt":"2019-07-09T06:18:15.812Z","project":"544fc17e698ab40800b4f891","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Payout Outlets","slug":"payout-outlets-1","order":18,"from_sync":false,"reference":true,"_id":"5d24310a9ca8c80054786177","project":"544fc17e698ab40800b4f891","version":"56326e9cdf556c0d00cd08ca","isAPI":false,"createdAt":"2019-07-09T06:15:38.687Z","__v":0},"user":"5d19a189b4596f0072f571d4","__v":4,"parentDoc":null}

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 wallet funds * **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. ## amount_limits Array of currencies offered to cash out along with the respective limits. * **currency** - The currency whose limit is being specified. * **minimum** - The minimum value of that currency in order to be cashed out. * **maximum** The maximum value of that currency that can be cashed out in one order. * **increment** - The smallest value you can increase or decrease the cash out payment by. ## fields and remittance_fields Contains all the fields for the payout such as sender_first_name, sender_country, sender_email, etc. * **is_required** - Boolean value that states if a certain field is required for the specific payout outlet. * **name** - The name of the field, (i.e. "sender_first_name", "sender_email). * **type** - The format of the field, will always show "text". * **placeholder/label** - The name of the field in a more readable format. # 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]