🔄 Digital Account API: How to Use It (Only Brazil)

This guide explains how to fetch Digital Account Transactions. There is a single endpoint and it returns transactions bound to the account associated with the access token (no accountId parameter is required).

🧾 How to get Transactions from digital account via Clara API

This guide explains how to use the GET /api/v3/digital-accounts endpoint to retrieve transactions in the Clara API system.

---

🔐 Authentication Requirements

To access this endpoint, ensure the following:

• Use mutual TLS (MTLS) for secure two-way certificate validation.
• Obtain an OAuth2 access token via the /oauth/token endpoint.
• Include the Bearer token in the Authorization header of your request.

---

🔗 Endpoint

GET /v3/digital-accounts

---

🧾 Query Parameters (Optional)

• page (integer, zero‑based, required) – page index (0, 1, 2, …).
• size (integer, required) – number of items per page.
• sort (string, optional) – property,ASC|DESC (e.g., transactionDate,DESC).

⚠️

Important Notes:

• Response is a JSON array (no envelope with totalElements).
• Keep paging until an empty page or a page with < size items is returned.

✅ Successful Response

Status	Meaning
200	OK - List of transactions returned

---

❌ Error Responses

Status	Meaning
400	Bad Request
401	Unauthorized
403	Forbidden

---

📘 Example cURL Request

Bash

curl --location --request GET 'https://public-api.br.clara.com/api/v3/digital-accounts?page=0&size=50' \
--header 'Authorization: Bearer {your_access_token}' \
--cert {client_cert_path} \
--key {client_key_path}

Replace {your_access_token}, {client_cert_path}, and {client_key_path} with actual values.

---

📦 Example Response Object

General Response

[
{
"id": 3865272123,
"transactionDate": "2025-08-25T00:00:00",
"amount": 0.10,
"method": "PIX",
"type": "Transfer sent",
  "source": { 
    "name": "CLARA PARTICIPACOES LTDA", 	
    "taxId": "45690842000219", 	
    "institution": null 	
	},
  "beneficiary": { 
    "name": "CLARA PAGAMENTOS LTDA", 	
    "taxId": "41538332000223", 
    "institution": null 
	}
},
{
"id": 3643365432,
"transactionDate": "2025-08-14T00:00:00",
"amount": 0.01,
"method": "TED",
"type": "Reversal of sent transfer",
  "source": { 	
    "name": "CLARA INSTITUICAO DE PAGAMENTO LTDA.", 
    "taxId": "45690842000219", 
    "institution": "208" 
	},
  "beneficiary": { 
    "name": "test", 	
    "taxId": "63828378000402", 	
    "institution": "196" 
	}
}
]

Bill Response

[{
        "id": 3925095764,
        "transactionDate": "2025-07-03T00:00:00",
        "amount": 9.00,
        "method": "Bill",
        "type": "Transfer sent",
        "source": {
            "name": "CLARA INSTITUIÇÃO DE PAGAMENTO LTDA",
            "taxId": "41818339000586",
            "institution": "BTG Pactual"
        },
        "beneficiary": {
            "name": "CLARA INSTITUICAO DE PAGAMENTO LTDA",
            "taxId": "41818339000586",
            "institution": null
        },
        "description": "Boleto integral",
        "digitableLine": null,
        "charges": {
            "discount": 0.0,
            "fee": 0.0,
            "interest": 0.0,
            "totalFees": null
        }
}]

---

📎 Field reference

Field	Type	Description	Example
id	number	Unique transaction identifier.	3671272250
transactionDate	string (ISO-8601 date-time)	Transaction date/time.	2025-08-25T00:00:00
amount	number (decimal)	Currency amount in units (not cents). In typed languages, use BigDecimal.	0.10
method	string (enum)	Payment method.	PIX · TED · Bill · Transfer · Undefined
type	string	Business label describing the transaction.	Transfer sent · Deposit in account · Reversal of sent transfer
description	string | null	Optional description (mostly for bills).	"Boleto integral"
digitableLine	string | null	Bill (bank slip) digitable line when available.	"23793.38127 60000.000123 45000.567890 1 23450000010000"
charges	object | null	Bill fee breakdown: discount, fee, interest, totalFees.	{ "discount": 0.0, "fee": 0.0, "interest": 0.0, "totalFees": null }
source	object | null	Origin party: { name, taxId, institution }.	{ "name": "CLARA PARTICIPACOES LTDA", "taxId": "45690845000194", "institution": "41538335" }
beneficiary	object | null	Destination party: { name, taxId, institution }.	{ "name": "CLARA PAGAMENTOS LTDA", "taxId": "41538335000145", "institution": null }

⚠️

Note: some fields may be null depending on the method/type.