get-private-templates-TEMPLATE_ID.rst (1525B)
1 .. http:get:: [/instances/$INSTANCE]/private/templates/$TEMPLATE_ID 2 3 This is used to obtain detailed information about a specific template. 4 5 6 **Required permission:** ``templates-read`` 7 8 **Response:** 9 10 :http:statuscode:`200 OK`: 11 The backend has successfully returned the detailed information about a specific template. 12 Returns a `TemplateDetails`. 13 :http:statuscode:`404 Not found`: 14 The instance or template(ID) is unknown to the backend. 15 16 **Details:** 17 18 19 .. ts:def:: TemplateDetails 20 21 interface TemplateDetails { 22 23 // Human-readable description for the template. 24 template_description: string; 25 26 // OTP device ID. 27 // This parameter is optional. 28 otp_id?: string; 29 30 // Additional information in a separate template. 31 template_contract: TemplateContractDetails; 32 33 // Key-value pairs matching a subset of the 34 // fields from ``template_contract`` that are 35 // user-editable defaults for this template. 36 // Since protocol **v13**. 37 editable_defaults?: Object; 38 39 // Required currency for payments. Useful if no 40 // amount is specified in the ``template_contract`` 41 // but the user should be required to pay in a 42 // particular currency anyway. Merchant backends 43 // may reject requests if the ``template_contract`` 44 // or ``editable_defaults`` do 45 // specify an amount in a different currency. 46 // This parameter is optional. 47 // Since protocol **v13**. 48 required_currency?: string; 49 }