PIX

Participantes do PIX

Lista de instituições participantes do arranjo PIX.

PIX participants

List of institutions participating in the PIX arrangement.

SYNC resposta na mesma chamada answers in the same call

Endpoints

Endpoints

GET /api/v1/pix/participantes lista os participantes do PIX lists PIX participants

Exemplo

Example

curl https://api.alicercelabs.com.br/api/v1/pix/participantes \
          -H "Authorization: Bearer <token>"
{
          "success": true,
          "data": [
            {
              "ispb": "00360305",
              "nome": "CAIXA ECONOMICA FEDERAL",
              "nome_reduzido": "CAIXA ECONOMICA FEDERAL",
              "modalidade_participacao": "Provedor de Conta Transacional",
              "tipo_participacao": "Direta"
            }
          ],
          "meta": { "elapsed_ms": 320, "request_id": "..." }
        }

Erros possíveis

Possible errors

StatusMotivoReason
401token ausente ou inválidomissing or invalid token
429limite de taxa excedidorate limit exceeded
503dado indisponível no momentodata temporarily unavailable

Usando o SDK

Using the SDK

SDKs oficiais: Go · Python · JavaScript.

Official SDKs: Go · Python · JavaScript.

Listar participantes

List participants

import (
	"context"
	"fmt"

	alicercelabs "github.com/alicercelabs/alicercesdk-go"
)

client := alicercelabs.New("alk_...")
ctx := context.Background()

participantes, err := client.PIX.Participantes(ctx)
if err != nil {
	panic(err)
}
fmt.Println(len(participantes), "participantes")
from alicercelabs import AlicerceLabs

client = AlicerceLabs(api_key="alk_...")

participantes = client.pix.participantes()
print(len(participantes), "participantes")
import { AlicerceLabs } from "alicercesdk-javascript";

const client = new AlicerceLabs("alk_...");

const participantes = await client.pix.participantes();
console.log(participantes.length, "participantes");

Limites

Limits

100/dia · 4/hora sem token, por IP chamador; com uma API key (gerada no painel), 1.000/dia · 41/hora. Resposta em cache por 24h.

100/day · 4/hour without a token, per calling IP; with an API key (generated in the panel), 1,000/day · 41/hour. Response cached for 24h.