Skip to content

bipa-app/docs

Repository files navigation

Bipa Infra API Documentation

API documentation for Bipa Infra - Crypto as a Service for Brazilian businesses.

Overview

This documentation is built with Mintlify and covers the complete Bipa Infra API:

  • Customers - Manage end-users (individuals and businesses)
  • Pix - Brazil's instant payment system integration
  • Quotes - Real-time currency conversion quotes
  • On-chain - USDT and Bitcoin blockchain transfers
  • Balances - Account balances and transaction history

Local Development

Install the Mintlify CLI:

npm i -g mintlify

Run the development server:

mintlify dev

The documentation will be available at http://localhost:3000.

Structure

docs/
├── introduction.mdx        # Platform overview
├── authentication.mdx      # API authentication
├── errors.mdx              # Error handling
├── webhooks.mdx            # Webhook integration
├── rate-limits.mdx         # Rate limiting
├── api-reference/
│   ├── customers/          # Customer management
│   ├── pix/                # Pix payments
│   ├── quotes/             # Currency quotes
│   ├── onchain/            # On-chain transfers
│   └── balances/           # Balances & transactions
├── docs.json               # Mintlify configuration
└── logo/                   # Bipa logos

API Base URL

https://api.bipa.tech/v1

Authentication

All API requests require Bearer token authentication:

curl https://api.bipa.tech/v1/customers \
  -H "Authorization: Bearer bipa_live_sk_xxxxxxxxxxxx"

Resources

License

Copyright © 2024 Bipa. All rights reserved.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages