PRODUCTS
...
credit_card
Plain CPF
V1
2min
pf_credit_card
JSON
1{
2 "code": 200,
3 "message": "OK",
4 "requestId": "112334",
5 "productName": "pf_credit_card",
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 "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 "limit": {
45 "isLimitFlexible": true,
46 "limitAmount": {
47 "amount": "1000.0400",
48 "currency": "BRL",
49 "limitAmountReason": ""
50 },
51 "usedAmount": {
52 "amount": "1000.0400",
53 "currency": "BRL"
54 },
55 "availableAmount": {
56 "amount": "1000.0400",
57 "currency": "BRL"
58 }
59 },
60 "openStatement":
61 {
62 "billMonth": "2021-05",
63 "billingDate": "2021-05-10",
64 "dueDate": "2021-05-21",
65 "billTotalAmount": {
66 "amount": "1000.0400",
67 "currency": "BRL"
68 },
69 "transactionDetails": [
70 {
71 "transactionDate": "2021-05-01",
72 "transactionDateTime": "2016-01-29T12:29:03.374Z",
73 "brazilianAmount": {
74 "amount": "1000.0400",
75 "currency": "BRL"
76 },
77 "transactionName": "PGTO",
78 "identificationNumber": "4453",
79 "transactionId": "TXpRMU9UQTROMWhZV2xSU1FUazJSMDl",
80 "transactionType": "CASHBACK",
81 "billPostDate": "2021-05-01",
82 "creditDebitType": "DEBITO",
83 "feeType": "ANUIDADE",
84 "otherCreditsType": "",
85 "payeeMCC": 5137,
86 "paymentType": "A_VISTA",
87 "chargeIdentificator": "12",
88 "chargeNumber": 12
89 }
90 ]
91 }
92 ,
93 "closedStatements": [
94 {
95 "billMonth": "2021-04",
96 "billingDate": "2021-04-10",
97 "dueDate": "2021-04-21",
98 "billMinimumAmount": {
99 "amount": "1000.0400",
100 "currency": "BRL"
101 },
102 "billTotalAmount": {
103 "amount": "1000.0400",
104 "currency": "BRL"
105 },
106 "billPayments": [
107 {
108 "amount": "1000.0400",
109 "currency": "BRL",
110 "paymentDate": "2021-04-01",
111 "valueType": "VALOR_PAGAMENTO_FATURA_PARCELADO",
112 "paymentMode": "DEBITO_CONTA_CORRENTE"
113 }
114 ],
115 "transactionDetails": [
116 {
117 "transactionDate": "2021-04-01",
118 "transactionDateTime": "2016-01-29T12:29:03.374Z",
119 "brazilianAmount": {
120 "amount": "1000.0400",
121 "currency": "BRL"
122 },
123 "transactionName": "PGTO",
124 "identificationNumber": "4453",
125 "transactionId": "TXpRMU9UQTROMWhZV2xSU1FUazJSMDl",
126 "transactionType": "CASHBACK",
127 "billPostDate": "2021-04-01",
128 "creditDebitType": "DEBITO",
129 "feeType": "ANUIDADE",
130 "otherCreditsType": "",
131 "payeeMCC": 5137,
132 "paymentType": "A_VISTA",
133 "chargeIdentificator": "12",
134 "chargeNumber": 12
135 }
136 ]
137 }
138 ]
139 }
140 ],
141 "externalInfo": {
142 "myTraceId": "yourtraceid-1",
143 "myUUID": "youruuid-1"
144 }
145}
pj_credit_card
The JSON scheme is similar to the pf_credit_card, and the productName key is pj_credit_card.
JSON
1{
2 "code": 200,
3 "message": "OK",
4 "requestId": "112334",
5 "productName": "pj_credit_card",
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 "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 "paymentMethods": [
42 {
43 "identificationNumber": "4453",
44 "isMultipleCreditCard": true
45 }
46 ],
47 "limit": {
48 "isLimitFlexible": true,
49 "limitAmount": {
50 "amount": "1000.0400",
51 "currency": "BRL",
52 "limitAmountReason": ""
53 },
54 "usedAmount": {
55 "amount": "1000.0400",
56 "currency": "BRL"
57 },
58 "availableAmount": {
59 "amount": "1000.0400",
60 "currency": "BRL"
61 }
62 },
63 "openStatement":
64 {
65 "billMonth": "2021-05",
66 "billingDate": "2021-05-10",
67 "dueDate": "2021-05-21",
68 "billTotalAmount": {
69 "amount": "1000.0400",
70 "currency": "BRL"
71 },
72 "transactionDetails": [
73 {
74 "transactionDate": "2021-05-01",
75 "transactionDateTime": "2016-01-29T12:29:03.374Z",
76 "brazilianAmount": {
77 "amount": "1000.0400",
78 "currency": "BRL"
79 },
80 "transactionName": "PGTO",
81 "identificationNumber": "4453",
82 "transactionId": "TXpRMU9UQTROMWhZV2xSU1FUazJSMDl",
83 "transactionType": "CASHBACK",
84 "billPostDate": "2021-05-01",
85 "creditDebitType": "DEBITO",
86 "feeType": "ANUIDADE",
87 "otherCreditsType": "",
88 "payeeMCC": 5137,
89 "paymentType": "A_VISTA",
90 "chargeIdentificator": "12",
91 "chargeNumber": 12
92 }
93 ]
94 }
95 ,
96 "closedStatements": [
97 {
98 "billMonth": "2021-04",
99 "billingDate": "2021-04-10",
100 "dueDate": "2021-04-21",
101 "billMinimumAmount": {
102 "amount": "1000.0400",
103 "currency": "BRL"
104 },
105 "billTotalAmount": {
106 "amount": "1000.0400",
107 "currency": "BRL"
108 },
109 "billPayments": [
110 {
111 "amount": "1000.0400",
112 "currency": "BRL",
113 "paymentDate": "2021-04-01",
114 "valueType": "VALOR_PAGAMENTO_FATURA_PARCELADO",
115 "paymentMode": "DEBITO_CONTA_CORRENTE"
116 }
117 ],
118 "transactionDetails": [
119 {
120 "transactionDate": "2021-04-01",
121 "transactionDateTime": "2016-01-29T12:29:03.374Z",
122 "brazilianAmount": {
123 "amount": "1000.0400",
124 "currency": "BRL"
125 },
126 "transactionName": "PGTO",
127 "identificationNumber": "4453",
128 "transactionId": "TXpRMU9UQTROMWhZV2xSU1FUazJSMDl",
129 "transactionType": "CASHBACK",
130 "billPostDate": "2021-04-01",
131 "creditDebitType": "DEBITO",
132 "feeType": "ANUIDADE",
133 "otherCreditsType": "",
134 "payeeMCC": 5137,
135 "paymentType": "A_VISTA",
136 "chargeIdentificator": "12",
137 "chargeNumber": 12
138 }
139 ]
140 }
141 ]
142 }
143 ],
144 "externalInfo": {
145 "myTraceId": "yourtraceid-1",
146 "myUUID": "youruuid-1"
147 }
148}
For detailed schemes in the product, please refer to the official documentation of Open Finance Brazil.
