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 Cash-Out
      • GETGet Cash-Out Status
      • POSTDecode QR Code
LogoLogo
StatusDashboard
API ReferencePix Cash Out

Create Cash-Out

POST
https://api.brzip.com.br/api/v1/pix/cash-out
POST
/api/v1/pix/cash-out
$curl -X POST https://api.brzip.com.br/api/v1/pix/cash-out \
>     -H "X-Idempotency-Key: 550e8400-e29b-41d4-a716-446655440000" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "amount": "1000.00"
>}'
1{
2  "success": true,
3  "transaction_id": "1c1331ce-a9ff-43c5-8ed2-31a98e61a1ab",
4  "status": "queued",
5  "amount": "50",
6  "message": "Cash-out queued for processing"
7}
Initiates a PIX payment (Cash-Out). This single endpoint supports three different payment flows depending on the fields provided: ## Flow 1 — Via PIX Key Send a payment directly using the recipient's PIX key. **Required fields:** `amount`, `pix_key`, `pix_key_type`, `external_id` ## Flow 2 — Via Bank Details Send a payment using the recipient's bank account details, without needing a PIX key. **Required fields:** `amount`, `receiver_name`, `receiver_document`, `receiver_ispb`, `receiver_branch`, `receiver_account`, `receiver_account_type`, `external_id` ## Flow 3 — Via QR Code (Two-Step) 1. First decode the QR Code via `POST /api/v1/pix/qrcode/decode` 2. Use the returned `end_to_end_id` as the `X-Pix-Lookup-E2E` header in this call 3. The system retrieves pre-decoded data and processes the payment (without decoding again) **Required fields:** `amount` + header `X-Pix-Lookup-E2E` **Scope:** `pix:cashout:write`
Was this page helpful?
Previous

Get Cash-Out Status

Next
Built with

Initiates a PIX payment (Cash-Out). This single endpoint supports three different payment flows depending on the fields provided:

Flow 1 — Via PIX Key

Send a payment directly using the recipient’s PIX key. Required fields: amount, pix_key, pix_key_type, external_id

Flow 2 — Via Bank Details

Send a payment using the recipient’s bank account details, without needing a PIX key. Required fields: amount, receiver_name, receiver_document, receiver_ispb, receiver_branch, receiver_account, receiver_account_type, external_id

Flow 3 — Via QR Code (Two-Step)

  1. First decode the QR Code via POST /api/v1/pix/qrcode/decode
  2. Use the returned end_to_end_id as the X-Pix-Lookup-E2E header in this call
  3. The system retrieves pre-decoded data and processes the payment (without decoding again)

Required fields: amount + header X-Pix-Lookup-E2E

Scope: pix:cashout:write

Headers

X-Idempotency-KeystringOptionalformat: "uuid"

Prevents duplicate payments (recommended)

X-Pix-Lookup-E2EstringOptional

EndToEndID from a previous QR Code decode (required for Flow 3). Obtained from POST /api/v1/pix/qrcode/decode.

Request

This endpoint expects an object.
amountstringRequired
Payment amount in BRL
pix_keystringOptional

Recipient PIX key (required for Flow 1)

pix_key_typeenumOptional

PIX key type (required for Flow 1)

Allowed values:
receiver_namestringOptional

Recipient full name (required for Flow 2)

receiver_documentstringOptional

Recipient CPF or CNPJ (required for Flow 2)

receiver_ispbstringOptional

Recipient bank ISPB code, 8 digits (required for Flow 2)

receiver_branchstringOptional

Recipient branch number (required for Flow 2)

receiver_accountstringOptional

Recipient account number (required for Flow 2)

receiver_account_typeenumOptional

Recipient account type (required for Flow 2)

Allowed values:
external_idstringOptional

Cash-out ID in your system

descriptionstringOptional

Payment description (optional)

referencestringOptional

Your internal reference ID (optional)

metadataobjectOptional

Custom metadata (optional)

Response

Cash-Out initiated

successboolean
transaction_idstring
statusstring
amountstring
messagestring

Errors

400
Bad Request Error