Common Format

product common format the common format for each product is as follows name type description code number return code message string return message requestid string the unique representation identifier returned by the request report generation apis productname string product name(specific report) productversion string product version(the current default is v3) productreportid string product report identify productreporttime string product report time(utc timezone) enquirycpf string the cpf of the person who queries the data, due to its sensitive information docid 03tzs6yarf1o3teujfmtu , it has been encoded by aes links array the links is a array object that depends on whether your end user has multiple authorizations in the same insititution, or if different institution have authorizations product object the specific product data can be found in the open finance data and open data different products correspond to different key ( product ) externalinfo object the external parameters carried by creating links will be sent to you again in each report the common format example { "code" 200, "message" "ok", "requestid" "112334", "productname" "pf categorized checking l2", "productversion" "v1", "productreportid" "4b2c1648 231f 11eb 97c4 f45c899f4587", "productreporttime" "2019 12 23t06 10 43", "enquirycpf" "25872252137", "links" \[ "link and its corresponding consent list data will be here" ], "product" { "product data will be here, this example is pf categorized checking l2" }, "externalinfo" { "externalinfos list data will be here" } } the links array example \[ { "linkid" "gpukxrcju05j4k", "institutionid" "033", "consents" \[ { "consentid" "f55c899f 11eb 231f 97c4 4b2c16484587", "permissions" { "registration all" { "permisiongranted"\ true, "accountids" \[ "123456" ] } } }, { "consentid" "b45c899f 11eb 231f 97c4 4b2c16484589", "permissions" { "accounts all" { "permisiongranted"\ true, "accountids" \[ "234567" ] } } } ] }, { "linkid" "0pukxrcju05j4k", "institutionid" "031", "consents" \[ { "consentid" "f55c899f 11eb 231f 97c4 4b2c16484587", "permissions" { "credit cards all" { "permisiongranted"\ true, "accountids" \[ "123456" ] } } } ] } ] product reports are divided into institution level and user level institutional level product report by default, the shared data is obtained through the permissions in the most recent consent and a report is generated based on it; user level product report by default, the shared data is obtained through the most widely permission in consent( scope all consentid in multiple apps under the same partner), and a report is generated based on it; the above default rules do not include situations where you actively request specific linkid or consentid reports through apis the product object example the specific product data structure can be found in the open finance data and open data sections later in this section pf categorized checking l2 example \[ { "brandname" "organização a", "companycnpj" "21128159000166", "type" "conta deposito a vista", "compecode" "001", "branchcode" "6272", "number" "94088392", "checkdigit" "4", "civilname" "mike", "subtype" "individual", "currency" "brl", "balances" { "availableamount" { "amount" "1000 0400", "currency" "brl" }, "blockedamount" { "amount" "1000 0400", "currency" "brl" } }, "transactions" \[ { "transactionid" "txprmu9uqtromwhzv2xsu1fuazjsmdl", "completedauthorisedpaymenttype" "transacao efetivada", "creditdebittype" "debito", "transactionname" "transfcwar5txhcx5i9idbhml8082n8neo30m6lnng7anayijyrm00zbzpu8", "type" "pix", "transactionamount" { "amount" "1000 0400", "currency" "brl" }, "transactiondate" "2021 01 07", "transactiondatetime" "2016 01 29t12 29 03 374z", "partiecnpjcpf" "43908445778", "partiepersontype" "pessoa natural", "partiecompecode" "001", "partiebranchcode" "6272", "partienumber" "67890854360", "partiecheckdigit" "4", "posttransactionbalance" "10", "category" "renda", "subcategory" "renda ativa" } ] } ] in order to accurately express the meaning of different products, different product keys are different it is recommended to define different structures according to different products during the development process the externalinfo object example this object only exists in the case of a product webhooks docid\ qz1htubte2jspyqb0b82x if you request a report through the request product api, this object will not exist because in user level reports, the system update data based on the most extensive permissions consent, and it is no longer important which linkid created that permission you can associate through requestid { "mytraceid" "yourtraceid 1", "myuuid" "youruuid 1" } complete example { "code" 200, "message" "ok", "requestid" "112334", "productname" "pf categorized checking l2", "productversion" "v1", "productreportid" "4b2c1648 231f 11eb 97c4 f45c899f4587", "productreporttime" "2019 12 23t06 10 43", "enquirycpf" "25872252137", "links" \[ { "linkid" "gpukxrcju05j4k", "institutionid" "033", "consents" \[ { "consentid" "f55c899f 11eb 231f 97c4 4b2c16484587", "permissions" { "registration all" { "permisiongranted"\ true, "accountids" \[ "123456" ] } } }, { "consentid" "b45c899f 11eb 231f 97c4 4b2c16484589", "permissions" { "accounts all" { "permisiongranted"\ true, "accountids" \[ "234567" ] } } } ] }, { "linkid" "0pukxrcju05j4k", "institutionid" "031", "consents" \[ { "consentid" "f55c899f 11eb 231f 97c4 4b2c16484587", "permissions" { "credit cards all" { "permisiongranted"\ true, "accountids" \[ "123456" ] } } } ] } ], "product" { }, "externalinfo" { "mytraceid" "yourtraceid 1", "myuuid" "youruuid 1" } }