{"_id":"56326e9edf556c0d00cd08df","parentDoc":null,"project":"544fc17e698ab40800b4f891","user":"544fc065698ab40800b4f888","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"},"category":{"_id":"56326e9ddf556c0d00cd08cd","pages":["56326e9edf556c0d00cd08da","56326e9edf556c0d00cd08db","56326e9edf556c0d00cd08dc","56326e9edf556c0d00cd08dd","56326e9edf556c0d00cd08de","56326e9edf556c0d00cd08df","5632e61862c48a0d00334ddc","5637210ec75f5d0d00ec5d4a","563750380704070d00f06c4b","56ecf98c7f94882900591955"],"version":"56326e9cdf556c0d00cd08ca","__v":5,"project":"544fc17e698ab40800b4f891","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-05-01T09:13:02.297Z","from_sync":false,"order":2,"slug":"tutorials","title":"Tutorials"},"__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-05-16T06:35:31.432Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":5,"body":"The list of supported payout outlets, can be obtained through the [payout-outlets](doc:payout-outlet-categories) endpoint.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"import requests\\n\\nTOKEN = 'YOUR TOKEN'  #OAuth2\\nurl = 'https://coins.ph/d/api/payout-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)\",\n      \"language\": \"python\"\n    }\n  ]\n}\n[/block]\nAs an example, the response would look like this:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"meta\\\": {\\n        \\\"total_count\\\": 74,\\n        \\\"next_page\\\": 2,\\n        \\\"previous_page\\\": null\\n    },\\n    \\\"payout-outlets\\\": [\\n        {\\n            \\\"id\\\": \\\"egivecash\\\",\\n            \\\"outlet_category\\\": \\\"atm_pickup\\\",\\n            \\\"name\\\": \\\"Security Bank eGiveCash\\\",\\n            \\\"region\\\": \\\"PH\\\",\\n            \\\"help_text\\\": \\\"\\\",\\n            \\\"help_link\\\": \\\"\\\",\\n            \\\"instructions\\\": \\\"Cash-out from any ATM\\\"\\n        },\\n        {\\n            \\\"id\\\": \\\"bdo\\\",\\n            \\\"outlet_category\\\": \\\"bank\\\",\\n            \\\"name\\\": \\\"BDO\\\",\\n            \\\"region\\\": \\\"PH\\\",\\n            \\\"help_text\\\": \\\"\\\",\\n            \\\"help_link\\\": \\\"\\\",\\n            \\\"instructions\\\": \\\"Cash-out to your BDO account\\\"\\n        }\\n    ]\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\nOnce you have selected a payout outlet of your choice, you can retrieve its [category](doc:payout-outlet-categories-1) to get the list of required fields to fill up. For example, let's get `egivecash`'s category, `atm_pickup`:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"import requests\\n\\nTOKEN = 'YOUR TOKEN'  #OAuth2\\nurl = 'https://coins.ph/d/api/payout-outlet-categories/atm_pickup'\\n\\nheaders = {\\n    'Authorization': 'Bearer {}'.format(TOKEN),\\n    'Content-Type': 'application/json;charset=UTF-8',\\n    'Accept': 'application/json'\\n}\\n\\nrequests.get(url, headers=headers)\",\n      \"language\": \"python\"\n    }\n  ]\n}\n[/block]\nYou would then get a response that looks like this:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"payout-outlet-category\\\": {\\n         \\\"id\\\": \\\"atm_pickup\\\",\\n         \\\"name\\\": \\\"ATM Pickup\\\",\\n         \\\"fields\\\": [\\n             {\\n                 \\\"payment_outlet_type_field_id\\\": \\\"recipient_full_name\\\",\\n                 \\\"name\\\": \\\"Recipient Full Name\\\",\\n                 \\\"help_text\\\": \\\"Recipient Full Name\\\",\\n                 \\\"help_link\\\": \\\"\\\"\\n             },\\n             {\\n                 \\\"payment_outlet_type_field_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\\\": \\\"No fees\\\",\\n         \\\"payout_duration\\\": \\\"Same day payout\\\",\\n         \\\"outlet_names_subset\\\": [\\n             \\\"EGiveCash\\\"\\n         ]\\n    }\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\nThis means that to [cash out](doc:cash-out-from-anywhere-in-the-world) using the `egivecash` payout outlet, the sender will have to provide a `recipient_full_name` and a `recipient_mobile`.\n\nThe same flow is used for cash ins with [payin-outlets](doc:payin-outlets) and [payin-outlet-categories](doc:payin-outlet-categories) as the endpoints.","excerpt":"","slug":"getting-the-supported-payment-outlets","type":"basic","title":"List payment outlets"}

List payment outlets


The list of supported payout outlets, can be obtained through the [payout-outlets](doc:payout-outlet-categories) endpoint. [block:code] { "codes": [ { "code": "import requests\n\nTOKEN = 'YOUR TOKEN' #OAuth2\nurl = 'https://coins.ph/d/api/payout-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": "python" } ] } [/block] As an example, the response would look like this: [block:code] { "codes": [ { "code": "{\n \"meta\": {\n \"total_count\": 74,\n \"next_page\": 2,\n \"previous_page\": null\n },\n \"payout-outlets\": [\n {\n \"id\": \"egivecash\",\n \"outlet_category\": \"atm_pickup\",\n \"name\": \"Security Bank eGiveCash\",\n \"region\": \"PH\",\n \"help_text\": \"\",\n \"help_link\": \"\",\n \"instructions\": \"Cash-out from any ATM\"\n },\n {\n \"id\": \"bdo\",\n \"outlet_category\": \"bank\",\n \"name\": \"BDO\",\n \"region\": \"PH\",\n \"help_text\": \"\",\n \"help_link\": \"\",\n \"instructions\": \"Cash-out to your BDO account\"\n }\n ]\n}", "language": "json" } ] } [/block] Once you have selected a payout outlet of your choice, you can retrieve its [category](doc:payout-outlet-categories-1) to get the list of required fields to fill up. For example, let's get `egivecash`'s category, `atm_pickup`: [block:code] { "codes": [ { "code": "import requests\n\nTOKEN = 'YOUR TOKEN' #OAuth2\nurl = 'https://coins.ph/d/api/payout-outlet-categories/atm_pickup'\n\nheaders = {\n 'Authorization': 'Bearer {}'.format(TOKEN),\n 'Content-Type': 'application/json;charset=UTF-8',\n 'Accept': 'application/json'\n}\n\nrequests.get(url, headers=headers)", "language": "python" } ] } [/block] You would then get a response that looks like this: [block:code] { "codes": [ { "code": "{\n \"payout-outlet-category\": {\n \"id\": \"atm_pickup\",\n \"name\": \"ATM Pickup\",\n \"fields\": [\n {\n \"payment_outlet_type_field_id\": \"recipient_full_name\",\n \"name\": \"Recipient Full Name\",\n \"help_text\": \"Recipient Full Name\",\n \"help_link\": \"\"\n },\n {\n \"payment_outlet_type_field_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\": \"No fees\",\n \"payout_duration\": \"Same day payout\",\n \"outlet_names_subset\": [\n \"EGiveCash\"\n ]\n }\n}", "language": "json" } ] } [/block] This means that to [cash out](doc:cash-out-from-anywhere-in-the-world) using the `egivecash` payout outlet, the sender will have to provide a `recipient_full_name` and a `recipient_mobile`. The same flow is used for cash ins with [payin-outlets](doc:payin-outlets) and [payin-outlet-categories](doc:payin-outlet-categories) as the endpoints.