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
      • POSTCreate Charge
      • GETGet Cash-In Status
      • POSTCancel Cash-In
LogoLogo
StatusDashboard
API ReferencePix Cash IN

Create Charge

POST
https://api.brzip.com.br/api/v1/pix/cash-in/qrcode
POST
/api/v1/pix/cash-in/qrcode
$curl -X POST https://api.brzip.com.br/api/v1/pix/cash-in/qrcode \
>     -H "x-key-id: your-api-key-id" \
>     -H "x-secret-key: your-api-key-secret" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "amount": "150.00",
>  "reference": "order-12345"
>}'
200Successful
1{
2  "conciliation_id": "e7ab3h05237141509d5c52a280b68b53",
3  "success": true,
4  "transaction_id": "txn_abc123",
5  "status": "pending",
6  "qr_code": "string",
7  "qr_code_text": "string",
8  "expires_at": "2024-01-15T09:30:00Z",
9  "jdpi_document_id": "29535ed9-cc6a-4d87-994f-634f830362f1",
10  "message": "Cash-in validated successfully",
11  "metadata": {},
12  "provider": "pix"
13}

Creates a PIX charge (Cash-In). Generates a QR Code for the payer and waits for the complete processing result.

Authentication: API Key via headers x-key-id + x-secret-key, OR Bearer Token.

Scope: pix:cashin:write

Was this page helpful?
Previous

Get Cash-In Status

Next
Built with

Headers

x-key-idstringOptional

API Key ID (required if not using Bearer Token)

x-secret-keystringOptional

API Key Secret (required if not using Bearer Token)

Request

This endpoint expects an object.
amountstringRequired

Charge amount in BRL (decimal string)

referencestringRequired
Your internal reference ID
descriptionstringOptional
Charge description shown to payer
payer_namestringOptional

Expected payer name (optional)

payer_documentstringOptional

Expected payer document/CPF (optional)

expiration_timeintegerOptional

Expiration time in seconds (default 3600)

metadataobjectOptional
Metadata for the charge
due_datedateOptional

Due date for CobV charges (YYYY-MM-DD)

receiver_addressstringOptional
Address of the receiver
receiver_statestringOptional
State of the receiver
receiver_postal_codestringOptional
Postal Code of the receiver
penaltyobjectOptional

Late fee configuration (CobV only)

interestobjectOptional

Daily interest configuration (CobV only)

discountobjectOptional

Early payment discount (CobV only)

rebateobjectOptional

Rebate/abatement (CobV only)

withdraw_amountstringOptional
Number indicating the withdraw amount
withdraw_agent_modeintegerOptional
change_amountstringOptional
Number indicating the change amount
change_agent_modestringOptional

Response

Charge created and processed
conciliation_idstring
successboolean
transaction_idstring
statusstring
qr_codestring
qr_code_textstring
expires_atdatetime
jdpi_document_idstring
messagestring
metadataobject
providerstring