Introduction

PIX Charge API - Introduction

Overview

The PIX Charge API is a comprehensive solution for managing PIX (Brazilian instant payment system) charges and payments. This API provides a complete suite of tools for creating, managing, and tracking PIX charges, processing refunds.

What is PIX?

PIX is Brazil's instant payment system that allows for immediate, 24/7 money transfers between individuals, businesses, and government entities. It has revolutionized the Brazilian financial landscape by providing instant, secure, and cost-effective payment solutions.

API Capabilities

🚀 Dynamic QR Code

  • Create Immediate Charges: Generate dynamic PIX charges with customizable expiration times
  • Charge Consultation: Retrieve detailed information about specific charges
  • Charge Listing: Query and filter charges by various criteria
  • Refund Operations: Process full or partial refunds for paid charges
  • Real-time Status Updates: Monitor charge status changes instantly with webhooks

📱 Static QR Code

  • Generate Static QR Codes: Create fixed QR codes for predetermined payment scenarios
  • QR Code Decoding: Parse and extract information from existing QR codes
  • Point-of-Sale Integration: Perfect for fixed-price products and services

🔄 Dynamic vs Static QR Codes

Dynamic QR Codes

  • Real-time Generation: Created on-demand for specific transactions
  • Variable Amounts: Amount can be set at the time of generation
  • Expiration Control: Configurable expiration times (default: 24 hours)
  • Transaction Tracking: Each QR code is linked to a specific transaction ID (txid)
  • Status Monitoring: Real-time status updates (ACTIVE, PAID, EXPIRED, REFUNDED)
  • Use Cases: E-commerce, online payments, dynamic pricing scenarios

Static QR Codes

  • Pre-generated: Created once and reused multiple times
  • Fixed Information: Amount and recipient information are predetermined
  • No Expiration: Can be used indefinitely until manually updated
  • Point-of-Sale: Perfect for physical stores, restaurants, and fixed-price services
  • Use Cases: Physical stores, vending machines, fixed-price products

🎯 Use Cases

E-commerce

  • Online Store Payments: Process PIX payments for e-commerce transactions
  • Subscription Billing: Handle recurring payments for subscription services
  • Digital Product Sales: Accept payments for digital goods and services
  • Marketplace Transactions: Enable PIX payments in marketplace platforms

Physical Retail

  • Point-of-Sale Integration: Accept PIX payments at physical stores
  • Mobile Payment Acceptance: Enable contactless PIX payments
  • Receipt Generation: Generate digital receipts for PIX transactions
  • Inventory Management: Update stock levels after successful payments

Service Providers

  • Professional Services: Bill clients for professional services
  • Freelancer Payments: Accept payments for freelance work
  • Utility Bill Payments: Process utility and service payments
  • Subscription Services: Manage recurring service payments