{ "info": { "_postman_id": "dfddf781-2121-473b-8a12-e67a2e4a5138", "name": "MONETIZZE-DOCS", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "42347077" }, "item": [ { "name": "v2 — Create Payment (sync)", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "YOUR_CLIENT_ID", "type": "string" }, { "key": "password", "value": "YOUR_SECRET_ID", "type": "string" } ] }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"externalId\": \"62e2e3433e33613a3c82e38\",\r\n \"amount\": 5,\r\n \"document\": \"12345678989\",\r\n \"name\": \"Fulano de tal\",\r\n \"identification\": \"\",\r\n \"expire\": 3600,\r\n \"description\": \"description\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://api.monetizze.app/api/v2/create-payment", "protocol": "https", "host": ["hub", "monetizze", "one"], "path": ["api", "v2", "create-payment"] }, "description": "Creates a synchronous PIX payment (v2). Uses Basic Auth. Returns PIX code and QR data immediately." }, "response": [] }, { "name": "v2 — Withdrawals", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "YOUR_CLIENT_ID", "type": "string" }, { "key": "password", "value": "YOUR_SECRET_ID", "type": "string" } ] }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"externalId\": \"wd_abc123\",\r\n \"pixKey\": \"fulano@email.com\",\r\n \"pixKeyType\": \"EMAIL\",\r\n \"documentNumber\": \"12345678901\",\r\n \"amount\": 50.00\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://api.monetizze.app/api/v2/withdrawals", "protocol": "https", "host": ["hub", "monetizze", "one"], "path": ["api", "v2", "withdrawals"] }, "description": "Process a PIX withdrawal using Basic Auth (v2). 2FA is skipped. The sender name is taken from the authenticated account." }, "response": [] }, { "name": "v2 — Boleto Pay", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "YOUR_CLIENT_ID", "type": "string" }, { "key": "password", "value": "YOUR_SECRET_ID", "type": "string" } ] }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"barcode\": \"07790001161242351436606752570454914270000001000\",\r\n \"amount\": 150.00\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://api.monetizze.app/api/v2/transactions/bankslip-out/payment", "protocol": "https", "host": ["hub", "monetizze", "one"], "path": ["api", "v2", "transactions", "bankslip-out", "payment"] }, "description": "Execute a boleto (bank slip) payment. Barcode is read internally. 2FA is always skipped via API." }, "response": [] }, { "name": "v2 — Boleto Status", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "YOUR_CLIENT_ID", "type": "string" }, { "key": "password", "value": "YOUR_SECRET_ID", "type": "string" } ] }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"barcode\": \"34191.79001 01043.510047 91020.150008 2 91070026000\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://api.monetizze.app/api/v2/transactions/bankslip-out/status", "protocol": "https", "host": ["hub", "monetizze", "one"], "path": ["api", "v2", "transactions", "bankslip-out", "status"] }, "description": "Checks boleto status using smart lookup. Accepts id, transaction_id, or barcode. Results are scoped to the authenticated account and allowed sub-accounts." }, "response": [] }, { "name": "v2 — Boleto History", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "YOUR_CLIENT_ID", "type": "string" }, { "key": "password", "value": "YOUR_SECRET_ID", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "https://api.monetizze.app/api/v2/boleto/history?page=1&limit=50", "protocol": "https", "host": ["hub", "monetizze", "one"], "path": ["api", "v2", "boleto", "history"], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "50" }, { "key": "status", "value": "paid", "disabled": true }, { "key": "date_filter", "value": "7", "disabled": true }, { "key": "search", "value": "", "disabled": true } ] }, "description": "Returns paginated boleto transaction history for the authenticated account." }, "response": [] }, { "name": "v2 — Exchange Markets", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "YOUR_CLIENT_ID", "type": "string" }, { "key": "password", "value": "YOUR_SECRET_ID", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "https://api.monetizze.app/api/v2/exchange/request/markets", "protocol": "https", "host": ["hub", "monetizze", "one"], "path": ["api", "v2", "exchange", "request", "markets"] }, "description": "Returns available cryptocurrencies with real-time buy and sell prices in BRL." }, "response": [] }, { "name": "v2 — Exchange Swaps List", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "YOUR_CLIENT_ID", "type": "string" }, { "key": "password", "value": "YOUR_SECRET_ID", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "https://api.monetizze.app/api/v2/exchange/request/swaps?page=1&limit=50", "protocol": "https", "host": ["hub", "monetizze", "one"], "path": ["api", "v2", "exchange", "request", "swaps"], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "50" }, { "key": "status", "value": "completed", "disabled": true }, { "key": "account_id", "value": "", "disabled": true }, { "key": "date_filter", "value": "30", "disabled": true }, { "key": "search", "value": "", "disabled": true } ] } }, "response": [] }, { "name": "v2 — Invoices: Create", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "YOUR_CLIENT_ID", "type": "string" }, { "key": "password", "value": "YOUR_SECRET_ID", "type": "string" } ] }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"code\": \"PEDIDO-1725231000\",\r\n \"customer\": {\r\n \"name\": \"Comprador da Silva\",\r\n \"document\": \"12345678909\",\r\n \"email\": \"comprador@example.com\",\r\n \"phone\": \"11999999999\"\r\n },\r\n \"items\": [\r\n {\r\n \"description\": \"Consultoria - Sprint 1\",\r\n \"amount\": 150000,\r\n \"quantity\": 1\r\n },\r\n {\r\n \"description\": \"Suporte adicional\",\r\n \"amount\": 5000,\r\n \"quantity\": 2\r\n }\r\n ],\r\n \"payments\": [\r\n {\r\n \"paymentMethod\": \"pix\",\r\n \"pix\": {\r\n \"expiresIn\": 3600\r\n }\r\n }\r\n ],\r\n \"description\": \"Nota interna opcional\",\r\n \"callbackUrl\": \"https://your-app.example.com/webhooks/charges\",\r\n \"expiresAt\": \"2026-09-30T23:59:59-03:00\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://api.monetizze.app/api/v2/invoices", "protocol": "https", "host": ["api", "monetizze", "one"], "path": ["api", "v2", "invoices"] }, "description": "Creates a payment charge in an order-like shape (pagar.me-inspired): items[] (amount per item, in cents) + customer{} + payments[]. The total is derived server-side from items, never sent directly. \"code\" is your own reference (idempotency: reusing one returns 409) — it is different from the response's \"invoiceCode\", which this system generates. When pix is in payments[], the copy-and-paste code is issued right away in the response's \"pix\" object; payments[].pix.expiresIn (seconds) overrides the QR validity for this charge. Only pix is accepted today; card and boleto are coming soon." }, "response": [] }, { "name": "v2 — Invoices: List", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "YOUR_CLIENT_ID", "type": "string" }, { "key": "password", "value": "YOUR_SECRET_ID", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "https://api.monetizze.app/api/v2/invoices?status=open&perPage=25", "protocol": "https", "host": ["api", "monetizze", "one"], "path": ["api", "v2", "invoices"], "query": [ { "key": "status", "value": "open" }, { "key": "perPage", "value": "25" }, { "key": "code", "value": "", "disabled": true }, { "key": "customerDocument", "value": "", "disabled": true }, { "key": "createdFrom", "value": "", "disabled": true }, { "key": "createdTo", "value": "", "disabled": true } ] }, "description": "Lists the charges of the authenticated account, newest first. Filters: status (open|paid|expired|canceled), method, code (your reference, set at creation), customerDocument, createdFrom, createdTo. Paginated via page/perPage (max 100)." }, "response": [] }, { "name": "v2 — Invoices: Retrieve", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [], "url": { "raw": "https://api.monetizze.app/api/v2/invoices/{{invoiceUuid}}", "protocol": "https", "host": ["api", "monetizze", "one"], "path": ["api", "v2", "invoices", "{{invoiceUuid}}"] }, "description": "Public — no authentication required. Returns a single charge, including the current Pix code (while it is still valid) and the settled payment reference. The uuid itself is the access token for this one charge; anyone holding it can read this charge, but not other charges of the account." }, "response": [] }, { "name": "v2 — Invoices: Cancel", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "YOUR_CLIENT_ID", "type": "string" }, { "key": "password", "value": "YOUR_SECRET_ID", "type": "string" } ] }, "method": "POST", "header": [], "url": { "raw": "https://api.monetizze.app/api/v2/invoices/{{invoiceUuid}}/cancel", "protocol": "https", "host": ["api", "monetizze", "one"], "path": ["api", "v2", "invoices", "{{invoiceUuid}}", "cancel"] }, "description": "Cancels an open charge. A paid charge cannot be canceled and returns 422." }, "response": [] }, { "name": "v2 — Invoices: Issue Pix QR Code", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [], "url": { "raw": "https://api.monetizze.app/api/v2/invoices/{{invoiceUuid}}/qrcode", "protocol": "https", "host": ["api", "monetizze", "one"], "path": ["api", "v2", "invoices", "{{invoiceUuid}}", "qrcode"] }, "description": "Public — no authentication required, same rationale as Retrieve. Issues the Pix code so you can render your own checkout. If the current code is still within its validity window it is returned unchanged: two payable codes for the same charge would allow a duplicate payment." }, "response": [] }, { "name": "v2 — Transaction Status", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "YOUR_CLIENT_ID", "type": "string" }, { "key": "password", "value": "YOUR_CLIENT_SECRET", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"YOUR_EXTERNAL_ID_OR_PROVIDER_ID\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://api.monetizze.app/api/v2/transaction/status", "protocol": "https", "host": ["api", "monetizze", "one"], "path": ["api", "v2", "transaction", "status"] }, "description": "Returns the local status of an IN or OUT transaction. Searches by external_payment_id or provider_transaction_id and is strictly scoped to the account authenticated with Basic Auth. A failed or canceled OUT transaction returns status CANCELED (uppercase, with one L), matching the payout webhook. HTTP 200 confirms that the lookup succeeded, not that the payout succeeded. The detailed failure reason is not returned by this endpoint; when available, it is sent in the PAYOUT_CANCELED webhook through reason_cancelled. The successful response includes debitor.name and debitor.taxId (CPF or CNPJ) from the data stored with the payment. Example: {\"success\":true,\"externalId\":\"payin-order-123\",\"providerTransactionId\":\"E00416968202511100200KYh0fOaevTK\",\"status\":\"paid\",\"type\":\"IN\",\"amount\":100.00,\"debitor\":{\"name\":\"Pagador\",\"taxId\":\"12346578900\"}}" }, "response": [] }, { "name": "v2 — Official PIX OUT Receipt", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "YOUR_CLIENT_ID", "type": "string" }, { "key": "password", "value": "YOUR_CLIENT_SECRET", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "https://api.monetizze.app/api/v2/transactions/{{transactionId}}/receipt", "protocol": "https", "host": ["api", "monetizze", "one"], "path": ["api", "v2", "transactions", "{{transactionId}}", "receipt"] }, "description": "Returns the official Banprime receipt for a completed PIX OUT transaction. transactionId accepts externalId or providerTransactionId. Uses Basic Auth only. Access is limited to the authenticated account and its direct subaccounts in the same tenant. The response is JSON only; CPF/CNPJ values are masked. Eligible transactions must be OUT, PIX, paid, and processed by Banprime." }, "response": [ { "name": "200 — Official receipt", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "https://api.monetizze.app/api/v2/transactions/PAYOUT-123/receipt", "protocol": "https", "host": ["api", "monetizze", "one"], "path": ["api", "v2", "transactions", "PAYOUT-123", "receipt"] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"data\": {\n \"account_id\": 123,\n \"external_id\": \"PAYOUT-123\",\n \"transaction_id\": \"ABC123\",\n \"end_to_end_id\": \"E0000000020261105000000000000000\",\n \"amount\": \"100.00\",\n \"status\": \"CONFIRMED\",\n \"performed_at\": \"2026-11-05T13:20:00-03:00\",\n \"payer\": {\n \"name\": \"EMPRESA PAGADORA\",\n \"document\": \"**.345.678/****-**\",\n \"institution\": \"BANPRIME\"\n },\n \"receiver\": {\n \"name\": \"BENEFICIARIO\",\n \"document\": \"***.456.789-**\",\n \"institution\": \"BANCO DESTINO\",\n \"pix_key\": \"chave@example.com\"\n },\n \"source\": \"banprime\",\n \"official\": true,\n \"retrieved_from\": \"banprime\"\n }\n}" } ] }, { "name": "v2 — Accounts Balances", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "YOUR_CLIENT_ID", "type": "string" }, { "key": "password", "value": "YOUR_CLIENT_SECRET", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://api.monetizze.app/api/v2/accounts-balances", "protocol": "https", "host": ["api", "monetizze", "one"], "path": ["api", "v2", "accounts-balances"] }, "description": "Returns separate balance records for the authenticated account and its active direct subaccounts in the same tenant. The request has no account identifier and the response intentionally has no consolidated total. Inactive and deleted subaccounts are excluded." }, "response": [] }, { "name": "v1 — Login (JWT)", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"email\": \"email@email.com\",\r\n \"password\": \"123456\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://api.monetizze.app/api/login", "protocol": "https", "host": ["hub", "monetizze", "one"], "path": ["api", "login"] } }, "response": [] }, { "name": "v1 — Balance", "request": { "auth": { "type": "bearer", "bearer": [{ "key": "token", "value": "YOUR_JWT_TOKEN", "type": "string" }] }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://api.monetizze.app/api/balance", "protocol": "https", "host": ["hub", "monetizze", "one"], "path": ["api", "balance"] }, "description": "Returns withdrawable_balance, other_active_balances, total_available_balance, blocked_balance." }, "response": [] }, { "name": "v1 — Transaction Status", "request": { "auth": { "type": "bearer", "bearer": [{ "key": "token", "value": "YOUR_JWT_TOKEN", "type": "string" }] }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"id\": \"YOUR_EXTERNAL_ID_OR_PROVIDER_ID\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://api.monetizze.app/api/transaction/status", "protocol": "https", "host": ["hub", "monetizze", "one"], "path": ["api", "transaction", "status"] }, "description": "Search by externalId or providerTransactionId. A failed or canceled OUT transaction returns status CANCELED (uppercase, with one L), matching the payout webhook. HTTP 200 confirms that the lookup succeeded, not that the payout succeeded. The detailed failure reason is not returned by this endpoint; when available, it is sent in the PAYOUT_CANCELED webhook through reason_cancelled." }, "response": [] }, { "name": "v1 — Transactions Filter", "request": { "auth": { "type": "bearer", "bearer": [{ "key": "token", "value": "YOUR_JWT_TOKEN", "type": "string" }] }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"status\": \"paid\",\n \"type_transaction\": \"IN\",\n \"date_from\": \"2025-01-01\",\n \"date_to\": \"2025-01-31\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://api.monetizze.app/api/transactions", "protocol": "https", "host": ["hub", "monetizze", "one"], "path": ["api", "transactions"] } }, "response": [] }, { "name": "v1 — Transactions Totals", "request": { "auth": { "type": "bearer", "bearer": [{ "key": "token", "value": "YOUR_JWT_TOKEN", "type": "string" }] }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"startDate\": \"2025-01-01\",\n \"endDate\": \"2025-01-31\",\n \"type_transaction\": \"IN\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://api.monetizze.app/api/transactions/totals", "protocol": "https", "host": ["hub", "monetizze", "one"], "path": ["api", "transactions", "totals"] } }, "response": [] }, { "name": "v1 — Create Payment", "request": { "auth": { "type": "bearer" }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"externalId\": \"62e2e3433e33613a3c82e38\",\r\n \"amount\": 5,\r\n \"document\": \"12345678989\",\r\n \"name\": \"Fulano de tal\",\r\n \"identification\": \"\",\r\n \"expire\": 3600,\r\n \"description\": \"description\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://api.monetizze.app/api/create-payment", "protocol": "https", "host": ["hub", "monetizze", "one"], "path": ["api", "create-payment"] } }, "response": [] }, { "name": "v1 — Withdrawals", "request": { "auth": { "type": "bearer", "bearer": [{ "key": "token", "value": "YOUR_JWT_TOKEN", "type": "string" }] }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"externalId\": \"wd_691f24f937\",\r\n \"pixKey\": \"44e75e18-2414-4de3-88fc\",\r\n \"pixKeyType\": \"EVP\",\r\n \"documentNumber\": \"00000000000\",\r\n \"amount\": 2\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://api.monetizze.app/api/withdrawals", "protocol": "https", "host": ["hub", "monetizze", "one"], "path": ["api", "withdrawals"] } }, "response": [] }, { "name": "Health Check", "request": { "method": "GET", "header": [], "url": { "raw": "https://api.monetizze.app/api/health", "protocol": "https", "host": ["hub", "monetizze", "one"], "path": ["api", "health"] }, "description": "Returns {status: healthy} (200) or {status: unhealthy, database: unreachable} (503)." }, "response": [] } ] }