For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
StatusDashboard
  • Getting Started
    • Introduction
    • Authentication
    • Rate Limits
    • Error Handling
  • Guides
    • Cash-In (Receiving Payments)
    • Cash-Out (Sending Payments)
    • PIX Keys Management
    • Webhooks Integration
    • MED (Special Returns)
  • API Reference
      • GETList PIX Keys
      • POSTRegister PIX Key
      • GETGet PIX Key by Value
      • DELDelete PIX Key
LogoLogo
StatusDashboard
API ReferencePix Keys

List PIX Keys

GET
https://api.brzip.com.br/api/v1/pix/keys
GET
/api/v1/pix/keys
$curl https://api.brzip.com.br/api/v1/pix/keys \
>     -H "Content-Type: application/json"
200Retrieved
1{
2  "success": true,
3  "data": {
4    "data": [
5      {
6        "id": "4a9c64d5-2499-411c-93de-c134845fdb41",
7        "client_id": "a9376f19-ac76-49fe-9a0a-4d566660ebf8",
8        "account_id": "b1f2c3d4-e5f6-7890-abcd-1234567890ef",
9        "key_type": "EMAIL",
10        "key_value": "joao.silva@example.com",
11        "ispb": "12345678",
12        "branch_number": "0001",
13        "account_type": "CACC",
14        "account_number": "12345-6",
15        "person_type": "NATURAL_PERSON",
16        "tax_id": "12345678901",
17        "holder_name": "João da Silva",
18        "dict_key_id": "d9f8e7c6-b5a4-3210-9876-54321fedcba0",
19        "dict_status": "active",
20        "created_at": "2024-05-10T09:15:30-03:00",
21        "updated_at": "2024-05-15T14:20:45-03:00"
22      }
23    ],
24    "total": 1,
25    "page": 1,
26    "page_size": 20
27  }
28}

Lists all PIX keys registered for the authenticated client.

Scope: pix:keys:read

Was this page helpful?
Previous

Register PIX Key

Next
Built with

Response

List of PIX keys
successboolean
dataobject