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
      • GETList Transactions
      • GETGet Transaction by ID
LogoLogo
StatusDashboard
API ReferenceTransactions

Get Transaction by ID

GET
https://api.brzip.com.br/api/v1/transactions/:id
GET
/api/v1/transactions/:id
$curl https://api.brzip.com.br/api/v1/transactions/43b715d7-cc3d-4593-a0af-1e248d9953b0
1{
2  "success": true,
3  "data": {
4    "id": "43b715d7-cc3d-4593-a0af-1e248d9953b0",
5    "external_id": "01000000-dda7-55d6-6ed1-08de96d692af",
6    "reference": "pag-s1s22ssss2s",
7    "client_id": "a612b202-6690-4d24-ba35-2e36c8f3c0ce",
8    "type": "cash_out",
9    "amount": "0.10",
10    "gross_amount": "0.14",
11    "net_amount": "0.10",
12    "tax_amount": "0.04",
13    "currency": "BRL",
14    "status": "completed",
15    "pix_key": "6b631786-29c2-4f8b-b1ed-2b88a53cf8a4",
16    "pix_key_type": "evp",
17    "e2e": "E24722685202604100755GNZ5DGMBWZK",
18    "payer_name": "Joao Silveira da Silva",
19    "payer_document": "12345678901",
20    "receiver_name": "Alice Silveira da Silva",
21    "receiver_document": "98765432100",
22    "payer": {
23      "name": "Joao Silveira da Silva",
24      "document": "12345678901"
25    },
26    "receiver": {
27      "name": "Alice Silveira da Silva",
28      "document": "98765432100",
29      "bank": {
30        "ispb": "22896431",
31        "participant_name": "PICPAY",
32        "agency": "0001",
33        "account": "898130557",
34        "account_type": ""
35      }
36    },
37    "description": "Pagamento fornecedor",
38    "channel": "api",
39    "processed_at": "2026-04-10T07:55:51Z",
40    "created_at": "2026-04-10T07:55:45Z",
41    "updated_at": "2026-04-10T07:55:51Z",
42    "ledger_entries": [
43      {
44        "operation_type": "hold",
45        "amount": "0.140000",
46        "status": "completed",
47        "available_before": "5.590000",
48        "available_after": "5.450000",
49        "blocked_before": "20.000000",
50        "blocked_after": "20.140000",
51        "created_at": "2026-04-10T07:55:45Z"
52      }
53    ]
54  }
55}

Retrieves full details of a specific transaction by ID, including payer/receiver information, bank details, and ledger entries. Returns 404 if the transaction does not belong to the authenticated client.

Scope: Bearer JWT

Was this page helpful?
Previous

Get Limits

Next
Built with

Path parameters

idstringRequiredformat: "uuid"
Transaction ID

Response

Transaction details
successboolean
dataobject

Errors

404
Not Found Error