Banco do Brasil API

Finance / OAuth Advanced HTTPS CORS

28 F

Metadata Score Metadata estimate · not endpoint-tested

Visit Official Site Compare Alternatives

Overview

Banco do Brasil provides a suite of financial APIs covering transactions, payments, PIX transfers, and account data for Brazil's largest public bank. It uses OAuth 2.0 for authentication and follows Open Banking standards. This API is best suited for developers building fintech applications targeting the Brazilian market.

Beginner Tip

You will need to register as a developer on developers.bb.com.br and go through an approval process before getting sandbox credentials. Start in the sandbox environment — it mirrors production without using real money.

Available Data

The kind of data this API exposes, based on its documentation. We could not call the endpoint to confirm the exact field names.

Banco do Brasil data via REST API

Example Response

Illustrative shape only — we were not able to call this endpoint (it requires credentials or exposes no public sample URL), so the fields below show the kind of data this API returns rather than a recorded response.

JSON Response · Illustrative

{
  "status": "success",
  "data": {
    "result": "Data from Banco do Brasil",
    "description": "All Banco do Brasil financial transaction APIs",
    "timestamp": "2025-01-15T10:00:00Z"
  }
}

Field Reference

access_token OAuth 2.0 bearer token to use in subsequent API requests

token_type Token type, always Bearer for this API

expires_in Token validity duration in seconds from the time of issuance

scope Space-separated list of permissions granted to this token

Implementation Example

Calls a real endpoint of this API. Replace any placeholder credentials with your own key.

Request

const url = "https://oauth.bb.com.br/oauth/token";
// Replace headers or query params with the values required by this API.
const response = await fetch(url, {
  headers: {
  "Authorization": "Bearer YOUR_API_KEY"
  }
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = await response.json();
console.log(data);

What Can You Build?

Note: These code examples are AI-generated and unverified. Always refer to the official API documentation for accurate usage.

Common Errors & Troubleshooting

Generated guidance based on this API's documentation, not observed by us. Treat it as a starting point and check against the provider's own error reference.

401 Unauthorized on token request Incorrect client_id or client_secret in the OAuth token request

✓ Double-check your credentials from the developer portal and ensure you are using the sandbox credentials for the sandbox environment

403 Forbidden on API call Access token does not include the required scope for the endpoint

✓ Request the correct scope when obtaining your token; each endpoint requires a specific scope listed in the documentation

400 Bad Request on PIX endpoint PIX key format is invalid or the request body does not match the expected schema

✓ Validate your request body against the API schema; PIX keys have strict format rules for CPF, CNPJ, phone, email, and random keys

Metadata Score Breakdown

Estimated from metadata — endpoint not independently tested

This score is estimated from observable metadata — HTTPS support, authentication model, declared CORS, and documentation reachability — because the API requires authentication or exposes no publicly testable endpoint. The five-signal breakdown is only shown for live-tested APIs.

Metadata estimate · endpoint not independently tested

How is this scored? →