API BBAAS — Blockchain Bank As A Service

Base URL: https://baas-gtw.axiadigitalsolutions.com (production) · Version: v1

A API REST de Blockchain Bank As A Service do ecossistema Axia. Os dados (rotas, campos, exemplos) estão em inglês; as explicações são localizáveis. Para o catálogo interativo, veja a Referência interativa.

Seções

• Autenticação — OAuth: access-token, introspect, revoke
• Contas bancárias — abertura PF/PJ, saldo, histórico, transferências
• PIX — chaves, QR Code, transferência, estorno
• Cobranças & Pagamentos — boletos e cobranças
• Webhooks — eventos em tempo real
• Antifraude & Aprovação — fluxo de aprovação e idempotência
• Tratamento de Erros — códigos HTTP e erros comuns
• Referência interativa (catálogo) — todos os endpoints via OpenAPI

Getting Started

Prerequisites

To integrate with the Axia BaaS Gateway, you will need:

1. Client ID and Client Secret — provided upon registration in the Developer Portal
2. x-client-id — your tenant identifier (required for financial transactions)

Authentication Flow

All API calls (except authentication itself) require a Bearer token obtained via the OAuth endpoint:

1. Encode your credentials:  Base64("Client_ID:Client_Secret")
2. POST /v1/authentication/oauth/access-token  →  receive Bearer token
3. Use the Bearer token in the Authorization header for all subsequent requests

Common Headers

Header	Required	Description
Authorization	Yes	Basic <base64> for auth endpoints; Bearer <token> for all others
Content-Type	Yes (POST/PUT)	application/json
x-client-id	Yes (financial ops)	Your tenant identifier
Idempotency-Key	Recommended	UUID to prevent duplicate transactions

Standard Response Format

{
  "status": "CONFIRMED",
  "data": { },
  "message": "",
  "when": 1710700000000
}

Field	Description
status	CONFIRMED, PROCESSING, or ERROR
data	Operation-specific response payload
message	Error description (when status = ERROR)
when	Timestamp in milliseconds

Quick Reference

Complete API Endpoint Summary

Method	Endpoint	Description
Authentication
POST	/v1/authentication/oauth/access-token	Get Bearer token
POST	/v1/authentication/oauth/introspect	Validate token
POST	/v1/authentication/oauth/revoke	Revoke token
Bank Accounts
POST	/v1/bank-accounts/create	Create account (PF/PJ)
GET	/v1/bank-accounts/checkOnboarding	Check onboarding status
GET	/v1/bank-accounts/balance	Get account balance
GET	/v1/bank-accounts/history	Get transaction history
GET	/v1/bank-accounts/getTransactionById	Get transaction receipt
GET	/v1/bank-accounts/getAccounts	List accounts
GET	/v1/bank-accounts/getAccountInfoNaturalPerson	Get PF account info
GET	/v1/bank-accounts/getAccountInfoLegalPerson	Get PJ account info
PUT	/v1/bank-accounts/updateAccountInfoLegalPerson	Update PJ info
POST	/v1/bank-accounts/generateInternalTransferRequest	Internal transfer
POST	/v1/bank-accounts/generateExternalTransferRequest	External transfer (TED)
POST	/v1/bank-accounts/closeAccount	Close account
PIX
POST	/v1/pix/create	Register PIX key
POST	/v1/pix/exclude	Remove PIX key
GET	/v1/pix/getKeys	List PIX keys
POST	/v1/pix/getAccountInfoByPixKey	Look up account by PIX key
POST	/v1/pix/transfer	Execute PIX transfer
GET	/v1/pix/check	Check PIX status
POST	/v1/pix/createStaticQRCode	Create static QR Code
GET	/v1/pix/getStaticQRCode	Get QR Code data
POST	/v1/pix/getQRCodeDataByEmv	Parse QR Code EMV
POST	/v1/pix/pixPayByQRCode	Pay via QR Code
POST	/v1/pix/reverse	Reverse PIX transaction
Bills
POST	/v1/bills/payBill	Pay a bill (boleto)
POST	/v1/bills/checkBill	Check bill details
POST	/v1/bills/CreateCharge	Create a charge
POST	/v1/bills/CheckCharge	Check charge status
POST	/v1/bills/getChargePDF	Get charge PDF