BrazilianHubBrazilianHubdocs

Referência da API

Config de cartão

Diz se a conta aceita cartão e COMO enviar. Chame no seu backend ao abrir o checkout. O campo tokenization decide o fluxo: • "TOKEN" — a conta tokeniza: vem a tokenizationKey (chave PÚBLICA) pra BrazilianHub.js tokenizar o cartão no navegador (Modelo A, PCI SAQ A). O Modelo B (PAN cru) também funciona nessa conta. • "NONE" — a conta NÃO tokeniza: NÃO vem tokenizationKey. Só o Modelo B (PAN cru) é possível — você manda os dados do cartão direto no /purchase. • available: false — a conta só aceita PIX (cartão desabilitado); os demais campos são omitidos. allowsInstallments diz se o parcelamento está liberado. Importante: a AUSÊNCIA de tokenizationKey quando tokenization é "NONE" é esperada — não trate como erro.

GET/transactions/card-config

Autenticação

HTTP Basic Auth. Envie sua secret key no header:

Authorization: Basic {base64(secret:SUA_SECRET_KEY)}

Respostas

200

Config retornada. tokenization: "TOKEN" traz a tokenizationKey; tokenization: "NONE" NÃO traz (só PAN cru); available: false omite os demais campos (só PIX).

JSON
// Conta que tokeniza (Modelo A ou B):
{
  "available": true,
  "tokenization": "TOKEN",
  "tokenizationKey": "pgk_live_...",
  "allowsInstallments": true
}

// Conta SEM tokenização (só Modelo B / PAN cru):
{
  "available": true,
  "tokenization": "NONE",
  "allowsInstallments": true
}

// Conta sem cartão:
{ "available": false }
401

API key ausente, malformada ou revogada.

JSON
{
  "statusCode": 401,
  "message": "Unauthorized"
}

Exemplos

cURL
curl -X GET "https://production.brazilianpix.com/transactions/card-config" \
  -H "Authorization: Basic $(echo -n 'secret:SUA_SECRET_KEY' | base64)"
html
<!-- No NAVEGADOR: carregue a BrazilianHub.js e monte o campo de cartão. -->
<script src="https://portal.brazilianpix.com/sdk/brazilian.js"></script>
<div id="card-element"></div>

<script>
  // A tokenizationKey vem do GET /transactions/card-config (seu backend).
  const card = BrazilianHub.card({ tokenizationKey: "pgk_live_..." });
  await card.mount("#card-element");   // renderiza o campo de cartão (PCI SAQ A)

  // No submit do checkout:
  const { token } = await card.tokenize({ name: "João Silva" });
  // 'token' é opaco — mande pro SEU servidor e cobre com creditCard.token.

  // Se o /purchase responder requiresAction + clientSecret (3D Secure):
  // await card.confirmAction(clientSecret);  // abre o desafio no navegador
</script>
JavaScript
// SEU BACKEND: pega a config e decide o fluxo de cartão.
const token = Buffer.from("secret:" + process.env.BRAZILIANHUB_SECRET_KEY).toString("base64");
const res = await fetch("https://production.brazilianpix.com/transactions/card-config", {
  headers: { Authorization: `Basic ${token}` },
});
const cfg = await res.json();

if (!cfg.available) {
  // Conta só aceita PIX — esconda a opção de cartão.
} else if (cfg.tokenization === "TOKEN") {
  // Modelo A: envie cfg.tokenizationKey pro navegador (é pública) e tokenize lá.
  // (Ou Modelo B: mande o PAN cru direto no /purchase, se você for PCI.)
} else {
  // cfg.tokenization === "NONE": NÃO há tokenizationKey.
  // Só Modelo B — mande os dados do cartão (PAN) direto no /purchase.
}