v1.0

Baanko API Documentation

Welcome to the official Baanko API documentation. Here you will find everything you need to integrate PIX payments into your application.

PIX - Instant Payments

Receive real-time PIX payments with dynamic QR codes, PIX keys and instant webhook notifications.

Security

Authentication with X-Client-Id and X-API-Key over end-to-end encryption.

Real Time

Instant webhooks for payment and withdrawal notifications.

Easy Integration

RESTful API with JSON responses and complete documentation.

Base URL

https://baanko.app

All requests must use this URL as the base.

Response Format

All API responses are returned as JSON. Errors follow the RFC 7807 (Problem Details) standard. Text messages returned by the API (such as message and detail) are in Portuguese.

Success Response Example

Response 200

{
  "data": {
    "id": "f2d96218-6635-4839-81d7-9f2d5aaf4f14",
    "status": "WAITING_PAYMENT",
    "paymentMethod": "PIX",
    "amount": 500
  },
  "status": 200,
  "message": "Transacao criada com sucesso."
}

Next Steps

Authentication

Set up your API credentials

→

Create Transaction

Create your first PIX transaction

→

Webhooks

Receive real-time notifications

→

Error Handling

Understand the error codes

→