Skip to main content

​
Introduction

Pix is Brazil’s instant payment system, enabling 24/7 transfers that complete in seconds. Bipa operates as a Payment Institution with indirect Pix participation, providing:
  • Instant settlements - Payments complete in under 10 seconds
  • 24/7 availability - Works any time, including weekends and holidays
  • Zero fees for receiving - No cost to receive Pix payments
  • Multiple key types - Support for CPF, CNPJ, email, phone, and random keys

Receive payments

Generate static QR codes for customers to receive BRL

Send payments

Initiate instant Pix payouts to any Pix key

​
How it works

​
Pix key types

TypeFormatExample
evpRandom UUIDa1b2c3d4-e5f6-7890-abcd-ef1234567890
For now, customers will only be able to receive payments from Random keys (evp) or Static QR Codes (that also direct the payment to the Random key). Random keys are recommended for privacy as they don’t expose personal information.

​
Amount encoding

All monetary amounts are returned as string-encoded integers in centavos (BRL smallest unit).
AssetDecimalsExample
BRL2"100000" = R$ 1,000.00
Never use floating-point types (float, double) for monetary calculations. Use arbitrary-precision libraries.

​
Transaction statuses

StatusDescription
pendingTransaction initiated, awaiting processing
processingTransaction being processed by Pix network
completedTransaction successfully completed
failedTransaction failed (see error for details)
refundedTransaction was refunded

​
The Pix transaction object

{
  "id": "pix_abc123",
  "customer_id": "cus_a1b2c3d4e5f6",
  "direction": "outbound",
  "amount": "100000",
  "fee": "0",
  "decimals": 2,
  "status": "completed",
  "counterparty": {
    "name": "Maria Santos",
    "document": "***456***",
    "pix_key": "[email protected]",
    "bank_account": {
      "ispb_code": "341",
      "branch_number": "1234",
      "account_number": "1234567890",
      "account_type": "checking"
    }
  },
  "description": "Payment for services",
  "end_to_end_id": "E12345678202401151030abcdef123456",
  "idempotency_key": "pay_unique_123",
  "created_at": "2024-01-15T10:30:00Z",
  "completed_at": "2024-01-15T10:30:02Z"
}

​
Endpoints

List Pix Keys

List a customer’s Pix keys

Create Static QR Code

Generate a QR code for receiving (cash-in)

Create Payout

Send a Pix payout (cash-out)

Get Transaction

Retrieve transaction details

List Transactions

List all Pix transactions

​
Limits

OperationMinimumMaximum
Pix payoutR$ 0.01R$ 15,000.00 per transaction
Daily outbound-Defined per customer
Contact us for higher limits on business accounts.

​
Webhooks

Subscribe to these events to track Pix transaction lifecycle:
EventDescription
pix.receivedIncoming payment received (cash-in)
pix.completedOutgoing payout completed (cash-out)
pix.failedTransaction failed