{"_id":"56326ea1df556c0d00cd08f0","__v":1,"parentDoc":null,"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"},"editedParams":true,"editedParams2":true,"user":"544fc065698ab40800b4f888","category":{"_id":"56326e9ddf556c0d00cd08d1","version":"56326e9cdf556c0d00cd08ca","pages":["56326ea1df556c0d00cd08ef","56326ea1df556c0d00cd08f0","56326ea1df556c0d00cd08f1"],"project":"544fc17e698ab40800b4f891","__v":1,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-05-01T05:24:43.401Z","from_sync":false,"order":6,"slug":"payout-outlets","title":"Payout Outlets"},"project":"544fc17e698ab40800b4f891","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-05-01T05:18:00.789Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"payout-outlet-categories\": [\n        {\n            \"id\": \"mobile_load\",\n            \"name\": \"Mobile Load\",\n            \"fields\": [\n                {\n                    \"id\": \"phone_number\",\n                    \"name\": \"Phone Number\",\n                    \"help_text\": \"Phone Number\",\n                    \"help_link\": \"\"\n                }\n            ],\n            \"outlets\": [\n                \"load_globe\",\n                \"load_smart\"\n            ],\n            \"fee_info\": \"PHP 10 for every PHP 1000\",\n            \"payout_duration\": \"Same day payout\",\n            \"outlet_names_subset\": [\n                \"Globe Load\",\n                \"Smart Load\"\n            ]\n        },\n        {\n            \"id\": \"atm_pickup\",\n            \"name\": \"ATM Pickup\",\n            \"fields\": [\n                {\n                    \"id\": \"recipient_full_name\",\n                    \"name\": \"Recipient Full Name\",\n                    \"help_text\": \"Recipient Full Name\",\n                    \"help_link\": \"\"\n                },\n                {\n                    \"id\": \"recipient_mobile\",\n                    \"name\": \"Recipient Mobile Phone\",\n                    \"help_text\": \"Recipient Mobile Phone Number (e.g. 09171234567)\",\n                    \"help_link\": \"\"\n                }\n            ],\n            \"outlets\": [\n                \"egivecash\"\n            ],\n            \"fee_info\": \"PHP 10 for every PHP 1000\",\n            \"payout_duration\": \"Same day payout\",\n            \"outlet_names_subset\": [\n                \"EGiveCash\"\n            ]\n        }\n    ],\n    \"meta\": {\n        \"total_count\": 13,\n        \"next_page\": 2,\n        \"previous_page\": null\n    }\n}\n","name":""}]},"settings":"","examples":{"codes":[{"name":"","language":"python","code":"import requests\n\nTOKEN = 'YOUR TOKEN'\nurl = 'https://coins.ph/d/api/payout-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)"}]},"method":"get","auth":"required","params":[{"_id":"55430c88795b590d001dc847","ref":"","in":"query","required":false,"desc":"Filter to only the categories with outlets based on the given region.","default":"","type":"string","name":"region"},{"_id":"55430c88795b590d001dc846","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":"57972534acc0bb0e00333599","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/payout-outlet-categories/:id/"},"isReference":false,"order":1,"body":"Payout outlets are grouped into categories. Categories determine the required fields that payout outlets accept. The data gathered from these fields are used to process the payout. \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 payout-outlet-categories","slug":"payout-outlet-categories","type":"endpoint","title":"payout-outlet-categories"}

getpayout-outlet-categories

Retrieve supported payout-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

Payout outlets are grouped into categories. Categories determine the required fields that payout outlets accept. The data gathered from these fields are used to process the payout. ## 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.