{"_id":"56d942da6fcdd00b0002cad4","category":{"_id":"56d942ac337fd11300d6a251","__v":2,"pages":["56d942c607ae190b000044af","56d942da6fcdd00b0002cad4"],"project":"544fc17e698ab40800b4f891","version":"56326e9cdf556c0d00cd08ca","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-03-04T08:09:16.560Z","from_sync":false,"order":7,"slug":"payment-requests","title":"Payment Requests"},"editedParams2":true,"project":"544fc17e698ab40800b4f891","user":"544fc065698ab40800b4f888","editedParams":true,"parentDoc":null,"__v":1,"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"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-03-04T08:10:02.432Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{\n    \"payment-request\": {\n        \"id\": \"5edc263fac7f4f61b87632cb5710050f\",\n        \"invoice\": \"5713e3ab76e74e6b85194deaf0f14cel\",\n        \"payer_contact_info\": \"example:::at:::example.com\",\n        \"payer_contact_info_type\": \"email\",\n        \"payer_email\": \"example@example.com\",\n        \"amount\": \"20.00000000\",\n        \"currency\": \"PHP\",\n        \"message\": \"Thanks for all the fish!\",\n        \"message_scope\": \"private\",\n        \"status\": \"pending\",\n        \"receiving_account\": \"5411c4604c9b45b8b74837c84daa0f4c\",\n        \"payment_url\": \"https://coins.ph/payment/request/5edc263fac7f4f61b87632cb5710050f\",\n        \"created_at\": \"2016-03-04T07:12:00.352338Z\",\n        \"updated_at\": \"2016-03-04T07:12:00.474500Z\",\n        \"expires_at\":\"2017-03-04T07:11:59.942484Z\"\n    }\n}\n\n","language":"json","status":200}]},"settings":"","examples":{"codes":[{"language":"python","code":"import requests\n\nurl = \"https://coins.ph/api/v3/payment-requests/5edc263fac7f4f61b87632cb5710050f/\"\n\nTOKEN = 'YOUR TOKEN'\nheaders = {\n    'Authorization': 'Bearer {}'.format(TOKEN),\n    'Content-Type': 'application/json;charset=UTF-8',\n    'Accept': 'application/json'\n}\n\nresponse = requests.get(url, headers=headers)\n\nprint(response.text)"},{"code":"curl -X GET \\\n\t-H \"Authorization: Bearer YOUR_TOKEN\" \\\n  -H \"Content-Type: application/json;charset=UTF-8\" \\\n  -H \"Accept: application/json\" \\\n  \"https://coins.ph/api/v3/payment-requests/5eec262fac6f4f61b89932cb5610050e\"","language":"curl"},{"code":"require 'uri'\nrequire 'json'\nrequire 'net/http'\n\nurl = URI('https://coins.ph/api/v3/payment-requests/5edc263fac7f4f61b87632cb5710050f/')\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url.request_uri)\nrequest[\"content-type\"] = 'application/json'\nrequest[\"authorization\"] = 'Bearer YOUR_BEARER_TOKEN'\n\nresponse = http.request(request)\nputs response.read_body","language":"ruby"}]},"method":"get","auth":"required","params":[{"_id":"56d94c3b337fd11300d6a262","ref":"","in":"query","required":false,"desc":"Optional. Filter results by status - `pending`, `fulfilled`, or `expired`.","default":"","type":"string","name":"status"},{"_id":"56d94c3b337fd11300d6a261","ref":"","in":"path","required":false,"desc":"Optional. ID of the target payment request to retrieve. If not provided, a paginated list of payment requests will be returned.","default":"","type":"string","name":"id"}],"url":"/api/v3/payment-requests/:id"},"isReference":false,"order":2,"body":"# Try it out real quick\n\nObtain an [OAuth2](doc:oauth) token and then replace `YOUR_TOKEN` in the following example.\n\n```curl\ncurl -X POST \\\n  -H \"Authorization: Bearer YOUR_TOKEN\" \\\n  -H \"Content-Type: application/json;charset=UTF-8\" \\\n  -H \"Accept: application/json\" \\ \n  \"https://coins.ph/api/v3/payment-requests/\"\n```\n\n# Payment Requests\n\nA Payment Request is an attempt of a particular payee to ask for funds from another person. The payer need not be an existing coins user. To request for payment, the payee only needs to know at least one of the payor's details:\n\n* phone number\n* email address\n\nA successful payment request will send a notification through email or phone number, with a link where the payer may select a payment option. The payer could then select one of the currently available payment options. All options available to non-coins users are also available for current coins users.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/VWUDrMXSM2Uh7faSVAIw_Screen_Shot_2016-03-13_at_2_37_52_PM.jpg\",\n        \"Screen_Shot_2016-03-13_at_2_37_52_PM.jpg\",\n        \"906\",\n        \"1800\",\n        \"#2f90d0\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n## Coins Account\n\nCoins users can select this option to use one of their wallets to pay for the payment request. Funds will be transferred from the payers selected wallet to the payee's account.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/VjjLOWejQgeQvG9lZ9lh_Screen%20Shot%202016-03-13%20at%202.55.25%20PM.png\",\n        \"Screen Shot 2016-03-13 at 2.55.25 PM.png\",\n        \"844\",\n        \"1048\",\n        \"#2b8ce3\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n## BDO Deposit\n\nPayers may choose this option to pay for the payment request by depositing funds on a BDO outlet. A reference number will be generated for the payment request, which should be presented to a BDO teller. Funds will be released to the payee once a deposit to the specified reference number and bank account combination is made.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/csQdcbqlQrC5WK6NrjZB_bdo.jpg\",\n        \"bdo.jpg\",\n        \"842\",\n        \"1154\",\n        \"#bf6e6b\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n## 7-Eleven Deposit\n\nPayers may choose this option to pay for the payment request by depositing funds through a 7-Eleven store. A 7-Connect reference number will be generated, along with a barcode which a payer could present to the store clerk for scanning.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/aeWQhZfGQm6acDGJdxc0_Screen%20Shot%202016-03-13%20at%202.47.28%20PM.png\",\n        \"Screen Shot 2016-03-13 at 2.47.28 PM.png\",\n        \"844\",\n        \"1314\",\n        \"#407bb7\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n## M Lhuillier\n\nPayers may choose this option to pay for the payment request by depositing funds through an MLhuillier outlet. An EPay transaction code will be generated for the payment request. Funds for the payment request will be transferred to the payee's account once payment has been made through the specified transaction code.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/THbKdSsKQB2YtpXXqL2S_mle.jpg\",\n        \"mle.jpg\",\n        \"844\",\n        \"942\",\n        \"#327ebe\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]","excerpt":"Retrieve an existing or a list of existing payment requests","slug":"payment-requests-1","type":"endpoint","title":"payment-requests"}

getpayment-requests

Retrieve an existing or a list of existing payment requests

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
string
Optional. ID of the target payment request to retrieve. If not provided, a paginated list of payment requests will be returned.

Query Params

status:
string
Optional. Filter results by status - `pending`, `fulfilled`, or `expired`.

Examples


Result Format


Documentation

# Try it out real quick Obtain an [OAuth2](doc:oauth) token and then replace `YOUR_TOKEN` in the following example. ```curl curl -X POST \ -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json;charset=UTF-8" \ -H "Accept: application/json" \ "https://coins.ph/api/v3/payment-requests/" ``` # Payment Requests A Payment Request is an attempt of a particular payee to ask for funds from another person. The payer need not be an existing coins user. To request for payment, the payee only needs to know at least one of the payor's details: * phone number * email address A successful payment request will send a notification through email or phone number, with a link where the payer may select a payment option. The payer could then select one of the currently available payment options. All options available to non-coins users are also available for current coins users. [block:image] { "images": [ { "image": [ "https://files.readme.io/VWUDrMXSM2Uh7faSVAIw_Screen_Shot_2016-03-13_at_2_37_52_PM.jpg", "Screen_Shot_2016-03-13_at_2_37_52_PM.jpg", "906", "1800", "#2f90d0", "" ] } ] } [/block] ## Coins Account Coins users can select this option to use one of their wallets to pay for the payment request. Funds will be transferred from the payers selected wallet to the payee's account. [block:image] { "images": [ { "image": [ "https://files.readme.io/VjjLOWejQgeQvG9lZ9lh_Screen%20Shot%202016-03-13%20at%202.55.25%20PM.png", "Screen Shot 2016-03-13 at 2.55.25 PM.png", "844", "1048", "#2b8ce3", "" ] } ] } [/block] ## BDO Deposit Payers may choose this option to pay for the payment request by depositing funds on a BDO outlet. A reference number will be generated for the payment request, which should be presented to a BDO teller. Funds will be released to the payee once a deposit to the specified reference number and bank account combination is made. [block:image] { "images": [ { "image": [ "https://files.readme.io/csQdcbqlQrC5WK6NrjZB_bdo.jpg", "bdo.jpg", "842", "1154", "#bf6e6b", "" ] } ] } [/block] ## 7-Eleven Deposit Payers may choose this option to pay for the payment request by depositing funds through a 7-Eleven store. A 7-Connect reference number will be generated, along with a barcode which a payer could present to the store clerk for scanning. [block:image] { "images": [ { "image": [ "https://files.readme.io/aeWQhZfGQm6acDGJdxc0_Screen%20Shot%202016-03-13%20at%202.47.28%20PM.png", "Screen Shot 2016-03-13 at 2.47.28 PM.png", "844", "1314", "#407bb7", "" ] } ] } [/block] ## M Lhuillier Payers may choose this option to pay for the payment request by depositing funds through an MLhuillier outlet. An EPay transaction code will be generated for the payment request. Funds for the payment request will be transferred to the payee's account once payment has been made through the specified transaction code. [block:image] { "images": [ { "image": [ "https://files.readme.io/THbKdSsKQB2YtpXXqL2S_mle.jpg", "mle.jpg", "844", "942", "#327ebe", "" ] } ] } [/block]