For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
StatusDashboard
  • Getting Started
    • Introduction
    • Authentication
    • Rate Limits
    • Error Handling
  • Guides
    • Cash-In (Receiving Payments)
    • Cash-Out (Sending Payments)
    • PIX Keys Management
    • Webhooks Integration
    • MED (Special Returns)
  • API Reference
LogoLogo
StatusDashboard
On this page
  • Cash-In (Receiving Payments)
  • Creating a Charge
  • Checking Charge Status
  • Possible Statuses
  • Cancelling a Charge
  • Advanced Features (CobV)
Guides

Cash-In (Receiving Payments)

Was this page helpful?
Edit this page
Previous

Cash-Out (Sending Payments)

Next
Built with

Cash-In (Receiving Payments)

Cash-In endpoints allow you to create PIX charges and generate QR codes for payers.

Cash-In endpoints accept API Key authentication (x-key-id + x-secret-key) OR Bearer Token.

Creating a Charge

Create a PIX charge using POST /api/v1/pix/cash-in/qrcode:

Using API Key:

$curl -X POST https://api.brzip.com.br/api/v1/pix/cash-in/qrcode \
>  -H "Content-Type: application/json" \
>  -H "x-key-id: your-key-id" \
>  -H "x-secret-key: your-secret-key" \
>  -d '{
>    "amount": "150.00",
>    "reference": "order-12345",
>    "description": "Payment for order #12345",
>    "payer_name": "John Doe",
>    "payer_document": "12345678901",
>    "expiration_time": 3600
>  }'

Using Bearer Token:

$curl -X POST https://api.brzip.com.br/api/v1/pix/cash-in/qrcode \
>  -H "Content-Type: application/json" \
>  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..." \
>  -d '{
>    "amount": "150.00",
>    "reference": "order-12345",
>    "description": "Payment for order #12345",
>    "payer_name": "John Doe",
>    "payer_document": "12345678901",
>    "expiration_time": 3600
>  }'

Response:

1{
2  "success": true,
3  "transaction_id": "txn_f1e2d3c4-b5a6-7890-cdef-1234567890ab",
4  "status": "pending",
5  "qr_code": "00020126580014br.gov.bcb.pix0136...",
6  "qr_code_text": "data:image/png;base64,iVBORw0KGgo...",
7  "expires_at": "2026-02-23T22:10:00.000Z",
8  "provider": "pix"
9}

Checking Charge Status

Query the status of a charge by its transaction ID:

$curl -X GET https://api.brzip.com.br/api/v1/pix/cash-in/txn_abc123 \
>  -H "x-key-id: your-key-id" \
>  -H "x-secret-key: your-secret-key"

Possible Statuses

StatusDescription
pendingCharge created, awaiting payment
paidPayment received and confirmed
expiredCharge expired without payment
cancelledCharge was cancelled
failedCharge processing failed

Cancelling a Charge

Cancel a pending charge:

$curl -X POST https://api.brzip.com.br/api/v1/pix/cash-in/txn_abc123/cancel \
>  -H "x-key-id: your-key-id" \
>  -H "x-secret-key: your-secret-key"

Only charges with pending status can be cancelled.

Advanced Features (CobV)

For charges with due dates (CobV — Charge with Due Date), you can include additional financial fields:

FieldDescription
due_dateDue date (YYYY-MM-DD)
penaltyLate payment penalty (mode: 1=fixed, 2=percentage; value)
interestDaily interest (mode: 1=BRL/day, 2=%/day, 3=%/month, 4=%/year; value)
discountEarly payment discount (mode + value + fixed_dates[])
rebateRebate/abatement (mode: 1=fixed, 2=percentage; value)