PRODUCTS
...
balance
CPF encoded
V1.1
2min
pf_balance
JSON
1{
2 "code": 200,
3 "message": "OK",
4 "requestId": "112334",
5 "productName": "pf_balance",
6 "productVersion": "V1.1",
7 "productReportId": "4b2c1648-231f-11eb-97c4-f45c899f4587",
8 "productReportTime": "2019-12-23T06:10:43",
9 "enquiryCpf":"cly0AXWVPlVJMk-3P1qFQ5i3UgY-t0mIkn3xNPAWxW4DusQWC6wKP6WKTKunzSqy2oVpKd2p7_liKxGXpV7wQ3a62M4g",
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 "accounts": [
30 {
31 "brandName": "Organização A",
32 "bacenName": "Organização A",
33 "compeCode": "001",
34 "companyCnpj": "21128159000166",
35 "branchCode": "6272",
36 "number": "94088392",
37 "checkDigit": "4",
38 "type": "CONTA_DEPOSITO_A_VISTA",
39 "subtype": "INDIVIDUAL",
40 "civilName": "Mike",
41 "balances": {
42 "availableAmount": {
43 "amount": "1000.0400",
44 "currency": "BRL"
45 },
46 "blockedAmount": {
47 "amount": "1000.0400",
48 "currency": "BRL"
49 },
50 "automaticallyInvestedAmount": {
51 "amount": "1000.0400",
52 "currency": "BRL"
53 }
54 }
55 }
56 ],
57 "externalInfo": {
58 "myTraceId": "yourtraceid-1",
59 "myUUID": "youruuid-1"
60 }
61}
pj_balance
The JSON scheme is similar to the pf_balance, and the productName key is pj_balance.
JSON
1{
2 "code": 200,
3 "message": "OK",
4 "requestId": "112334",
5 "productName": "pj_balance",
6 "productVersion": "V1.1",
7 "productReportId": "4b2c1648-231f-11eb-97c4-f45c899f4587",
8 "productReportTime": "2019-12-23T06:10:43",
9 "enquiryCpf":"cly0AXWVPlVJMk-3P1qFQ5i3UgY-t0mIkn3xNPAWxW4DusQWC6wKP6WKTKunzSqy2oVpKd2p7_liKxGXpV7wQ3a62M4g",
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 "accounts": [
30 {
31 "brandName": "Organização A",
32 "bacenName": "Organização A",
33 "compeCode": "001",
34 "companyCnpj": "21128159000166",
35 "branchCode": "6272",
36 "number": "94088392",
37 "checkDigit": "4",
38 "type": "CONTA_DEPOSITO_A_VISTA",
39 "companyName": "Luiza e Benjamin Assessoria Jurídica Ltda",
40 "tradeName": "Mundo da Eletronica",
41 "cnpjNumber":"50685362006773",
42 "civilName": "Mike",
43 "balances": {
44 "availableAmount": {
45 "amount": "1000.0400",
46 "currency": "BRL"
47 },
48 "blockedAmount": {
49 "amount": "1000.0400",
50 "currency": "BRL"
51 },
52 "automaticallyInvestedAmount": {
53 "amount": "1000.0400",
54 "currency": "BRL"
55 }
56 }
57 }
58 ],
59 "externalInfo": {
60 "myTraceId": "yourtraceid-1",
61 "myUUID": "youruuid-1"
62 }
63}
For detailed schemes in the product, please refer to the official documentation of Open Finance Brazil.
