{"_id":"56326e9fdf556c0d00cd08ea","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,"user":"544fc065698ab40800b4f888","__v":1,"parentDoc":null,"project":"544fc17e698ab40800b4f891","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,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-05-01T05:41:20.584Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"payin-outlet-categories\": [\n        {\n            \"id\": \"bank_deposit\",\n            \"name\": \"Bank Cash-in\",\n            \"fields\": [],\n            \"outlets\": [\n                \"bpi\",\n                \"bdo\"\n            ],\n            \"fee_structure_description\": \"PHP 10 for every PHP 1000\",\n            \"payout_duration_description\": \"Same day payout\",\n            \"outlet_names_subset\": [\n                \"BPI\",\n                \"BDO\"\n            ]\n        },\n        {\n            \"id\": \"validated_deposit\",\n            \"name\": \"Validated Bank Cash-in\",\n            \"fields\": [],\n            \"outlets\": [\n                \"bpi_family\",\n                \"citibank\"\n            ],\n            \"fee_structure_description\": \"PHP 10 for every PHP 1000\",\n            \"payout_duration_description\": \"Same day payout\",\n            \"outlet_names_subset\": [\n                \"BPI Family\",\n                \"CitiBank\"\n            ]\n        }\n    ],\n    \"meta\": {\n        \"total_count\": 3,\n        \"next_page\": null,\n        \"previous_page\": null\n    }\n}\n","name":""}]},"settings":"","examples":{"codes":[{"language":"python","code":"import requests\n\nTOKEN = 'YOUR TOKEN'\nurl = 'https://coins.ph/d/api/payin-outlet-categories'\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":""}]},"method":"get","auth":"required","params":[{"_id":"55431200795b590d001dc854","ref":"","in":"query","required":false,"desc":"Filter to only the categories with outlets based on the given region.","default":"","type":"string","name":"region"},{"_id":"55431200795b590d001dc853","ref":"","in":"query","required":false,"desc":"Filter to only the categories with outlets that belong to the given `ui_view`.","default":"","type":"string","name":"ui_view"},{"_id":"579724d62cd23b0e00283c8b","ref":"","in":"path","required":false,"desc":"Optional. ID of a particular category to retrieve. If not provided, all categories will be retrieved.","default":"","type":"string","name":"id"}],"url":"/d/api/payin-outlet-categories/:id/"},"isReference":false,"order":1,"body":"Payin outlets are grouped into categories, examples of which are `bank_deposit`, etc.\n\n## Properties\n\n* **id** - Unique identifier for the payout outlet category.\n* **name** - The category's name in human readable form.\n* **fields** - A collection of fields that payment outlets of this category requires.\n* **fee_info** - Describes how fees in this category are structured in general.\n* **payout_duration** - Describes how long it usually takes to process payouts to outlets of this category.\n* **outlets** - An array of outlet IDs that belong to the category.\n* **outlet_names_subset** - A subset of outlet names that can be used as examples for the category.","excerpt":"Retrieve supported payin-outlet-categories","slug":"payin-outlet-categories","type":"endpoint","title":"payin-outlet-categories"}

getpayin-outlet-categories

Retrieve supported payin-outlet-categories

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
string
Optional. ID of a particular category to retrieve. If not provided, all categories will be retrieved.

Query Params

region:
string
Filter to only the categories with outlets based on the given region.
ui_view:
string
Filter to only the categories with outlets that belong to the given `ui_view`.

Examples


Result Format


Documentation

Payin outlets are grouped into categories, examples of which are `bank_deposit`, etc. ## Properties * **id** - Unique identifier for the payout outlet category. * **name** - The category's name in human readable form. * **fields** - A collection of fields that payment outlets of this category requires. * **fee_info** - Describes how fees in this category are structured in general. * **payout_duration** - Describes how long it usually takes to process payouts to outlets of this category. * **outlets** - An array of outlet IDs that belong to the category. * **outlet_names_subset** - A subset of outlet names that can be used as examples for the category.