{"_id":"56326e9fdf556c0d00cd08e9","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"},"parentDoc":null,"user":"544fc065698ab40800b4f888","__v":0,"editedParams2":true,"project":"544fc17e698ab40800b4f891","category":{"_id":"56326e9ddf556c0d00cd08cf","project":"544fc17e698ab40800b4f891","version":"56326e9cdf556c0d00cd08ca","pages":["56326e9fdf556c0d00cd08e9","56326e9fdf556c0d00cd08ea","56326e9fdf556c0d00cd08eb"],"__v":1,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-05-01T05:27:14.271Z","from_sync":false,"order":4,"slug":"payin-outlets","title":"Payin Outlets"},"editedParams":true,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-05-01T05:37:29.732Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"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)","name":""},{"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","language":"curl"}]},"method":"get","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":""}]},"settings":"","auth":"required","params":[{"_id":"55431119795b590d001dc851","ref":"","in":"query","required":false,"desc":"A payment outlet type ID used to filter results.","default":"","type":"string","name":"payment_outlet_type"},{"_id":"55431119795b590d001dc850","ref":"","in":"query","required":false,"desc":"Filter results by the given name.","default":"","type":"string","name":"name"},{"_id":"55431119795b590d001dc84f","ref":"","in":"query","required":false,"desc":"Filter results based on the given region.","default":"","type":"string","name":"region"},{"_id":"55431119795b590d001dc84e","ref":"","in":"query","required":false,"desc":"If `True`, results will not include disabled outlets.","default":"False","type":"boolean","name":"is_enabled"},{"_id":"55431119795b590d001dc84d","ref":"","in":"query","required":false,"desc":"Filter results based on the view the outlet usually appears.","default":"","type":"string","name":"ui_view"}],"url":"/d/api/payin-outlets"},"isReference":false,"order":0,"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.","excerpt":"Retrieve supported payin-outlets","slug":"payin-outlets","type":"endpoint","title":"payin-outlets"}

getpayin-outlets

Retrieve supported payin-outlets

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query 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:
booleanFalse
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.