{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/d/api/payin-outlet-categories/:id/","auth":"required","apiSetting":"5d1d8bb82d46d1004a02581d","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)"}]},"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":""}]},"params":[{"name":"id","type":"string","default":"","desc":"Optional. ID of a particular category to retrieve. If not provided, all categories will be retrieved.","required":false,"in":"path","ref":"","_id":"5d1d8edbdea05400334c9014"},{"name":"region","type":"string","default":"","desc":"Filter to only the categories with outlets based on the given region.","required":false,"in":"query","ref":"","_id":"5d1d8edbdea05400334c9013"},{"name":"ui_view","type":"string","default":"","desc":"Filter to only the categories with outlets that belong to the given `ui_view`.","required":false,"in":"query","ref":"","_id":"5d1d8edbdea05400334c9012"}],"method":"get","settings":""},"next":{"description":"","pages":[]},"title":"payin-outlet-categories","type":"endpoint","slug":"payin-outlet-categories","excerpt":"Retrieve supported payin-outlet-categories","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.","updates":[],"order":1,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5d1d8edbdea05400334c9011","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.226Z","createdAt":"2019-07-04T05:30:03.485Z","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":4,"parentDoc":null}

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.