{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/api/v3/payment-requests/:id","auth":"required","apiSetting":"5d1d8bb82d46d1004a02581d","examples":{"codes":[{"language":"python","code":"import json\nimport requests\n\nurl = \"https://coins.ph/api/v3/payment-requests/\"\n\nTOKEN = 'YOUR TOKEN'\nheaders = {\n    'Authorization': 'Bearer {}'.format(TOKEN),\n    'Accept': 'application/json'\n}\n\nrequests.delete(url, headers=headers)\nprint(response.text)"}]},"results":{"codes":[{"status":200,"language":"json","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\": \"[email protected]\",\n        \"amount\": \"20.00000000\",\n        \"currency\": \"PHP\",\n        \"message\": \"Thanks for all the fish!\",\n        \"message_scope\": \"private\",\n        \"status\": \"canceled\",\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}","name":"Canceled"},{"status":200,"language":"json","code":"{\n    \"payment-request\": {\n        \"id\": \"5edc263fac7f4f61b87632cb5710050f\",\n        \"invoice\": \"5713e3ab76e74e6b85194deaf0f14cel\",\n        \"payer_contact_info\": \"[email protected]\",\n        \"payer_contact_info_type\": \"email\",\n        \"payer_email\": \"[email protected]\",\n        \"amount\": \"20.00000000\",\n        \"currency\": \"PHP\",\n        \"message\": \"Thanks for all the fish!\",\n        \"message_scope\": \"private\",\n        \"status\": \"declined\",\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}","name":"Declined"}]},"params":[{"name":"id","type":"string","default":"","desc":"ID of the payment request to cancel","required":false,"in":"path","ref":"","_id":"5d1d988499097801e262cc2b"}],"method":"delete","settings":""},"next":{"description":"","pages":[]},"title":"payment-requests","type":"endpoint","slug":"payment-requests-delete","excerpt":"Cancel or decline an existing payment request","body":"An owner of a payment request may opt to cancel their existing payment request. Similarly, a payer may decline a payment request sent to them. This endpoint automatically determines which party is executing the request, and sets the `status` of the payment request accordingly.","updates":[],"order":3,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5d1d988499097801e262cc2a","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.229Z","createdAt":"2019-07-04T06:11:16.726Z","project":"544fc17e698ab40800b4f891","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Payment Requests","slug":"payment-requests-1","order":10,"from_sync":false,"reference":true,"_id":"5d1d934ed377870191039d28","project":"544fc17e698ab40800b4f891","version":"56326e9cdf556c0d00cd08ca","isAPI":false,"createdAt":"2019-07-04T05:49:02.139Z","__v":0},"user":"5d19a189b4596f0072f571d4","__v":2,"parentDoc":null}

deletepayment-requests

Cancel or decline an existing payment request

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
string
ID of the payment request to cancel

Examples


Result Format


Documentation

An owner of a payment request may opt to cancel their existing payment request. Similarly, a payer may decline a payment request sent to them. This endpoint automatically determines which party is executing the request, and sets the `status` of the payment request accordingly.