{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/apps/:id","auth":"required","settings":"","results":{"codes":[{"name":"","code":"{\n  \"id\": 1,\n  \"invoice_time\": 45,\n  \"title\": \"Updated Api App\",\n  \"invoice_head_title\": \"Updated Invoice Title\",\n  \"ip_whitelist\": [\n   \"192.0.2.2\",\n   \"192.0.2.3\"\n  ],\n  \"underpaid_cover_pct\": \"5.0\",\n}","language":"json","status":200}]},"params":[{"name":"title","type":"string","default":"","desc":"Name of the API App <br /> *Max 100 characters*","required":false,"in":"body","ref":"","_id":"5e7b80e8e6b1cc03caaf1f5f"},{"name":"invoice_time","type":"int","default":"20","desc":"Custom invoice expiration time in minutes. <br /> Possible values: 10, 15, 20, 30, 45, 60, 90, 120, 360, 720, 1440 <br /> **Please note** that longer than 20 minutes expiration time only works when the payment and receive currencies are the same. [Read more](https://blog.coingate.com/2017/09/bitcoin-merchant-extend-invoice-expiration-time/)","required":false,"in":"body","ref":"","_id":"622de842da1e4c0084160a17"},{"name":"underpaid_cover_pct","type":"float","default":"0","desc":"*Min: 0. Max: 10* <br /> This feature allows Merchants to accept orders that are underpaid up to a certain threshold [Read more](https://support.coingate.com/hc/en-us/articles/4402503049234-I-underpaid-my-invoice-What-should-I-do-)","required":false,"in":"body","ref":"","_id":"622de842da1e4c0084160a18"},{"name":"ip_whitelist","type":"array_string","default":"","desc":"IP address whitelist <br /> Leave empty to allow all ip addresses","required":false,"in":"body","ref":"","_id":"622df0629fa9fb001405485c"},{"name":"ID","type":"int","default":"","desc":"Application ID assigned by CoinGate","required":true,"in":"path","ref":"","_id":"622df21a325dbc001a080bfd"},{"name":"invoice_head_title","type":"string","default":"","desc":"By default, your legal business name is displayed on the invoice. Use this setting to display your brand name.","required":false,"in":"body","ref":"","_id":"6238816a70de7602d22db01c"}],"examples":{"codes":[{"code":"curl --location --request PATCH 'https://sandbox.coingate.com/api/v2/apps/1' \\\n--header 'Authorization: Bearer YOUR_TOKEN_GOES_HERE' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n    \"invoice_time\": 30,\n    \"title\": \"Updated Api App\",\n    \"invoice_head_title\": \"Updated Invoice Title\",\n    \"ip_whitelist\": [\n        \"192.0.2.2\",\n        \"192.0.2.3\"\n    ],\n    \"underpaid_cover_pct\": 5\n}'","language":"curl"}]},"method":"patch"},"next":{"description":"","pages":[]},"title":"Edit application","type":"endpoint","slug":"edit-application","excerpt":"Creates an API application","body":"","updates":[],"order":3,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"622df21a325dbc001a080bf8","createdAt":"2022-03-13T13:31:06.170Z","user":"62287af96af2050073e4f9ac","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"API Applications","slug":"apps","order":6,"from_sync":false,"reference":false,"_id":"62289a8cb831c9003650b36c","createdAt":"2022-03-09T12:16:12.911Z","version":"5adcc1185cd1890003da8165","project":"5530bfac57cea10d00a3aa3b","__v":0},"version":{"version":"2","version_clean":"2.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5adcc1185cd1890003da8166","5adcc1185cd1890003da8167","5adcf4b3ce4b3f00035317e9","5adfb8e9452bd900036d115b","5e7b51281ac49702d745882c","5e7b526560c6cc004f25ca3e","61c47c8dc69d6b000f961812","62289a8cb831c9003650b36c","62615ded4828c0003015b8a2","627511250a8fbb052a794d80"],"_id":"5adcc1185cd1890003da8165","project":"5530bfac57cea10d00a3aa3b","createdAt":"2018-04-22T17:06:32.152Z","releaseDate":"2018-04-22T17:06:32.152Z","__v":9},"project":"5530bfac57cea10d00a3aa3b","__v":10,"parentDoc":null}

patchEdit application

Creates an API application

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

ID:
required
integer
Application ID assigned by CoinGate

Body Params

title:
string
Name of the API App <br /> *Max 100 characters*
invoice_time:
integer20
Custom invoice expiration time in minutes. <br /> Possible values: 10, 15, 20, 30, 45, 60, 90, 120, 360, 720, 1440 <br /> **Please note** that longer than 20 minutes expiration time only works when the payment and receive currencies are the same. [Read more](https://blog.coingate.com/2017/09/bitcoin-merchant-extend-invoice-expiration-time/)
underpaid_cover_pct:
float0
*Min: 0. Max: 10* <br /> This feature allows Merchants to accept orders that are underpaid up to a certain threshold [Read more](https://support.coingate.com/hc/en-us/articles/4402503049234-I-underpaid-my-invoice-What-should-I-do-)
ip_whitelist:
array of strings
IP address whitelist <br /> Leave empty to allow all ip addresses
invoice_head_title:
string
By default, your legal business name is displayed on the invoice. Use this setting to display your brand name.

Examples


Result Format