1. Integration Guide
Kapitale
  • Integration Guide
    • 📋 Introduction
    • 🔐 Authentication
    • 🚀 Integration Flow
    • 🔔 Webhooks
    • 🔄 Integration Flowchart
    • 🧪 Sandbox Environment
    • 📊 Status Map
    • ⚠️ Error Handling
    • 📝 Practical Examples
    • 💳 Receivable Consultation
    • 📞 Support
  • API
    • Retail
      • Fetch retail information by CNPJ
    • Orders
      • Create a new order
      • List orders
      • Fetch order by ID
      • Set payment invoice
      • Cancel order
    • Receivable
      • Fetch receivables by CNPJ
  • Schemas
    • CreateOrderRequest
    • RetailInfo
    • Acquirer
    • CancelOrderRequest
    • PurchaseItem
    • Order
    • FindReceivableResponse
    • OrderStatus
    • PaymentStatus
    • FindByIndustryCnpjResponse
    • OrderStatistics
    • Error
    • ReceivableItem
  1. Integration Guide

📝 Practical Examples

Example 0: Obtain OAuth2 Token (JavaScript/Node.js)#

Before making API requests, you need to obtain a JWT token via the OAuth2 client_credentials flow:

Example 1: Fetch Retail Information and Create Order (JavaScript/Node.js)#

This example shows how to fetch retail information and use it to create an order:

Example 2: Create and Query Order (JavaScript/Node.js)#

Example 3: Invoice Upload (Python)#

🔍 Important Validations#

CNPJ#

Must contain exactly 14 numeric digits
Will be automatically validated by the API
Expected format: numbers only (no dots, slashes, or hyphens)

Monetary Values#

Must be decimal numbers
Minimum value: 1.00
Use period (.) as decimal separator

Dates#

Format: YYYY-MM-DD (ISO 8601)
Example: 2024-12-31

Files#

Invoices: PDF or image format
Modified at 2026-03-16 14:55:50
Previous
⚠️ Error Handling
Next
💳 Receivable Consultation
Built with