# bacen/pix-api

API Pix: a API do Arranjo de Pagamentos Instantâneos Brasileiro, Pix, criado pelo Banco Central do Brasil.

Repository: https://github.com/bacen/pix-api
Canonical: https://ross.abutalabs.com/products/pix-api
Homepage: https://bacen.github.io/pix-api
License Family: other
Topics: pix, instant-payments, bcb, bacen, api, openapi, spec
Last push: 2026-08-19T15:12:28+00:00

## Health v2 (maintenance only)
Score: 90/100 (v2, computed 2026-09-02T17:46:02.011165+00:00)
- activity 98, release rhythm 74, longevity 100
- inputs: {"age_days": 2175, "days_push": 14, "days_rel": 14, "gap_med": 91, "n_releases_24m": 6}
- flags: no_license
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 2950, forks 299 (observed 2026-08-28T04:07:31.954079+00:00)

## What it is
The official OpenAPI 3.0 specification for Pix, Brazil's instant payment arrangement, published by the Central Bank of Brazil (Banco Central do Brasil). It defines the functional API contracts that financial institutions must implement to integrate with the Pix payment system.

## Use cases
- generate client SDKs for the Pix API
- understand the Pix API endpoints and payloads
- validate a Pix API implementation against the official spec
- build payment integrations with Brazilian instant payments
- browse the Pix API documentation in Swagger UI
- mock a Pix API server for testing

## When to choose
- you are a Brazilian financial institution implementing the Pix API
- you need the authoritative OpenAPI contract for Pix endpoints
- you want to generate clients or mocks from the official spec

## When to avoid
- you need a working Pix client library or SDK rather than a spec
- you need Pix security and certificate setup guidance, which lives in separate BCB manuals
- you are integrating instant payments outside Brazil

## Facets
- artifact type: dataset
- maturity: stable
- function: api-framework, documentation, sdk
- domain: fintech, apis, documentation, e-commerce
- platform: cloud
- tags: openapi, openapi-spec, pix, instant-payments, brazil, central-bank, payments, api-specification, web-server

## Member repositories
- bacen/pix-api (main) score 90

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:07:31.954079+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-30T07:32:42.486609+00:00, confidence not recorded.
  - readme: https://github.com/bacen/pix-api (fetched 2026-08-28T04:07:31.954079+00:00, sha c0f0ca674e2e)
  - homepage: https://bacen.github.io/pix-api (fetched 2026-08-29T09:48:14.794968+00:00, sha d34291959ff0)
- Data as of 2026-08-30T08:39:29.467469+00:00.