{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/d/api/payin-outlets","auth":"required","apiSetting":"5d1d8bb82d46d1004a02581d","examples":{"codes":[{"language":"python","code":"import requests\n\nurl = 'https://coins.ph/d/api/payin-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)"},{"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/payin-outlets"}]},"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"payin-outlets\": [\n        {\n            \"id\": \"citibank_deposit\",\n            \"outlet_category\": \"bank_deposit\",\n            \"name\": \"Citibank\",\n            \"region\": \"PH\",\n            \"help_text\": \"\",\n            \"help_link\": \"\",\n            \"instructions\": \"Deposit to our citibank account 1234 for your cash-in\"\n        },\n        {\n            \"id\": \"bdo_deposit\",\n            \"payment_outlet_type\": {\n                \"id\": \"bank_deposit\",\n                \"name\": \"Bank Cash-in\",\n                \"fields\": [],\n                \"fee_structure_description\": null,\n                \"payout_duration_description\": null\n            },\n            \"name\": \"BDO Cash-in\",\n            \"region\": \"PH\",\n            \"help_text\": \"\",\n            \"help_link\": \"\",\n            \"instructions\": \"Deposit to our BDO account 5169 for your cash-in\"\n        }\n    ],\n    \"meta\": {\n        \"total_count\": 6,\n        \"next_page\": null,\n        \"previous_page\": null\n    }\n}\n","name":""}]},"params":[{"name":"payment_outlet_type","type":"string","default":"","desc":"A payment outlet type ID used to filter results.","required":false,"in":"path","ref":"","_id":"5d1d8e6f1f885c00481979a5"},{"name":"name","type":"string","default":"","desc":"Filter results by the given name.","required":false,"in":"path","ref":"","_id":"5d1d8e6f1f885c00481979a4"},{"name":"region","type":"string","default":"","desc":"Filter results based on the given region.","required":false,"in":"path","ref":"","_id":"5d1d8e6f1f885c00481979a3"},{"name":"is_enabled","type":"boolean","default":"","desc":"If `True`, results will not include disabled outlets.","required":false,"in":"path","ref":"","_id":"5d1d8e6f1f885c00481979a2"},{"name":"ui_view","type":"string","default":"","desc":"Filter results based on the view the outlet usually appears.","required":false,"in":"path","ref":"","_id":"5d1d8e6f1f885c00481979a1"}],"method":"get","settings":""},"next":{"description":"","pages":[]},"title":"payin-outlets","type":"endpoint","slug":"payin-outlets","excerpt":"Retrieve supported payin-outlets","body":"A payin outlet is an establishment where users can use cash to buy bitcoins through either coins.ph, or coins.co.th.\n\n## Properties\n\n* **id** - A unique identifier for the payin outlet\n* **outlet_category** - The outlet's category id. These are usually establishments where coins accepts fiat.\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.","updates":[],"order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5d1d8e6f1f885c00481979a0","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-04T07:56:23.225Z","createdAt":"2019-07-04T05:28:15.549Z","project":"544fc17e698ab40800b4f891","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Payin Outlets","slug":"payin-outlets-1","order":16,"from_sync":false,"reference":true,"_id":"5d1d8de1e4edb0019ed63acd","project":"544fc17e698ab40800b4f891","version":"56326e9cdf556c0d00cd08ca","isAPI":false,"createdAt":"2019-07-04T05:25:53.841Z","__v":0},"user":"5d19a189b4596f0072f571d4","__v":3,"parentDoc":null}

getpayin-outlets

Retrieve supported payin-outlets

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

payment_outlet_type:
string
A payment outlet type 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.

Examples


Result Format


Documentation

A payin outlet is an establishment where users can use cash to buy bitcoins through either coins.ph, or coins.co.th. ## Properties * **id** - A unique identifier for the payin outlet * **outlet_category** - The outlet's category id. These are usually establishments where coins accepts fiat. * **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.