PRODUCTS
...
categorized_savings_l3
Plain CPF
V1
2min
JSON
1{
2 "code": 200,
3 "message": "OK",
4 "requestId": "112334",
5 "productName": "pf_categorized_savings_l3",
6 "productVersion": "V1",
7 "productReportId": "4b2c1648-231f-11eb-97c4-f45c899f4587",
8 "productReportTime": "2019-12-23T06:10:43",
9 "enquiryCpf":"12345678909",
10 "links": [
11 {
12 "linkId": "gPuKXrCJU05J4k",
13 "institutionCode": "033",
14 "consents": [
15 {
16 "consentId": "f55c899f-11eb-231f-97c4-4b2c16484587",
17 "permissions": {
18 "REGISTRATION_ALL": {
19 "permissionsGranted": true,
20 "accountIds": [
21 "123456"
22 ]
23 }
24 }
25 }
26 ]
27 }
28 ],
29 "savingsAccounts": [
30 {
31 "brandName": "Organização A",
32 "bacenName": "Organização A",
33 "compeCode": "001",
34 "companyCnpj":"50685362006773",
35 "branchCode": "6272",
36 "number": "94088392",
37 "checkDigit": "4",
38 "subtype": "INDIVIDUAL",
39 "civilName": "Mike",
40 "balances": {
41 "availableAmount": {
42 "amount": "1000.0400",
43 "currency": "BRL"
44 },
45 "blockedAmount": {
46 "amount": "1000.0400",
47 "currency": "BRL"
48 },
49 "automaticallyInvestedAmount": {
50 "amount": "1000.0400",
51 "currency": "BRL"
52 }
53 },
54 "transactionDetails": [
55 {
56 "transactionDate": "2021-01-07",
57 "transactionDateTime": "2016-01-29T12:29:03.374Z",
58 "transactionId": "TXpRMU9UQTROMWhZV2xSU1FUazJSMDl",
59 "completedAuthorisedPaymentType": "TRANSACAO_EFETIVADA",
60 "creditDebitType": "DEBITO",
61 "transactionAmount": {
62 "amount": "1000.0400",
63 "currency": "BRL"
64 },
65 "transactionName": "TRANSFCWAR5TXHCX5I9IDBHML8082N8NEO30M6LNNG7ANAYIJYRM00ZBZPU8",
66 "partieCnpjCpf": "12345678909",
67 "partiePersonType": "PESSOA_NATURAL",
68 "partieCompeCode": "001",
69 "partieBranchCode": "6272",
70 "partieNumber": "67890854360",
71 "partieCheckDigit": "4",
72 "postTransactionBalance": "100.00",
73 "type": "PIX",
74 "category": "Renda",
75 "subcategory": "Renda ativa",
76 "thirdCategory": "Salário",
77 "fAll": 1,
78 "fAllMonth": 0,
79 "fAllCMonth": 1,
80 "settlementType": "PIX"
81 }
82 ]
83 }
84 ],
85 "externalInfo": {
86 "myTraceId": "yourtraceid-1",
87 "myUUID": "youruuid-1"
88 }
89}
Just add category , subcategory , thirdCategory, fAll, fAllMonth, fAllCmonth, settlementType key in transactions array key base on V1.
The JSON scheme is similar to the pf_categorized_checking_l3, and the productName key is pj_categorized_savings_l3.
JSON
1{
2 "code": 200,
3 "message": "OK",
4 "requestId": "112334",
5 "productName": "pj_categorized_savings_l3",
6 "productVersion": "V1",
7 "productReportId": "4b2c1648-231f-11eb-97c4-f45c899f4587",
8 "productReportTime": "2019-12-23T06:10:43",
9 "enquiryCpf":"12345678909",
10 "links": [
11 {
12 "linkId": "gPuKXrCJU05J4k",
13 "institutionCode": "033",
14 "consents": [
15 {
16 "consentId": "f55c899f-11eb-231f-97c4-4b2c16484587",
17 "permissions": {
18 "REGISTRATION_ALL": {
19 "permissionsGranted": true,
20 "accountIds": [
21 "123456"
22 ]
23 }
24 }
25 }
26 ]
27 }
28 ],
29 "savingsAccounts": [
30 {
31 "brandName": "Organização A",
32 "bacenName": "Organização A",
33 "compeCode": "001",
34 "companyCnpj":"50685362006773",
35 "branchCode": "6272",
36 "number": "94088392",
37 "checkDigit": "4",
38 "companyName": "Luiza e Benjamin Assessoria Jurídica Ltda",
39 "tradeName": "Mundo da Eletronica",
40 "cnpjNumber":"50685362006773",
41 "civilName": "Mike",
42 "balances": {
43 "availableAmount": {
44 "amount": "1000.0400",
45 "currency": "BRL"
46 },
47 "blockedAmount": {
48 "amount": "1000.0400",
49 "currency": "BRL"
50 },
51 "automaticallyInvestedAmount": {
52 "amount": "1000.0400",
53 "currency": "BRL"
54 }
55 },
56 "transactionDetails": [
57 {
58 "transactionDate": "2021-01-07",
59 "transactionDateTime": "2016-01-29T12:29:03.374Z",
60 "transactionId": "TXpRMU9UQTROMWhZV2xSU1FUazJSMDl",
61 "completedAuthorisedPaymentType": "TRANSACAO_EFETIVADA",
62 "creditDebitType": "DEBITO",
63 "transactionAmount": {
64 "amount": "1000.0400",
65 "currency": "BRL"
66 },
67 "transactionName": "TRANSFCWAR5TXHCX5I9IDBHML8082N8NEO30M6LNNG7ANAYIJYRM00ZBZPU8",
68 "partieCnpjCpf": "12345678909",
69 "partiePersonType": "PESSOA_NATURAL",
70 "partieCompeCode": "001",
71 "partieBranchCode": "6272",
72 "partieNumber": "67890854360",
73 "partieCheckDigit": "4",
74 "postTransactionBalance": "100.00",
75 "type": "PIX",
76 "category": "Renda",
77 "subcategory": "Renda ativa",
78 "thirdCategory": "Salário",
79 "fAll": 1,
80 "fAllMonth": 0,
81 "fAllCMonth": 1,
82 "settlementType": "PIX"
83 }
84 ]
85 }
86 ],
87 "externalInfo": {
88 "myTraceId": "yourtraceid-1",
89 "myUUID": "youruuid-1"
90 }
91}
For detailed schemes in the product, please refer to the official documentation of Open Finance Brazil.
Updated 11 Oct 2024
Did this page help you?