Token
Read Token
Available Date
1 min
{ "name" "available date", "method" "post", "url" "your endpoint here", "description" "", "tab" "examples", "examples" { "languages" \[ { "id" "llcehlhydhsjlpiph q6b", "language" "json", "code" "{\n \\"share public\\" \\"string\\",\n \\"read event\\" \\"string\\",\n \\"source id\\" \\"string\\",\n \\"destination id\\" \\"string\\",\n \\"token id\\" \\"integer\\",\n \\"available date\\" \\"string\\",\n \\"expiry date\\" \\"string\\",\n \\"tokes status\\" \\"string\\"\n}", "customlabel" "" }, { "id" "0sszizc trftve4yp4rv ", "language" "curl", "code" "curl location request post '' \\\\\n header 'accept application/json' \\\\\n header 'content type application/json' \\\\\n data raw '{\\"share public\\" \\"string\\",\\"read event\\" \\"string\\",\\"source id\\" \\"string\\",\\"destination id\\" \\"string\\",\\"token id\\" \\"integer\\",\\"available date\\" \\"string\\",\\"expiry date\\" \\"string\\",\\"tokes status\\" \\"string\\"}'", "customlabel" "" }, { "id" "fxarbwiasg7b2mtv7l pc", "language" "nodejs", "code" "var request = require('request');\nvar options = {\n 'method' 'post',\n 'url' '',\n 'headers' {\n 'accept' 'application/json',\n 'content type' 'application/json'\n },\n body json stringify({\n \\"share public\\" \\"string\\",\n \\"read event\\" \\"string\\",\n \\"source id\\" \\"string\\",\n \\"destination id\\" \\"string\\",\n \\"token id\\" \\"integer\\",\n \\"available date\\" \\"string\\",\n \\"expiry date\\" \\"string\\",\n \\"tokes status\\" \\"string\\"\n })\n\n};\nrequest(options, function (error, response) {\n if (error) throw new error(error);\n console log(response body);\n});\n", "customlabel" "" }, { "id" "giql85 7zzrbcbxpy6v2w", "language" "javascript", "code" "var myheaders = new headers();\nmyheaders append(\\"accept\\", \\"application/json\\");\nmyheaders append(\\"content type\\", \\"application/json\\");\n\nvar raw = json stringify({\n \\"share public\\" \\"string\\",\n \\"read event\\" \\"string\\",\n \\"source id\\" \\"string\\",\n \\"destination id\\" \\"string\\",\n \\"token id\\" \\"integer\\",\n \\"available date\\" \\"string\\",\n \\"expiry date\\" \\"string\\",\n \\"tokes status\\" \\"string\\"\n});\n\nvar requestoptions = {\n method 'post',\n headers myheaders,\n body raw,\n redirect 'follow'\n};\n\nfetch(\\"\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "customlabel" "" }, { "id" "h6zsmfc03z1 y xndvpqb", "language" "python", "code" "import requests\nimport json\n\nurl = \\"\\"\n\npayload = json dumps({\n \\"share public\\" \\"string\\",\n \\"read event\\" \\"string\\",\n \\"source id\\" \\"string\\",\n \\"destination id\\" \\"string\\",\n \\"token id\\" \\"integer\\",\n \\"available date\\" \\"string\\",\n \\"expiry date\\" \\"string\\",\n \\"tokes status\\" \\"string\\"\n})\nheaders = {\n 'accept' 'application/json',\n 'content type' 'application/json'\n}\n\nresponse = requests request(\\"post\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "customlabel" "" }, { "id" "79spi2bjnjfbsgidmsatt", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"json\\"\nrequire \\"net/http\"\n\nurl = uri(\\"\\")\n\nhttp = net http new(url host, url port);\nrequest = net http post new(url)\nrequest\[\\"accept\\"] = \\"application/json\\"\nrequest\[\\"content type\\"] = \\"application/json\\"\nrequest body = json dump({\n \\"share public\\" \\"string\\",\n \\"read event\\" \\"string\\",\n \\"source id\\" \\"string\\",\n \\"destination id\\" \\"string\\",\n \\"token id\\" \\"integer\\",\n \\"available date\\" \\"string\\",\n \\"expiry date\\" \\"string\\",\n \\"tokes status\\" \\"string\\"\n})\n\nresponse = http request(request)\nputs response read body\n", "customlabel" "" } ], "selectedlanguageid" "llcehlhydhsjlpiph q6b" }, "results" { "languages" \[ { "id" "ewejijkriroiv8js6yotq", "language" "200", "customlabel" "", "code" "{\n \\"success\\" true,\n \\"message\\" \\"success\\",\n}\n" }, { "id" "qlqo vrbcz61pbaa4ap1q", "language" "413", "customlabel" "", "code" "{\n \\"success\\" \\"false\\",\n \\"errors\\" {\n \\"code\\" \\"413\\",\n \\"message\\" \\"destination id unknown\\"\n }\n}" }, { "id" "wde7ptazgxdvkol6xfggr", "language" "428", "code" "{\n \\"success\\" \\"false\\",\n \\"errors\\" {\n \\"code\\" \\"428\\",\n \\"message\\" \\"token id doesn't match\\"\n }\n}", "customlabel" "" }, { "id" "onfj0hwklrzbz08pxpi4r", "language" "500", "code" "{\n \\"success\\" \\"false\\",\n \\"errors\\" {\n \\"code\\" \\"500\\",\n \\"message\\" \\"internal server error\\"\n }\n}", "customlabel" "" }, { "id" "oeeyvffipybtwhk57zxn6", "language" "502", "code" "{\n \\"success\\" \\"false\\",\n \\"errors\\" {\n \\"code\\" \\"502\\",\n \\"message\\" \\"bad gateway\\"\n }\n}", "customlabel" "" }, { "id" "mjggbro2pi0voehhq gnb", "language" "503", "code" "{\n \\"success\\" \\"false\\",\n \\"errors\\" {\n \\"code\\" \\"503\\",\n \\"message\\" \\"service unavailable\\"\n }\n}", "customlabel" "" }, { "id" "rosgcowrecy0pxtuxpcd8", "language" "504", "code" "{\n \\"success\\" \\"false\\",\n \\"errors\\" {\n \\"code\\" \\"504\\",\n \\"message\\" \\"gateway timeout\\"\n }\n}", "customlabel" "" } ], "selectedlanguageid" "ewejijkriroiv8js6yotq" }, "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "name" "share public", "kind" "required", "type" "string", "description" "public keys are accessible in your paydocker account under integration menu ", "children" \[] }, { "name" "read event", "kind" "required", "type" "string", "description" "a condition to allow execution of the action that is connected to the token the condition would be \\"token available updated\\" \n\n", "children" \[] }, { "name" "source id", "kind" "required", "type" "string", "description" "your paydocker account id assigned upon account creation (e g pdr1) it is case sensitive ", "children" \[] }, { "name" "destination id", "kind" "required", "type" "string", "description" "property id (e g id 001) generated in your platform it represents the token recipient ", "children" \[] }, { "name" "token id", "kind" "required", "type" "integer", "description" "the unique identifier associated with the token that the user is requesting a modification for (e g 2908926013012565)", "children" \[] }, { "name" "available date", "kind" "optional", "type" "string", "description" "the date on which the token becomes active and ready for the recipient to collect \n\nthe format is dd mm yyyy, e g 25 12 2023\n\nselectable date range is 1 day before token creation day to up to 365 days in the future ", "children" \[] }, { "name" "expiry date", "kind" "optional", "type" "string", "description" "the date on which the token becomes invalid, after which it cannot be used or collected by the recipient \n\nthe format is dd mm yyyy, e g 25 12 2023\n\nselectable date range is same or greater than available date, essentially until the last day of the month one year after the chosen available date \n\ne g available date 18 oct 2023, expiry date 31 oct 2024 ", "children" \[] }, { "name" "tokes status", "kind" "optional", "type" "string", "description" "active, disputed, freezed or deleted (only one is applicable) it is case sensitive ", "children" \[] } ], "formdataparameters" \[] }, "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } }
