DEVELOPER GUIDE
Concepts
2 min
Payment initiation type
Pre registration of payee's account
JSON
1{
2 "institutionId": "c8f0bf49-4744-4933-8960-7add6e590841",
3 "clientRequestId": "1",
4 "customer":
5 {
6 "identifierType": "CPF",
7 "identifier": "12345678901",
8 "name": "Klavi Test"
9 },
10 "date": "2025-07-01",
11 "initType": "PIX_INIC",
12 "proxy": "12345678901",
13 "amount": "1333.00",
14 "currency": "BRL",
15 "redirectUrl": "http://test",
16 "clientMetadata": {
17 "os": "MACOS",
18 "osVersion": "3.2.1",
19 "platform": "BROWSER"
20 }
21}
The creditor object must be sent with all payee information
JSON
1{
2 "institutionId": "c8f0bf49-4744-4933-8960-7add6e590841",
3 "clientRequestId": "1",
4 "customer":
5 {
6 "identifierType": "CPF",
7 "identifier": "12345678901",
8 "name": "Klavi Test"
9 },
10 "date": "2025-07-01",
11 "initType": "PIX_MANU",
12 "amount": "1333.00",
13 "currency": "BRL",
14 "redirectUrl": "http://test",
15 "creditorAccount":
16 {
17 "ispb": "87654321",
18 "issuer": "1234",
19 "number": "12345678",
20 "accountType": "CACC",
21 "holder":
22 {
23 "identifier": "44471172000119",
24 "name": "Klavi",
25 "identifierType": "CNPJ"
26 }
27 },
28 "clientMetadata": {
29 "os": "MACOS",
30 "osVersion": "3.2.1",
31 "platform": "BROWSER"
32 }
33}
The pixKey field represents creditor information
JSON
1{
2 "institutionId": "c8f0bf49-4744-4933-8960-7add6e590841",
3 "clientRequestId": "1",
4 "customer":
5 {
6 "identifierType": "CPF",
7 "identifier": "12345678901",
8 "name": "Klavi Test"
9 },
10 "date": "2025-07-01",
11 "initType": "PIX_DICT",
12 "proxy": "12345678901",
13 "amount": "1333.00",
14 "currency": "BRL",
15 "redirectUrl": "http://test",
16 "clientMetadata": {
17 "os": "MACOS",
18 "osVersion": "3.2.1",
19 "platform": "BROWSER"
20 }
21}
The QR code field represents creditor information
JSON
1{
2 "institutionId": "c8f0bf49-4744-4933-8960-7add6e590841",
3 "clientRequestId": "1",
4 "customer":
5 {
6 "identifierType": "CPF",
7 "identifier": "12345678901",
8 "name": "Klavi Test"
9 },
10 "date": "2025-07-01",
11 "initType": "PIX_QRCODE",
12 "amount": "1333.00",
13 "currency": "BRL",
14 "redirectUrl": "http://test",
15 "qrCode": "00020126330014BR.GOV.BCB.PIX01117610927767352040000530398654071333.005802BR5905Klavi60144447117200011962070503***63041878",
16 "clientMetadata": {
17 "os": "MACOS",
18 "osVersion": "3.2.1",
19 "platform": "BROWSER"
20 }
21}
Updated 10 Jul 2025
Did this page help you?