PRODUCTS
...
categorized_creditcard_l3
CPF encoded
V1.1
2min
JSON
1{
2 "code": 200,
3 "message": "OK",
4 "requestId": "112334",
5 "productName": "pf_categorized_creditcard_l3",
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 "creditCards": [
30 {
31 "brandName": "Organização A",
32 "bacenName": "Organização A",
33 "companyCnpj": "21128159000166",
34 "civilName": "Mike",
35 "name": "Cartão Universitário",
36 "productType": "OUTROS",
37 "creditCardNetwork": "VISA",
38 "paymentMethods": [
39 {
40 "identificationNumber": "4453",
41 "isMultipleCreditCard": true
42 }
43 ],
44 "isActive": true,
45 "limits": {
46 "isLimitFlexible": true,
47 "limitAmount": {
48 "amount": "1000.0400",
49 "currency": "BRL",
50 "limitAmountReason": ""
51 },
52 "usedAmount": {
53 "amount": "1000.0400",
54 "currency": "BRL"
55 },
56 "availableAmount": {
57 "amount": "1000.0400",
58 "currency": "BRL"
59 }
60 },
61 "openStatement":
62 {
63 "billMonth": "2021-05",
64 "billingDate": "2021-05-10",
65 "dueDate": "2021-05-21",
66 "billTotalAmount": {
67 "amount": "1000.0400",
68 "currency": "BRL"
69 },
70 "transactionDetails": [
71 {
72 "transactionDate": "2021-05-01",
73 "transactionDateTime": "2016-01-29T12:29:03.374Z",
74 "brazilianAmount": {
75 "amount": "1000.0400",
76 "currency": "BRL"
77 },
78 "transactionName": "PGTO",
79 "identificationNumber": "4453",
80 "transactionId": "TXpRMU9UQTROMWhZV2xSU1FUazJSMDl",
81 "transactionType": "CASHBACK",
82 "billPostDate": "2021-05-01",
83 "creditDebitType": "DEBITO",
84 "feeType": "ANUIDADE",
85 "otherCreditsType": "",
86 "payeeMCC": 5137,
87 "paymentType": "A_VISTA",
88 "chargeIdentificator": "12",
89 "chargeNumber": 12,
90 "category": "Renda",
91 "subcategory": "Renda ativa",
92 "thirdCategory": "Salário",
93 "fAll": 1,
94 "fAllMonth": 0,
95 "fAllCMonth": 1,
96 "brand": "Netflix", }
97 ]
98 },
99 "closedStatements": [
100 {
101 "billMonth": "2021-04",
102 "billingDate": "2021-04-10",
103 "dueDate": "2021-04-21",
104 "billMinimumAmount": {
105 "amount": "1000.0400",
106 "currency": "BRL"
107 },
108 "billTotalAmount": {
109 "amount": "1000.0400",
110 "currency": "BRL"
111 },
112 "billPayments": [
113 {
114 "amount": "1000.0400",
115 "currency": "BRL",
116 "paymentDate": "2021-04-01",
117 "valueType": "VALOR_PAGAMENTO_FATURA_PARCELADO",
118 "paymentMode": "DEBITO_CONTA_CORRENTE"
119 }
120 ],
121 "transactionDetails": [
122 {
123 "transactionDate": "2021-04-01",
124 "transactionDateTime": "2016-01-29T12:29:03.374Z",
125 "brazilianAmount": {
126 "amount": "1000.0400",
127 "currency": "BRL"
128 },
129 "transactionName": "PGTO",
130 "identificationNumber": "4453",
131 "transactionId": "TXpRMU9UQTROMWhZV2xSU1FUazJSMDl",
132 "transactionType": "CASHBACK",
133 "billPostDate": "2021-04-01",
134 "creditDebitType": "DEBITO",
135 "feeType": "ANUIDADE",
136 "otherCreditsType": "",
137 "payeeMCC": 5137,
138 "paymentType": "A_VISTA",
139 "chargeIdentificator": "12",
140 "chargeNumber": 12,
141 "category": "Renda",
142 "subcategory": "Renda ativa",
143 "thirdCategory": "Salário",
144 "fAll": 1,
145 "fAllMonth": 0,
146 "fAllCMonth": 1,
147 "brand": "Netflix", }
148 ]
149 }
150 ]
151 }
152 ],
153 "externalInfo": {
154 "myTraceId": "yourtraceid-1",
155 "myUUID": "youruuid-1"
156 }
157}
Just add category , subcategory , thirdCategory , fAll , fAllMonth and fAllCMonth key in transactions array key base on V1.
The JSON scheme is similar to the pf_categorized_creditcard_l3, and the productName key is pj_categorized_creditcard_l3.
JSON
1{
2 "code": 200,
3 "message": "OK",
4 "requestId": "112334",
5 "productName": "pj_categorized_creditcard_l3",
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 "creditCards": [
30 {
31 "brandName": "Organização A",
32 "bacenName": "Organização A",
33 "companyCnpj": "21128159000166",
34 "companyName":"Luiza e Benjamin Assessoria Jurídica Ltda",
35 "tradeName":"Mundo da Eletronica",
36 "cnpjNumber":"50685362006773",
37 "civilName": "Mike",
38 "name": "Cartão Universitário",
39 "productType": "OUTROS",
40 "creditCardNetwork": "VISA",
41 "paymentMethod": [
42 {
43 "identificationNumber": "4453",
44 "isMultipleCreditCard": true
45 }
46 ],
47 "isActive": true,
48 "limits": {
49 "isLimitFlexible": true,
50 "limitAmount": {
51 "amount": "1000.0400",
52 "currency": "BRL",
53 "limitAmountReason": ""
54 },
55 "usedAmount": {
56 "amount": "1000.0400",
57 "currency": "BRL"
58 },
59 "availableAmount": {
60 "amount": "1000.0400",
61 "currency": "BRL"
62 }
63 },
64 "openStatement":
65 {
66 "billMonth": "2021-05",
67 "billingDate": "2021-05-10",
68 "dueDate": "2021-05-21",
69 "billTotalAmount": {
70 "amount": "1000.0400",
71 "currency": "BRL"
72 },
73 "transactionDetails": [
74 {
75 "transactionDate": "2021-05-01",
76 "transactionDateTime": "2016-01-29T12:29:03.374Z",
77 "brazilianAmount": {
78 "amount": "1000.0400",
79 "currency": "BRL"
80 },
81 "transactionName": "PGTO",
82 "identificationNumber": "4453",
83 "transactionId": "TXpRMU9UQTROMWhZV2xSU1FUazJSMDl",
84 "transactionType": "CASHBACK",
85 "billPostDate": "2021-05-01",
86 "creditDebitType": "DEBITO",
87 "feeType": "ANUIDADE",
88 "otherCreditsType": "",
89 "payeeMCC": 5137,
90 "paymentType": "A_VISTA",
91 "chargeIdentificator": "12",
92 "chargeNumber": 12,
93 "category": "Renda",
94 "subcategory": "Renda ativa",
95 "thirdCategory": "Salário",
96 "fAll": 1,
97 "fAllMonth": 0,
98 "fAllCMonth": 1,
99 "brand": "Netflix", }
100 ]
101 }
102 ,
103 "closedStatements": [
104 {
105 "billMonth": "2021-04",
106 "billingDate": "2021-04-10",
107 "dueDate": "2021-04-21",
108 "billMinimumAmount": {
109 "amount": "1000.0400",
110 "currency": "BRL"
111 },
112 "billTotalAmount": {
113 "amount": "1000.0400",
114 "currency": "BRL"
115 },
116 "billPayments": [
117 {
118 "amount": "1000.0400",
119 "currency": "BRL",
120 "paymentDate": "2021-04-01",
121 "valueType": "VALOR_PAGAMENTO_FATURA_PARCELADO",
122 "paymentMode": "DEBITO_CONTA_CORRENTE"
123 }
124 ],
125 "transactionDetails": [
126 {
127 "transactionDate": "2021-04-01",
128 "transactionDateTime": "2016-01-29T12:29:03.374Z",
129 "brazilianAmount": {
130 "amount": "1000.0400",
131 "currency": "BRL"
132 },
133 "transactionName": "PGTO",
134 "identificationNumber": "4453",
135 "transactionId": "TXpRMU9UQTROMWhZV2xSU1FUazJSMDl",
136 "transactionType": "CASHBACK",
137 "billPostDate": "2021-04-01",
138 "creditDebitType": "DEBITO",
139 "feeType": "ANUIDADE",
140 "otherCreditsType": "",
141 "payeeMCC": 5137,
142 "paymentType": "A_VISTA",
143 "chargeIdentificator": "12",
144 "chargeNumber": 12,
145 "category": "Renda",
146 "subcategory": "Renda ativa",
147 "thirdCategory": "Salário",
148 "fAll": 1,
149 "fAllMonth": 0,
150 "fAllCMonth": 1,
151 "brand": "Netflix", }
152 ]
153 }
154 ]
155 }
156 ],
157 "externalInfo": {
158 "myTraceId": "yourtraceid-1",
159 "myUUID": "youruuid-1"
160 }
161}
For detailed schemes in the product, please refer to the official documentation of Open Finance Brazil.
