{ "item": [ { "id": "86b828b7-746f-4e9f-a2a8-0428f62c475f", "name": "Pix Operations", "description": { "content": "Create and manage Pix charges (deposits)", "type": "text/plain" }, "item": [ { "id": "0c3a9240-df8c-433a-b384-1666b7353656", "name": "Create Charge (Pix deposit)", "request": { "name": "Create Charge (Pix deposit)", "description": { "content": "Create a new Pix **deposit** (charge). Returns QR Code and transaction details.", "type": "text/plain" }, "url": { "path": [ "pix" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"amount\": 10.9,\n \"callbackUrl\": \"https://webhook.cool/\",\n \"generatedName\": \"John Doe\",\n \"generatedEmail\": \"john.doe@example.com\",\n \"generatedDocument\": \"12345678901\",\n \"expiresIn\": 600,\n \"clientReference\": \"order_12345\",\n \"virtualAccount\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1555f73c-8419-444c-9dbc-560a65449166", "name": "Charge created", "originalRequest": { "url": { "path": [ "pix" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 10.9,\n \"callbackUrl\": \"https://webhook.cool/\",\n \"generatedName\": \"John Doe\",\n \"generatedEmail\": \"john.doe@example.com\",\n \"generatedDocument\": \"12345678901\",\n \"expiresIn\": 600,\n \"clientReference\": \"order_12345\",\n \"virtualAccount\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"PIX20250817215911F49RDOBJ\",\n \"status\": \"PENDING\",\n \"amount\": 10,\n \"type\": \"DEPOSIT\",\n \"qrCodeText\": \"00020126870014br.gov.bcb.pix2565qrcode.pix.com.br/dynamic/d7790b91-3979-4ad5-9d96-ee941e5a42765204000053039865802BR5908PIXPLUS6009SAO PAULO62070503***63047EE4\",\n \"qrCodeBase64\": \"iVBORw0KGgoAAAANSUhEUgAAAZAAAAGQCAYAAAC...\",\n \"qrCodeUrl\": \"https://pix.pix.com.br/v1/pix/qr-code/PIX20250817215911F49RDOBJ\",\n \"generatedName\": \"John Doe\",\n \"generatedDocument\": \"12345678901\",\n \"generatedEmail\": \"john.doe@example.com\",\n \"serviceFeeCharged\": 0.115,\n \"payerName\": null,\n \"payerDocument\": null,\n \"payerInstitutionIspb\": null,\n \"payerInstitutionName\": null,\n \"payerAccountNumber\": null,\n \"receiverName\": null,\n \"receiverDocument\": null,\n \"receiverInstitutionIspb\": null,\n \"receiverInstitutionName\": null,\n \"receiverAccountNumber\": \"513579\",\n \"endToEndId\": null,\n \"createdAt\": \"2025-08-17T21:59:11.579Z\",\n \"updatedAt\": \"2025-08-17T21:59:11.579Z\",\n \"paidAt\": null,\n \"withdrawPixKey\": null,\n \"withdrawPixType\": null,\n \"clientReference\": \"order_12345\",\n \"refundEndToEndId\": null,\n \"refundAmount\": null,\n \"refundStatus\": null,\n \"refundReason\": null,\n \"refundDescription\": null,\n \"refundedAt\": null,\n \"cancellationReason\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11e2cf98-f1d5-4be8-abbc-1e8440ea5aad", "name": "Bad Request, payload or query string failed validation", "originalRequest": { "url": { "path": [ "pix" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 10.9,\n \"callbackUrl\": \"https://webhook.cool/\",\n \"generatedName\": \"John Doe\",\n \"generatedEmail\": \"john.doe@example.com\",\n \"generatedDocument\": \"12345678901\",\n \"expiresIn\": 600,\n \"clientReference\": \"order_12345\",\n \"virtualAccount\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"querystring/dateFrom Invalid input: expected string, received undefined\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a4698ad6-fc58-4655-85fa-0f64f1a875a1", "name": "Unauthorized, missing or invalid Bearer token, or token lacks the required permission for this endpoint", "originalRequest": { "url": { "path": [ "pix" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 10.9,\n \"callbackUrl\": \"https://webhook.cool/\",\n \"generatedName\": \"John Doe\",\n \"generatedEmail\": \"john.doe@example.com\",\n \"generatedDocument\": \"12345678901\",\n \"expiresIn\": 600,\n \"clientReference\": \"order_12345\",\n \"virtualAccount\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 401,\n \"error\": \"Unauthorized\",\n \"message\": \"Missing or invalid Bearer token\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "73916567-3030-4f7f-90dd-ad3ae15d4b96", "name": "Retrieve Charge", "request": { "name": "Retrieve Charge", "description": { "content": "Get the latest status and details for a Pix **deposit (charge)**. Provide **one** of `id`, `clientReference`, or `endToEndId`. Combining more than one returns an error.", "type": "text/plain" }, "url": { "path": [ "pix" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "id", "value": "PIX20250817215911F49RDOBJ", "description": "Transaction ID." }, { "disabled": false, "key": "clientReference", "value": "string", "description": "External reference provided when creating the charge." }, { "disabled": false, "key": "endToEndId", "value": "string", "description": "Pix end-to-end ID." }, { "disabled": false, "key": "virtualAccount", "value": "string", "description": "Virtual sub-account (up to 50 characters) used at creation. Accepted as an alternative lookup key." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "83e1c471-2c82-4080-bd5d-2015778bf252", "name": "Current transaction state", "originalRequest": { "url": { "path": [ "pix" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "id", "value": "PIX20250817215911F49RDOBJ" }, { "key": "clientReference", "value": "string" }, { "key": "endToEndId", "value": "string" }, { "key": "virtualAccount", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"PIX20250817215911F49RDOBJ\",\n \"status\": \"PENDING\",\n \"amount\": 10,\n \"type\": \"DEPOSIT\",\n \"qrCodeText\": \"00020126870014br.gov.bcb.pix2565qrcode.pix.com.br/dynamic/d7790b91-3979-4ad5-9d96-ee941e5a42765204000053039865802BR5908PIXPLUS6009SAO PAULO62070503***63047EE4\",\n \"qrCodeBase64\": \"iVBORw0KGgoAAAANSUhEUgAAAZAAAAGQCAYAAAC...\",\n \"qrCodeUrl\": \"https://pix.pix.com.br/v1/pix/qr-code/PIX20250817215911F49RDOBJ\",\n \"generatedName\": \"John Doe\",\n \"generatedDocument\": \"12345678901\",\n \"generatedEmail\": \"john.doe@example.com\",\n \"serviceFeeCharged\": 0.115,\n \"payerName\": null,\n \"payerDocument\": null,\n \"payerInstitutionIspb\": null,\n \"payerInstitutionName\": null,\n \"payerAccountNumber\": null,\n \"receiverName\": null,\n \"receiverDocument\": null,\n \"receiverInstitutionIspb\": null,\n \"receiverInstitutionName\": null,\n \"receiverAccountNumber\": \"513579\",\n \"endToEndId\": null,\n \"createdAt\": \"2025-08-17T21:59:11.579Z\",\n \"updatedAt\": \"2025-08-17T21:59:11.579Z\",\n \"paidAt\": null,\n \"withdrawPixKey\": null,\n \"withdrawPixType\": null,\n \"clientReference\": \"order_12345\",\n \"refundEndToEndId\": null,\n \"refundAmount\": null,\n \"refundStatus\": null,\n \"refundReason\": null,\n \"refundDescription\": null,\n \"refundedAt\": null,\n \"cancellationReason\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d3ddb235-a086-4462-ab6d-a4c9db643e0b", "name": "Bad Request, payload or query string failed validation", "originalRequest": { "url": { "path": [ "pix" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "id", "value": "PIX20250817215911F49RDOBJ" }, { "key": "clientReference", "value": "string" }, { "key": "endToEndId", "value": "string" }, { "key": "virtualAccount", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"querystring/dateFrom Invalid input: expected string, received undefined\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b043ec7f-6d23-4113-ae84-ec59228d1cbb", "name": "Unauthorized, missing or invalid Bearer token, or token lacks the required permission for this endpoint", "originalRequest": { "url": { "path": [ "pix" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "id", "value": "PIX20250817215911F49RDOBJ" }, { "key": "clientReference", "value": "string" }, { "key": "endToEndId", "value": "string" }, { "key": "virtualAccount", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 401,\n \"error\": \"Unauthorized\",\n \"message\": \"Missing or invalid Bearer token\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e66d9694-b855-4da3-a431-f5139a51d8b6", "name": "Resource not found", "originalRequest": { "url": { "path": [ "pix" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "id", "value": "PIX20250817215911F49RDOBJ" }, { "key": "clientReference", "value": "string" }, { "key": "endToEndId", "value": "string" }, { "key": "virtualAccount", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 404,\n \"error\": \"Not Found\",\n \"message\": \"Resource not found\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1f3dbad7-46f7-4a51-b419-00343a619c16", "name": "Get Transaction Receipt", "request": { "name": "Get Transaction Receipt", "description": { "content": "Returns the transaction receipt as JSON with a `base64` field (encoded PDF). Decode it to display or save as `.pdf`.", "type": "text/plain" }, "url": { "path": [ "proof", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "type", "value": "pdf", "description": "Return format." } ], "variable": [ { "disabled": false, "type": "any", "value": "PIX2025081418333632CYKN8M", "key": "id", "description": "(Required) Transaction ID." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "aabcc1d9-fd36-48f5-857b-d00738422756", "name": "Base64 if `type=base64`, otherwise binary PDF.", "originalRequest": { "url": { "path": [ "proof", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "type", "value": "pdf" } ], "variable": [ { "disabled": false, "type": "any", "value": "PIX2025081418333632CYKN8M", "key": "id", "description": "(Required) Transaction ID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"base64\": \"JVBERi0xLjQKJ...\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "61791ed1-105c-4ce1-9547-ce35928cddd4", "name": "Bad Request, payload or query string failed validation", "originalRequest": { "url": { "path": [ "proof", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "type", "value": "pdf" } ], "variable": [ { "disabled": false, "type": "any", "value": "PIX2025081418333632CYKN8M", "key": "id", "description": "(Required) Transaction ID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"querystring/type Invalid input\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e7d4a21b-852c-4333-a7bf-22d5d53ec428", "name": "Unauthorized, missing or invalid Bearer token, or token lacks the required permission for this endpoint", "originalRequest": { "url": { "path": [ "proof", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "type", "value": "pdf" } ], "variable": [ { "disabled": false, "type": "any", "value": "PIX2025081418333632CYKN8M", "key": "id", "description": "(Required) Transaction ID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 401,\n \"error\": \"Unauthorized\",\n \"message\": \"Missing or invalid Bearer token\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad3b1e96-3556-4df7-acfd-5fc1df0c1036", "name": "Resource not found", "originalRequest": { "url": { "path": [ "proof", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "type", "value": "pdf" } ], "variable": [ { "disabled": false, "type": "any", "value": "PIX2025081418333632CYKN8M", "key": "id", "description": "(Required) Transaction ID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 404,\n \"error\": \"Not Found\",\n \"message\": \"Resource not found\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b20509fe-3dd4-4969-b2c9-bf19e13edf3a", "name": "Render Pix QR code (PNG)", "request": { "name": "Render Pix QR code (PNG)", "description": { "content": "Render the Pix QR Code of a deposit as a binary PNG image", "type": "text/plain" }, "url": { "path": [ "pix", "qr-code", ":transactionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transactionId", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "image/png" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c0e12eb2-ab03-454e-827e-db0154f1d918", "name": "QR code image", "originalRequest": { "url": { "path": [ "pix", "qr-code", ":transactionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transactionId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "image/png" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "image/png" } ], "body": "string", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "13fe2a56-57f3-445d-ab1a-ad9f07e2313c", "name": "Transaction is not a DEPOSIT or has no QR code", "originalRequest": { "url": { "path": [ "pix", "qr-code", ":transactionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transactionId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"querystring/dateFrom Invalid input: expected string, received undefined\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b7315c2-6728-4d64-b277-353d26aa0016", "name": "Transaction not found", "originalRequest": { "url": { "path": [ "pix", "qr-code", ":transactionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transactionId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 404,\n \"error\": \"Not Found\",\n \"message\": \"Resource not found\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "d48622ca-bedf-4ff9-838c-7979f3d7dace", "name": "Withdrawals", "description": { "content": "Send money via Pix (cash out) and DICT key/QR-code consultation", "type": "text/plain" }, "item": [ { "id": "00d6014b-2924-448c-8ef8-43d098a73131", "name": "Dict Pix Key Lookup", "request": { "name": "Dict Pix Key Lookup", "description": { "content": "Query the DICT (Diretório de Identificadores de Contas Transacionais) to retrieve information about a Pix key before sending a payment. Returns the key owner's details and associated financial institution.", "type": "text/plain" }, "url": { "path": [ "pix", "key" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "pixKey", "value": "example@pix.com.br", "description": "(Required) The Pix key to lookup (CPF, CNPJ, email, phone, or EVP)." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "3c4541e1-3181-4b67-9ddc-5bad0ca1a990", "name": "Pix key information retrieved successfully", "originalRequest": { "url": { "path": [ "pix", "key" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "pixKey", "value": "example@pix.com.br" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"pixKey\": \"5c8999e2-6b29-468b-b4e9-04d4872b1bc4\",\n \"document\": \"**.345.678/****-**\",\n \"name\": \"EMPRESA EXEMPLO LTDA\",\n \"branch\": \"****\",\n \"accountNumber\": \"*******\",\n \"personType\": \"PJ\",\n \"accountType\": \"CACC\",\n \"institutionIspb\": \"12345678\",\n \"institutionCode\": \"001\",\n \"institutionName\": \"BANCO EXEMPLO S.A.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6be89462-8ca9-497c-ba14-cab62d470c95", "name": "Invalid Pix key format", "originalRequest": { "url": { "path": [ "pix", "key" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "pixKey", "value": "example@pix.com.br" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"querystring/dateFrom Invalid input: expected string, received undefined\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e92d0ee7-1c0f-42cb-95bb-ab20178193c8", "name": "Pix key not found in DICT", "originalRequest": { "url": { "path": [ "pix", "key" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "pixKey", "value": "example@pix.com.br" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 404,\n \"error\": \"Not Found\",\n \"message\": \"Resource not found\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d30a967b-ba5f-4a1a-9189-833ea2e70310", "name": "Read QR Code", "request": { "name": "Read QR Code", "description": { "content": "Decode and extract information from a Pix QR Code (EMV format) before making a payment. Returns the parsed data including receiver details, amount (if present), and other QR Code metadata. Currently Pix Processamento only supports dynamic QR Codes. Static QR Codes are not processed yet.", "type": "text/plain" }, "url": { "path": [ "pix", "qrcode", "read" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"emv\": \"00020101021226770014br.gov.bcb.pix2555api.pix/pix/qr/v2/013318d6-2d7d-479e-8bb3-b5c7b9da688c5204000053039865802BR5916PIX 6007SAOPAULO6217051320260118278956304EC55\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d7934cf9-bd09-4553-8720-7de7cebdf29e", "name": "QR Code decoded successfully", "originalRequest": { "url": { "path": [ "pix", "qrcode", "read" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"emv\": \"00020101021226770014br.gov.bcb.pix2555api.pix/pix/qr/v2/013318d6-2d7d-479e-8bb3-b5c7b9da688c5204000053039865802BR5916PIX 6007SAOPAULO6217051320260118278956304EC55\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"qrCodeType\": \"DYNAMIC\",\n \"name\": \"LOJA EXEMPLO LTDA\",\n \"document\": \"12345678000199\",\n \"amount\": 10,\n \"originalAmount\": 10,\n \"txid\": \"c5886b83f0254d0dbfc3900f72d5a8d1\",\n \"additionalInfo\": null,\n \"expiresIn\": 1799,\n \"createdAt\": \"2026-02-03T22:59:36.138\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab6e6f95-a6c5-4465-99eb-ccbd63d808a2", "name": "Invalid QR Code format", "originalRequest": { "url": { "path": [ "pix", "qrcode", "read" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"emv\": \"00020101021226770014br.gov.bcb.pix2555api.pix/pix/qr/v2/013318d6-2d7d-479e-8bb3-b5c7b9da688c5204000053039865802BR5916PIX 6007SAOPAULO6217051320260118278956304EC55\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"querystring/dateFrom Invalid input: expected string, received undefined\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "98b111a6-3201-4aed-a288-5b6324de1719", "name": "Create Withdrawal (Pix key)", "request": { "name": "Create Withdrawal (Pix key)", "description": { "content": "Send a Pix **cash out** to the specified Pix key.", "type": "text/plain" }, "url": { "path": [ "withdraw" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"amount\": 2,\n \"pixKey\": \"teste@teste.com\",\n \"pixType\": \"email\",\n \"callbackUrl\": \"https://webhook.cool/\",\n \"clientReference\": \"withdraw_98765\",\n \"description\": \"Weekly payout\",\n \"virtualAccount\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "66bbfe73-96df-41c0-bbe6-5b2bee074ba0", "name": "Withdrawal created", "originalRequest": { "url": { "path": [ "withdraw" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 2,\n \"pixKey\": \"teste@teste.com\",\n \"pixType\": \"email\",\n \"callbackUrl\": \"https://webhook.cool/\",\n \"clientReference\": \"withdraw_98765\",\n \"description\": \"Weekly payout\",\n \"virtualAccount\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"PIX2025081721512946OOLK75\",\n \"status\": \"PENDING\",\n \"amount\": 2,\n \"type\": \"WITHDRAW\",\n \"qrCodeText\": null,\n \"qrCodeBase64\": null,\n \"qrCodeUrl\": null,\n \"generatedName\": null,\n \"generatedDocument\": null,\n \"generatedEmail\": null,\n \"payerName\": null,\n \"payerDocument\": null,\n \"payerInstitutionIspb\": null,\n \"payerInstitutionName\": null,\n \"payerAccountNumber\": \"513579\",\n \"serviceFeeCharged\": 1,\n \"withdrawPixKey\": \"teste@teste.com\",\n \"withdrawPixType\": \"email\",\n \"receiverName\": null,\n \"receiverDocument\": null,\n \"receiverInstitutionIspb\": null,\n \"receiverInstitutionName\": null,\n \"receiverAccountNumber\": null,\n \"endToEndId\": null,\n \"createdAt\": \"2025-08-17T21:51:29.748Z\",\n \"updatedAt\": \"2025-08-17T21:51:29.748Z\",\n \"paidAt\": null,\n \"clientReference\": \"withdraw_98765\",\n \"refundEndToEndId\": null,\n \"refundAmount\": null,\n \"refundStatus\": null,\n \"refundReason\": null,\n \"refundDescription\": null,\n \"refundedAt\": null,\n \"cancellationReason\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7edb5c01-5635-4217-bf0e-5d4e45af6327", "name": "Bad Request, payload or query string failed validation", "originalRequest": { "url": { "path": [ "withdraw" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 2,\n \"pixKey\": \"teste@teste.com\",\n \"pixType\": \"email\",\n \"callbackUrl\": \"https://webhook.cool/\",\n \"clientReference\": \"withdraw_98765\",\n \"description\": \"Weekly payout\",\n \"virtualAccount\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"querystring/dateFrom Invalid input: expected string, received undefined\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df8343aa-e907-4a2a-bf9a-3cae074d6c73", "name": "Unauthorized, missing or invalid Bearer token, or token lacks the required permission for this endpoint", "originalRequest": { "url": { "path": [ "withdraw" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 2,\n \"pixKey\": \"teste@teste.com\",\n \"pixType\": \"email\",\n \"callbackUrl\": \"https://webhook.cool/\",\n \"clientReference\": \"withdraw_98765\",\n \"description\": \"Weekly payout\",\n \"virtualAccount\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 401,\n \"error\": \"Unauthorized\",\n \"message\": \"Missing or invalid Bearer token\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9ffcec0b-7afd-4df0-99c0-9bae85e69857", "name": "Retrieve Withdrawal", "request": { "name": "Retrieve Withdrawal", "description": { "content": "Get the latest status and details for a withdrawal. Provide at least one of `id`, `clientReference`, or `endToEndId`. If more than one is provided, all are applied as filters (AND), which may return no record if they do not point to the same transaction.", "type": "text/plain" }, "url": { "path": [ "withdraw" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "id", "value": "PIX2025081721512946OOLK75", "description": "Transaction ID." }, { "disabled": false, "key": "clientReference", "value": "string", "description": "External reference provided when creating the withdrawal." }, { "disabled": false, "key": "endToEndId", "value": "string", "description": "Pix end-to-end ID." }, { "disabled": false, "key": "virtualAccount", "value": "string", "description": "Virtual sub-account (up to 50 characters) used at creation. Accepted as an alternative lookup key." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "706b979b-d7bf-4476-a78f-76d187d5e71b", "name": "Current withdrawal state", "originalRequest": { "url": { "path": [ "withdraw" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "id", "value": "PIX2025081721512946OOLK75" }, { "key": "clientReference", "value": "string" }, { "key": "endToEndId", "value": "string" }, { "key": "virtualAccount", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"PIX2025081721512946OOLK75\",\n \"status\": \"PENDING\",\n \"amount\": 2,\n \"type\": \"WITHDRAW\",\n \"qrCodeText\": null,\n \"qrCodeBase64\": null,\n \"qrCodeUrl\": null,\n \"generatedName\": null,\n \"generatedDocument\": null,\n \"generatedEmail\": null,\n \"payerName\": null,\n \"payerDocument\": null,\n \"payerInstitutionIspb\": null,\n \"payerInstitutionName\": null,\n \"payerAccountNumber\": \"513579\",\n \"serviceFeeCharged\": 1,\n \"withdrawPixKey\": \"teste@teste.com\",\n \"withdrawPixType\": \"email\",\n \"receiverName\": null,\n \"receiverDocument\": null,\n \"receiverInstitutionIspb\": null,\n \"receiverInstitutionName\": null,\n \"receiverAccountNumber\": null,\n \"endToEndId\": null,\n \"createdAt\": \"2025-08-17T21:51:29.748Z\",\n \"updatedAt\": \"2025-08-17T21:51:29.748Z\",\n \"paidAt\": null,\n \"clientReference\": \"withdraw_98765\",\n \"refundEndToEndId\": null,\n \"refundAmount\": null,\n \"refundStatus\": null,\n \"refundReason\": null,\n \"refundDescription\": null,\n \"refundedAt\": null,\n \"cancellationReason\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18fecfb2-c930-470e-bc66-5ed0eafdb8d0", "name": "Bad Request, payload or query string failed validation", "originalRequest": { "url": { "path": [ "withdraw" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "id", "value": "PIX2025081721512946OOLK75" }, { "key": "clientReference", "value": "string" }, { "key": "endToEndId", "value": "string" }, { "key": "virtualAccount", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"querystring/dateFrom Invalid input: expected string, received undefined\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8119e140-f82c-4ab0-9200-f132729dd49a", "name": "Unauthorized, missing or invalid Bearer token, or token lacks the required permission for this endpoint", "originalRequest": { "url": { "path": [ "withdraw" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "id", "value": "PIX2025081721512946OOLK75" }, { "key": "clientReference", "value": "string" }, { "key": "endToEndId", "value": "string" }, { "key": "virtualAccount", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 401,\n \"error\": \"Unauthorized\",\n \"message\": \"Missing or invalid Bearer token\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e6d56103-4591-427e-989b-a6c417657846", "name": "Resource not found", "originalRequest": { "url": { "path": [ "withdraw" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "id", "value": "PIX2025081721512946OOLK75" }, { "key": "clientReference", "value": "string" }, { "key": "endToEndId", "value": "string" }, { "key": "virtualAccount", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 404,\n \"error\": \"Not Found\",\n \"message\": \"Resource not found\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1f3e7ad7-918c-479f-ba92-3f38d01b7a85", "name": "Create Withdrawal using QR Code", "request": { "name": "Create Withdrawal using QR Code", "description": { "content": "Cash out using a **Pix QR Code** (static/dynamic). If `amount` is not provided, the QR Code's embedded value will be used. Currently Pix Processamento only supports dynamic QR Codes. Static QR Codes are not processed yet.", "type": "text/plain" }, "url": { "path": [ "withdraw", "qrcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"qrCode\": \"00020101021226770014br.gov.bcb.pix2555api.pix/pix/qr/v2/013318d6-2d7d-479e-8bb3-b5c7b9da688c5204000053039865802BR5916PIX 6007SAOPAULO6217051320260118278956304EC55\",\n \"amount\": 20,\n \"callbackUrl\": \"https://webhook.cool/\",\n \"description\": \"Pagamento via QR Code\",\n \"clientReference\": \"order-123\",\n \"virtualAccount\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4d62e810-4d76-44fc-9bc2-0d035d55d772", "name": "Withdrawal created from QR Code", "originalRequest": { "url": { "path": [ "withdraw", "qrcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"qrCode\": \"00020101021226770014br.gov.bcb.pix2555api.pix/pix/qr/v2/013318d6-2d7d-479e-8bb3-b5c7b9da688c5204000053039865802BR5916PIX 6007SAOPAULO6217051320260118278956304EC55\",\n \"amount\": 20,\n \"callbackUrl\": \"https://webhook.cool/\",\n \"description\": \"Pagamento via QR Code\",\n \"clientReference\": \"order-123\",\n \"virtualAccount\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"PIX202511061998787515D0PH2Y\",\n \"status\": \"PENDING\",\n \"amount\": 20,\n \"type\": \"WITHDRAW\",\n \"qrCodeText\": null,\n \"qrCodeBase64\": null,\n \"qrCodeUrl\": null,\n \"generatedName\": null,\n \"generatedDocument\": null,\n \"generatedEmail\": null,\n \"serviceFeeCharged\": 1,\n \"payerName\": null,\n \"payerDocument\": null,\n \"payerInstitutionIspb\": null,\n \"payerInstitutionName\": null,\n \"payerAccountNumber\": \"513579\",\n \"withdrawPixKey\": \"88888888888\",\n \"withdrawPixType\": \"cpf\",\n \"receiverName\": null,\n \"receiverDocument\": null,\n \"receiverInstitutionIspb\": null,\n \"receiverInstitutionName\": null,\n \"receiverAccountNumber\": null,\n \"endToEndId\": null,\n \"createdAt\": \"2025-11-06T19:08:55.848Z\",\n \"updatedAt\": \"2025-11-06T19:08:55.848Z\",\n \"paidAt\": null,\n \"clientReference\": \"order-123\",\n \"refundEndToEndId\": null,\n \"refundAmount\": null,\n \"refundStatus\": null,\n \"refundReason\": null,\n \"refundDescription\": null,\n \"refundedAt\": null,\n \"cancellationReason\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e78ac065-8a76-4536-b5b7-701e673a2492", "name": "Invalid QR Code or missing amount for static QR Code without value", "originalRequest": { "url": { "path": [ "withdraw", "qrcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"qrCode\": \"00020101021226770014br.gov.bcb.pix2555api.pix/pix/qr/v2/013318d6-2d7d-479e-8bb3-b5c7b9da688c5204000053039865802BR5916PIX 6007SAOPAULO6217051320260118278956304EC55\",\n \"amount\": 20,\n \"callbackUrl\": \"https://webhook.cool/\",\n \"description\": \"Pagamento via QR Code\",\n \"clientReference\": \"order-123\",\n \"virtualAccount\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"querystring/dateFrom Invalid input: expected string, received undefined\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2f84e711-3d9d-4434-a36a-0393e325cfe6", "name": "Get Withdrawal Receipt", "request": { "name": "Get Withdrawal Receipt", "description": { "content": "Returns the transaction receipt as JSON with a `base64` field (encoded PDF). Decode it to display or save as `.pdf`.", "type": "text/plain" }, "url": { "path": [ "withdraw", "proof", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "type", "value": "pdf", "description": "Return format." } ], "variable": [ { "disabled": false, "type": "any", "value": "PIX2025081721512946OOLK75", "key": "id", "description": "(Required) Transaction ID." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "301825a8-3a52-49e5-a89e-193a8946eb21", "name": "Base64 if `type=base64`, otherwise binary PDF.", "originalRequest": { "url": { "path": [ "withdraw", "proof", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "type", "value": "pdf" } ], "variable": [ { "disabled": false, "type": "any", "value": "PIX2025081721512946OOLK75", "key": "id", "description": "(Required) Transaction ID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"base64\": \"JVBERi0xLjQKJ...\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b83ce426-0fa9-4031-b1d6-44e1cbbb83f3", "name": "Bad Request, payload or query string failed validation", "originalRequest": { "url": { "path": [ "withdraw", "proof", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "type", "value": "pdf" } ], "variable": [ { "disabled": false, "type": "any", "value": "PIX2025081721512946OOLK75", "key": "id", "description": "(Required) Transaction ID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"querystring/type Invalid input\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ff4415f-9b44-4331-bb6b-194546d07786", "name": "Unauthorized, missing or invalid Bearer token, or token lacks the required permission for this endpoint", "originalRequest": { "url": { "path": [ "withdraw", "proof", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "type", "value": "pdf" } ], "variable": [ { "disabled": false, "type": "any", "value": "PIX2025081721512946OOLK75", "key": "id", "description": "(Required) Transaction ID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 401,\n \"error\": \"Unauthorized\",\n \"message\": \"Missing or invalid Bearer token\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cba47883-45e8-41da-977c-5ad83ba18e09", "name": "Resource not found", "originalRequest": { "url": { "path": [ "withdraw", "proof", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "type", "value": "pdf" } ], "variable": [ { "disabled": false, "type": "any", "value": "PIX2025081721512946OOLK75", "key": "id", "description": "(Required) Transaction ID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 404,\n \"error\": \"Not Found\",\n \"message\": \"Resource not found\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "88f68afb-4bcb-4a78-bc26-438f063e1133", "name": "Internal Transfer", "description": { "content": "Transfer funds between Pix Processamento accounts (free, instant)", "type": "text/plain" }, "item": [ { "id": "2ec75b1e-76ac-4e6e-a0d4-2e79090ff4b2", "name": "Create internal transfer", "request": { "name": "Create internal transfer", "description": { "content": "Send funds to another Pix Processamento account using its 6-digit accountNumber. Settles instantly within Pix Processamento.", "type": "text/plain" }, "url": { "path": [ "internal-transfer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"payerAccountNumber\": \"513579\",\n \"receiverAccountNumber\": \"987654\",\n \"amount\": 100.5,\n \"description\": \"Pagamento referente a fatura #1234\",\n \"callbackUrl\": \"https://webhook.cool/\",\n \"clientReference\": \"transfer_abc_123\",\n \"virtualAccount\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "469319e4-af85-4199-8be5-06e759bc64e6", "name": "Transfer completed", "originalRequest": { "url": { "path": [ "internal-transfer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payerAccountNumber\": \"513579\",\n \"receiverAccountNumber\": \"987654\",\n \"amount\": 100.5,\n \"description\": \"Pagamento referente a fatura #1234\",\n \"callbackUrl\": \"https://webhook.cool/\",\n \"clientReference\": \"transfer_abc_123\",\n \"virtualAccount\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"PIX20260506T142500ABC123\",\n \"status\": \"COMPLETED\",\n \"amount\": 100.5,\n \"type\": \"WITHDRAW\",\n \"qrCodeText\": null,\n \"qrCodeBase64\": null,\n \"qrCodeUrl\": null,\n \"generatedName\": null,\n \"generatedDocument\": null,\n \"generatedEmail\": null,\n \"serviceFeeCharged\": 0,\n \"payerName\": \"Joao Silva\",\n \"payerDocument\": \"12345678901\",\n \"payerInstitutionIspb\": \"23066240\",\n \"payerInstitutionName\": \"PIX IP LTDA.\",\n \"payerAccountNumber\": \"513579\",\n \"withdrawPixKey\": null,\n \"withdrawPixType\": null,\n \"receiverName\": \"Maria Santos\",\n \"receiverDocument\": \"98765432109\",\n \"receiverInstitutionIspb\": \"23066240\",\n \"receiverInstitutionName\": \"PIX IP LTDA.\",\n \"receiverAccountNumber\": \"987654\",\n \"endToEndId\": null,\n \"clientReference\": \"transfer_abc_123\",\n \"createdAt\": \"2026-05-06T14:25:00.000Z\",\n \"updatedAt\": \"2026-05-06T14:25:00.123Z\",\n \"paidAt\": \"2026-05-06T14:25:00.123Z\",\n \"refundEndToEndId\": null,\n \"refundAmount\": null,\n \"refundStatus\": null,\n \"refundReason\": null,\n \"refundDescription\": null,\n \"refundedAt\": null,\n \"cancellationReason\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09ef6f8b-a2ba-4546-a721-614527124ee3", "name": "Invalid payload (e.g. payerAccountNumber does not belong to the requester)", "originalRequest": { "url": { "path": [ "internal-transfer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payerAccountNumber\": \"513579\",\n \"receiverAccountNumber\": \"987654\",\n \"amount\": 100.5,\n \"description\": \"Pagamento referente a fatura #1234\",\n \"callbackUrl\": \"https://webhook.cool/\",\n \"clientReference\": \"transfer_abc_123\",\n \"virtualAccount\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"querystring/dateFrom Invalid input: expected string, received undefined\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c914d2ee-cba2-40fe-8084-bc8c047406d8", "name": "allowInternalTransfer disabled or token missing WITHDRAW permission", "originalRequest": { "url": { "path": [ "internal-transfer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payerAccountNumber\": \"513579\",\n \"receiverAccountNumber\": \"987654\",\n \"amount\": 100.5,\n \"description\": \"Pagamento referente a fatura #1234\",\n \"callbackUrl\": \"https://webhook.cool/\",\n \"clientReference\": \"transfer_abc_123\",\n \"virtualAccount\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Token does not have permission for this operation\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "daec8762-a493-4c91-bca6-b0575e3c5bdd", "name": "Receiver account not found", "originalRequest": { "url": { "path": [ "internal-transfer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payerAccountNumber\": \"513579\",\n \"receiverAccountNumber\": \"987654\",\n \"amount\": 100.5,\n \"description\": \"Pagamento referente a fatura #1234\",\n \"callbackUrl\": \"https://webhook.cool/\",\n \"clientReference\": \"transfer_abc_123\",\n \"virtualAccount\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 404,\n \"error\": \"Not Found\",\n \"message\": \"Resource not found\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0637226d-33b7-49a6-aff4-779c8e4c25bf", "name": "Insufficient balance / amount below ticket minimum", "originalRequest": { "url": { "path": [ "internal-transfer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payerAccountNumber\": \"513579\",\n \"receiverAccountNumber\": \"987654\",\n \"amount\": 100.5,\n \"description\": \"Pagamento referente a fatura #1234\",\n \"callbackUrl\": \"https://webhook.cool/\",\n \"clientReference\": \"transfer_abc_123\",\n \"virtualAccount\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 422,\n \"error\": \"Unprocessable Entity\",\n \"message\": \"Insufficient balance for this operation\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4ef4480c-ae5b-4236-a4f6-9bed82a46f5b", "name": "Get internal transfer", "request": { "name": "Get internal transfer", "description": { "content": "Returns the details of an internal transfer. Provide at least one of `id` or `clientReference` (`virtualAccount` is also accepted). If more than one is provided, all are applied as filters (AND).", "type": "text/plain" }, "url": { "path": [ "internal-transfer" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "id", "value": "string", "description": "Transaction ID" }, { "disabled": false, "key": "clientReference", "value": "string", "description": "External reference" }, { "disabled": false, "key": "virtualAccount", "value": "string", "description": "Virtual sub-account (up to 50 characters) used at creation. Accepted as an alternative lookup key." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "056b6a80-087f-40bb-a195-3e8d577b1b5d", "name": "Transfer details", "originalRequest": { "url": { "path": [ "internal-transfer" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "id", "value": "string" }, { "key": "clientReference", "value": "string" }, { "key": "virtualAccount", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"PIX20260506T142500ABC123\",\n \"status\": \"COMPLETED\",\n \"amount\": 100.5,\n \"type\": \"WITHDRAW\",\n \"qrCodeText\": null,\n \"qrCodeBase64\": null,\n \"qrCodeUrl\": null,\n \"generatedName\": null,\n \"generatedDocument\": null,\n \"generatedEmail\": null,\n \"serviceFeeCharged\": 0,\n \"payerName\": \"Joao Silva\",\n \"payerDocument\": \"12345678901\",\n \"payerInstitutionIspb\": \"23066240\",\n \"payerInstitutionName\": \"PIX IP LTDA.\",\n \"payerAccountNumber\": \"513579\",\n \"withdrawPixKey\": null,\n \"withdrawPixType\": null,\n \"receiverName\": \"Maria Santos\",\n \"receiverDocument\": \"98765432109\",\n \"receiverInstitutionIspb\": \"23066240\",\n \"receiverInstitutionName\": \"PIX IP LTDA.\",\n \"receiverAccountNumber\": \"987654\",\n \"endToEndId\": null,\n \"clientReference\": \"transfer_abc_123\",\n \"createdAt\": \"2026-05-06T14:25:00.000Z\",\n \"updatedAt\": \"2026-05-06T14:25:00.123Z\",\n \"paidAt\": \"2026-05-06T14:25:00.123Z\",\n \"refundEndToEndId\": null,\n \"refundAmount\": null,\n \"refundStatus\": null,\n \"refundReason\": null,\n \"refundDescription\": null,\n \"refundedAt\": null,\n \"cancellationReason\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "004bfdc1-bf41-4590-8ba2-c560fab18eea", "name": "Provide either `id` or `clientReference`", "originalRequest": { "url": { "path": [ "internal-transfer" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "id", "value": "string" }, { "key": "clientReference", "value": "string" }, { "key": "virtualAccount", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"querystring/dateFrom Invalid input: expected string, received undefined\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d060574-8591-4db7-baf1-7a5df2917c1d", "name": "Transfer not found", "originalRequest": { "url": { "path": [ "internal-transfer" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "id", "value": "string" }, { "key": "clientReference", "value": "string" }, { "key": "virtualAccount", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 404,\n \"error\": \"Not Found\",\n \"message\": \"Resource not found\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "981590c5-6108-46c9-bb2a-9b22d07c516d", "name": "Account", "description": { "content": "Account profile, balance, and auto-withdraw configuration", "type": "text/plain" }, "item": [ { "id": "56260a8f-847e-41fd-afe8-b4adc5e644b7", "name": "Account Info", "request": { "name": "Account Info", "description": { "content": "Account profile, permissions, limits and fee rules.", "type": "text/plain" }, "url": { "path": [ "user" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "8a724cae-73d3-4ad7-a941-4eb9e6cc1a66", "name": "Account data", "originalRequest": { "url": { "path": [ "user" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"accountNumber\": \"513579\",\n \"branch\": \"0001\",\n \"name\": \"PIX\",\n \"role\": \"USER\",\n \"balanceAvailable\": 231.46,\n \"balanceBlocked\": 0,\n \"status\": \"ACTIVE\",\n \"allowWithdraw\": true,\n \"allowDeposit\": true,\n \"allowInfraction\": true,\n \"cashInTicketMin\": 1,\n \"cashInTicketMax\": 50000,\n \"cashOutTicketMin\": 1,\n \"cashOutTicketMax\": 100000,\n \"AutoWithdraw\": null,\n \"ServiceFee\": {\n \"cashInMinimum\": 0,\n \"cashInFixed\": 0,\n \"cashInPercent\": 0,\n \"cashOutMinimum\": 0,\n \"cashOutFixed\": 0,\n \"cashOutPercent\": 0\n },\n \"DailyWithdrawLimit\": {\n \"limit\": 100000000,\n \"used\": 40000,\n \"updatedAt\": \"2025-10-21T21:16:47.759Z\",\n \"lastReset\": \"2025-10-21T21:16:47.759Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5146d439-c125-49d2-91d3-58dbc2d7cf8b", "name": "Unauthorized, missing or invalid Bearer token, or token lacks the required permission for this endpoint", "originalRequest": { "url": { "path": [ "user" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 401,\n \"error\": \"Unauthorized\",\n \"message\": \"Missing or invalid Bearer token\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ff9f5d9-ff4b-4a1a-9657-edb770e218d7", "name": "Resource not found", "originalRequest": { "url": { "path": [ "user" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 404,\n \"error\": \"Not Found\",\n \"message\": \"Resource not found\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2a176a58-14ff-40ec-b10d-25f8daac688f", "name": "Account Balance", "request": { "name": "Account Balance", "description": { "content": "Available and blocked balances.", "type": "text/plain" }, "url": { "path": [ "user", "balance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "e5b96647-0265-4975-a360-3bb942790b85", "name": "Balances", "originalRequest": { "url": { "path": [ "user", "balance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"balanceAvailable\": 231.46,\n \"balanceBlocked\": 0\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "36c94f6a-2b75-4142-bb38-871d3bb24a44", "name": "Unauthorized, missing or invalid Bearer token, or token lacks the required permission for this endpoint", "originalRequest": { "url": { "path": [ "user", "balance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 401,\n \"error\": \"Unauthorized\",\n \"message\": \"Missing or invalid Bearer token\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "f6784f62-3b7f-48a0-9320-267ec4c0850d", "name": "Reports", "description": { "content": "Transaction history, reports, bank statements, and pending deposits", "type": "text/plain" }, "item": [ { "id": "4b793e2e-fa93-4699-b679-424291d371c4", "name": "List Transactions", "request": { "name": "List Transactions", "description": { "content": "Paginated list of account transactions with filters.", "type": "text/plain" }, "url": { "path": [ "user", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "dateFrom", "value": "2025-08-01", "description": "Start date (YYYY-MM-DD)." }, { "disabled": false, "key": "dateTo", "value": "2025-08-17", "description": "End date (YYYY-MM-DD)." }, { "disabled": false, "key": "limit", "value": "10", "description": "Items per page (max 1000)." }, { "disabled": false, "key": "page", "value": "1", "description": "Page number (default 1)." }, { "disabled": false, "key": "id", "value": "PIX2025081418333632CYKN8M", "description": "Transaction ID." }, { "disabled": false, "key": "status", "value": "COMPLETED", "description": "Transaction status. Accepts CSV: PENDING,COMPLETED,etc." }, { "disabled": false, "key": "type", "value": "DEPOSIT", "description": "Transaction type. Accepts CSV: DEPOSIT,WITHDRAW,COMMISSION." }, { "disabled": false, "key": "method", "value": "PIX", "description": "Transaction method/rail. Accepts CSV: PIX,BANK_SLIP,INTERNAL_TRANSFER." }, { "disabled": false, "key": "amount", "value": "15000", "description": "Amount filter. Minimum 0.01." }, { "disabled": false, "key": "document", "value": "12345678901", "description": "CPF (11 digits) or CNPJ (14 digits), digits only, no punctuation." }, { "disabled": false, "key": "name", "value": "Alice", "description": "Name filter." }, { "disabled": false, "key": "endToEndId", "value": "E00360305202508141833bcf1f37b487", "description": "Pix end-to-end ID." }, { "disabled": false, "key": "sortBy", "value": "createdAt", "description": "Field to sort by" }, { "disabled": false, "key": "sortDirection", "value": "desc", "description": "Sort direction" }, { "disabled": false, "key": "clientReference", "value": "string", "description": "Filter by external reference" }, { "disabled": false, "key": "virtualAccount", "value": "string", "description": "Virtual sub-account (up to 50 characters) used at creation. Accepted as an alternative lookup key." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "9f76b517-a94b-4040-ac77-87f7fa28cd59", "name": "Transaction page", "originalRequest": { "url": { "path": [ "user", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "dateFrom", "value": "2025-08-01" }, { "key": "dateTo", "value": "2025-08-17" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" }, { "key": "id", "value": "PIX2025081418333632CYKN8M" }, { "key": "status", "value": "COMPLETED" }, { "key": "type", "value": "DEPOSIT" }, { "key": "method", "value": "PIX" }, { "key": "amount", "value": "15000" }, { "key": "document", "value": "12345678901" }, { "key": "name", "value": "Alice" }, { "key": "endToEndId", "value": "E00360305202508141833bcf1f37b487" }, { "key": "sortBy", "value": "createdAt" }, { "key": "sortDirection", "value": "desc" }, { "key": "clientReference", "value": "string" }, { "key": "virtualAccount", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"total\": 104,\n \"pages\": 2,\n \"transactions\": [\n {\n \"id\": \"PIX202511061998787515D0PH2Y\",\n \"amount\": 10,\n \"status\": \"PENDING\",\n \"type\": \"DEPOSIT\",\n \"qrCodeText\": \"00020126860014br.gov.bcb.pix2564qrcode.pix.com.br/pix/84f95c33-3c86-4708-87f1-0e09b96b35795204000053039865802BR5908PAYZPLUS6009SAO PAULO62070503***63048227\",\n \"qrCodeBase64\": null,\n \"qrCodeUrl\": \"https://pix.pix.com.br/v1/pix/qr-code/PIX202511061998787515D0PH2Y\",\n \"serviceFeeCharged\": 0.115,\n \"payerDocument\": null,\n \"payerName\": null,\n \"payerInstitutionIspb\": null,\n \"payerInstitutionName\": null,\n \"receiverDocument\": null,\n \"receiverName\": null,\n \"receiverInstitutionIspb\": null,\n \"receiverInstitutionName\": null,\n \"generatedDocument\": \"00000000191\",\n \"generatedName\": \"THIAGO SILVA\",\n \"generatedEmail\": null,\n \"endToEndId\": null,\n \"withdrawPixKey\": null,\n \"withdrawPixType\": null,\n \"paidAt\": null,\n \"createdAt\": \"2025-11-06T22:06:19.598Z\",\n \"updatedAt\": \"2025-11-06T22:06:19.598Z\",\n \"clientReference\": \"order_12345\",\n \"refundEndToEndId\": null,\n \"refundAmount\": null,\n \"refundStatus\": null,\n \"refundReason\": null,\n \"refundDescription\": null,\n \"refundedAt\": null,\n \"cancellationReason\": null\n },\n {\n \"id\": \"PIX202511061998787515D0PH2Y\",\n \"amount\": 5.5,\n \"status\": \"ERROR\",\n \"type\": \"WITHDRAW\",\n \"qrCodeText\": null,\n \"qrCodeBase64\": null,\n \"qrCodeUrl\": null,\n \"serviceFeeCharged\": 1,\n \"payerDocument\": null,\n \"payerName\": null,\n \"payerInstitutionIspb\": null,\n \"payerInstitutionName\": null,\n \"receiverDocument\": null,\n \"receiverName\": null,\n \"receiverInstitutionIspb\": null,\n \"receiverInstitutionName\": null,\n \"generatedDocument\": null,\n \"generatedName\": null,\n \"generatedEmail\": null,\n \"endToEndId\": null,\n \"withdrawPixKey\": \"88888888888\",\n \"withdrawPixType\": \"cpf\",\n \"paidAt\": null,\n \"createdAt\": \"2025-11-06T19:08:55.848Z\",\n \"updatedAt\": \"2025-11-06T19:09:13.602Z\",\n \"clientReference\": null,\n \"refundEndToEndId\": null,\n \"refundAmount\": null,\n \"refundStatus\": null,\n \"refundReason\": null,\n \"refundDescription\": null,\n \"refundedAt\": null,\n \"cancellationReason\": \"PIX_KEY_NOT_FOUND\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c76f6c2-f9b9-4fdb-aad5-fffc78d84770", "name": "Bad Request, payload or query string failed validation", "originalRequest": { "url": { "path": [ "user", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "dateFrom", "value": "2025-08-01" }, { "key": "dateTo", "value": "2025-08-17" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" }, { "key": "id", "value": "PIX2025081418333632CYKN8M" }, { "key": "status", "value": "COMPLETED" }, { "key": "type", "value": "DEPOSIT" }, { "key": "method", "value": "PIX" }, { "key": "amount", "value": "15000" }, { "key": "document", "value": "12345678901" }, { "key": "name", "value": "Alice" }, { "key": "endToEndId", "value": "E00360305202508141833bcf1f37b487" }, { "key": "sortBy", "value": "createdAt" }, { "key": "sortDirection", "value": "desc" }, { "key": "clientReference", "value": "string" }, { "key": "virtualAccount", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"querystring/dateFrom Invalid input: expected string, received undefined\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6104e005-1a64-4d05-9291-0cbf8d4a40eb", "name": "Unauthorized, missing or invalid Bearer token, or token lacks the required permission for this endpoint", "originalRequest": { "url": { "path": [ "user", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "dateFrom", "value": "2025-08-01" }, { "key": "dateTo", "value": "2025-08-17" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" }, { "key": "id", "value": "PIX2025081418333632CYKN8M" }, { "key": "status", "value": "COMPLETED" }, { "key": "type", "value": "DEPOSIT" }, { "key": "method", "value": "PIX" }, { "key": "amount", "value": "15000" }, { "key": "document", "value": "12345678901" }, { "key": "name", "value": "Alice" }, { "key": "endToEndId", "value": "E00360305202508141833bcf1f37b487" }, { "key": "sortBy", "value": "createdAt" }, { "key": "sortDirection", "value": "desc" }, { "key": "clientReference", "value": "string" }, { "key": "virtualAccount", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 401,\n \"error\": \"Unauthorized\",\n \"message\": \"Missing or invalid Bearer token\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f70a1476-c0b6-4090-a9bf-0dacf91e5a01", "name": "Resource not found", "originalRequest": { "url": { "path": [ "user", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "dateFrom", "value": "2025-08-01" }, { "key": "dateTo", "value": "2025-08-17" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" }, { "key": "id", "value": "PIX2025081418333632CYKN8M" }, { "key": "status", "value": "COMPLETED" }, { "key": "type", "value": "DEPOSIT" }, { "key": "method", "value": "PIX" }, { "key": "amount", "value": "15000" }, { "key": "document", "value": "12345678901" }, { "key": "name", "value": "Alice" }, { "key": "endToEndId", "value": "E00360305202508141833bcf1f37b487" }, { "key": "sortBy", "value": "createdAt" }, { "key": "sortDirection", "value": "desc" }, { "key": "clientReference", "value": "string" }, { "key": "virtualAccount", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 404,\n \"error\": \"Not Found\",\n \"message\": \"Resource not found\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f673c18c-d33c-40db-aea7-1f406ee21907", "name": "List transaction details", "request": { "name": "List transaction details", "description": { "content": "Retrieve a single transaction with its callback log and linked infractions.", "type": "text/plain" }, "url": { "path": [ "user", "transactions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "bb456288-4880-4b48-b33b-beccb64c9591", "name": "Transaction details", "originalRequest": { "url": { "path": [ "user", "transactions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"status\": \"string\",\n \"amount\": 821.9774379319133,\n \"type\": \"string\",\n \"qrCodeText\": \"string\",\n \"qrCodeBase64\": \"string\",\n \"qrCodeUrl\": \"string\",\n \"generatedName\": \"string\",\n \"generatedDocument\": \"string\",\n \"generatedEmail\": \"string\",\n \"payerName\": \"string\",\n \"payerDocument\": \"string\",\n \"payerInstitutionIspb\": \"string\",\n \"payerInstitutionName\": \"string\",\n \"payerAccountNumber\": \"string\",\n \"serviceFeeCharged\": 821.3187203589079,\n \"withdrawPixKey\": \"string\",\n \"withdrawPixType\": \"string\",\n \"receiverName\": \"string\",\n \"receiverDocument\": \"string\",\n \"receiverInstitutionIspb\": \"string\",\n \"receiverInstitutionName\": \"string\",\n \"receiverAccountNumber\": \"string\",\n \"endToEndId\": \"string\",\n \"createdAt\": \"string\",\n \"updatedAt\": \"string\",\n \"paidAt\": \"string\",\n \"clientReference\": \"string\",\n \"refundEndToEndId\": \"string\",\n \"refundAmount\": 5139.700861907763,\n \"refundStatus\": \"string\",\n \"refundReason\": \"string\",\n \"refundDescription\": \"string\",\n \"refundedAt\": \"string\",\n \"cancellationReason\": \"string\",\n \"virtualAccount\": \"string\",\n \"method\": \"PIX\",\n \"Infraction\": [\n {\n \"id\": \"string\",\n \"status\": \"string\",\n \"createdAt\": \"2012-07-26T19:01:00.454Z\",\n \"updatedAt\": \"2017-06-25T19:50:00.180Z\"\n },\n {\n \"id\": \"string\",\n \"status\": \"string\",\n \"createdAt\": \"1972-09-21T13:05:49.643Z\",\n \"updatedAt\": \"2001-05-14T11:47:07.075Z\"\n }\n ],\n \"CallbackLog\": [\n {\n \"id\": \"string\",\n \"url\": \"string\",\n \"status\": 7279,\n \"responseTime\": 3161.0494095395093,\n \"createdAt\": \"1958-06-01T09:10:43.448Z\"\n },\n {\n \"id\": \"string\",\n \"url\": \"string\",\n \"status\": 4450,\n \"responseTime\": 9255.302787864308,\n \"createdAt\": \"1966-05-12T08:16:02.409Z\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df4a23e6-d4d4-4afe-ac9c-94ac2013b7d7", "name": "Transaction not found", "originalRequest": { "url": { "path": [ "user", "transactions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 404,\n \"error\": \"Not Found\",\n \"message\": \"Resource not found\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f7c40dc6-fc0a-468d-a5e2-59c03e3ea034", "name": "Generate transactions report", "request": { "name": "Generate transactions report", "description": { "content": "Queue an asynchronous job that generates a CSV report of transactions for the given period and filters.", "type": "text/plain" }, "url": { "path": [ "user", "report" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"dateFrom\": \"1959-06-13T17:34:37.841Z\",\n \"dateTo\": \"1970-09-23T21:27:58.793Z\",\n \"status\": [\n \"ERROR\",\n \"CANCELED\"\n ],\n \"type\": [\n \"WITHDRAW\",\n \"DEPOSIT\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2e1e98c2-d028-4da4-ba6d-42c4eccbbd9e", "name": "Report job aceito (job enfileirado)", "originalRequest": { "url": { "path": [ "user", "report" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"dateFrom\": \"1951-05-03T14:02:19.928Z\",\n \"dateTo\": \"1984-12-25T20:18:31.847Z\",\n \"status\": [\n \"WAITING_FOR_REFUND\",\n \"PENDING\"\n ],\n \"type\": [\n \"DEPOSIT\",\n \"WITHDRAW\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"787483d6-1d0d-846e-9403-12a25cf63aba\",\n \"status\": \"FAILED\",\n \"createdAt\": \"1989-06-14T20:00:35.952Z\",\n \"updatedAt\": \"2016-04-17T18:24:02.867Z\",\n \"expiresAt\": \"1965-11-07T10:08:29.255Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e9f52db-3043-4a65-bb0d-f5c4df275232", "name": "No transactions match the filter / concurrency limit reached", "originalRequest": { "url": { "path": [ "user", "report" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"dateFrom\": \"1951-05-03T14:02:19.928Z\",\n \"dateTo\": \"1984-12-25T20:18:31.847Z\",\n \"status\": [\n \"WAITING_FOR_REFUND\",\n \"PENDING\"\n ],\n \"type\": [\n \"DEPOSIT\",\n \"WITHDRAW\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 422,\n \"error\": \"Unprocessable Entity\",\n \"message\": \"Insufficient balance for this operation\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1c73d4fc-a74c-47fd-b429-7b3e9b029e51", "name": "List report jobs", "request": { "name": "List report jobs", "description": { "content": "List report jobs created by the authenticated user.", "type": "text/plain" }, "url": { "path": [ "user", "report" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "1" }, { "disabled": false, "key": "limit", "value": "10" }, { "disabled": false, "key": "status", "value": "PENDING" }, { "disabled": false, "key": "createdAtFrom", "value": "1981-06-05T00:45:55.849Z", "description": "Filter: created from." }, { "disabled": false, "key": "createdAtTo", "value": "1981-06-05T00:45:55.849Z", "description": "Filter: created up to." }, { "disabled": false, "key": "updatedAtFrom", "value": "1981-06-05T00:45:55.849Z", "description": "Filter: updated from." }, { "disabled": false, "key": "updatedAtTo", "value": "1981-06-05T00:45:55.849Z", "description": "Filter: updated up to." }, { "disabled": false, "key": "sortBy", "value": "createdAt", "description": "Sort field." }, { "disabled": false, "key": "sortDirection", "value": "desc", "description": "Sort direction." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "59be1514-ecc0-4aae-a140-3d7e854a6b29", "name": "Page of report jobs", "originalRequest": { "url": { "path": [ "user", "report" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "10" }, { "key": "status", "value": "PENDING" }, { "key": "createdAtFrom", "value": "1981-06-05T00:45:55.849Z" }, { "key": "createdAtTo", "value": "1981-06-05T00:45:55.849Z" }, { "key": "updatedAtFrom", "value": "1981-06-05T00:45:55.849Z" }, { "key": "updatedAtTo", "value": "1981-06-05T00:45:55.849Z" }, { "key": "sortBy", "value": "createdAt" }, { "key": "sortDirection", "value": "desc" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"total\": 9,\n \"pages\": 3,\n \"reports\": [\n {\n \"id\": \"5224fd4e-0abb-4498-a79b-9398ea6712ad\",\n \"status\": \"COMPLETED\",\n \"createdAt\": \"2026-05-06T16:39:52.944Z\",\n \"updatedAt\": \"2026-05-06T16:39:53.500Z\",\n \"expiresAt\": \"2026-05-13T16:39:52.996Z\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ecb2f381-d74b-4f4f-a255-5f2c3a138519", "name": "Bad Request, payload or query string failed validation", "originalRequest": { "url": { "path": [ "user", "report" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "10" }, { "key": "status", "value": "PENDING" }, { "key": "createdAtFrom", "value": "1981-06-05T00:45:55.849Z" }, { "key": "createdAtTo", "value": "1981-06-05T00:45:55.849Z" }, { "key": "updatedAtFrom", "value": "1981-06-05T00:45:55.849Z" }, { "key": "updatedAtTo", "value": "1981-06-05T00:45:55.849Z" }, { "key": "sortBy", "value": "createdAt" }, { "key": "sortDirection", "value": "desc" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"querystring/dateFrom Invalid input: expected string, received undefined\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0977a3da-e426-4f4b-b340-e90757f150c2", "name": "Unauthorized, missing or invalid Bearer token, or token lacks the required permission for this endpoint", "originalRequest": { "url": { "path": [ "user", "report" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "10" }, { "key": "status", "value": "PENDING" }, { "key": "createdAtFrom", "value": "1981-06-05T00:45:55.849Z" }, { "key": "createdAtTo", "value": "1981-06-05T00:45:55.849Z" }, { "key": "updatedAtFrom", "value": "1981-06-05T00:45:55.849Z" }, { "key": "updatedAtTo", "value": "1981-06-05T00:45:55.849Z" }, { "key": "sortBy", "value": "createdAt" }, { "key": "sortDirection", "value": "desc" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 401,\n \"error\": \"Unauthorized\",\n \"message\": \"Missing or invalid Bearer token\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cba89019-5424-47b3-882d-4cedfd858bae", "name": "Resource not found", "originalRequest": { "url": { "path": [ "user", "report" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "10" }, { "key": "status", "value": "PENDING" }, { "key": "createdAtFrom", "value": "1981-06-05T00:45:55.849Z" }, { "key": "createdAtTo", "value": "1981-06-05T00:45:55.849Z" }, { "key": "updatedAtFrom", "value": "1981-06-05T00:45:55.849Z" }, { "key": "updatedAtTo", "value": "1981-06-05T00:45:55.849Z" }, { "key": "sortBy", "value": "createdAt" }, { "key": "sortDirection", "value": "desc" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 404,\n \"error\": \"Not Found\",\n \"message\": \"Resource not found\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2daed6ef-c43b-48b8-8ee6-d8c9c0acce7d", "name": "Get report job status", "request": { "name": "Get report job status", "description": { "content": "Returns the status and metadata of a specific report job by `id`.", "type": "text/plain" }, "url": { "path": [ "user", "report", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "11756848-f4c6-64de-3d1d-4f73e3415613", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "62049caf-f66d-4d93-8a6a-a15627b61e07", "name": "Report job", "originalRequest": { "url": { "path": [ "user", "report", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "11756848-f4c6-64de-3d1d-4f73e3415613", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"5224fd4e-0abb-4498-a79b-9398ea6712ad\",\n \"status\": \"COMPLETED\",\n \"createdAt\": \"2026-05-06T16:39:52.944Z\",\n \"updatedAt\": \"2026-05-06T16:39:53.500Z\",\n \"expiresAt\": \"2026-05-13T16:39:52.996Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "47064ab4-338e-4e55-93b3-9c58c181e769", "name": "Report not found", "originalRequest": { "url": { "path": [ "user", "report", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "11756848-f4c6-64de-3d1d-4f73e3415613", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 404,\n \"error\": \"Not Found\",\n \"message\": \"Resource not found\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8c9ff122-075d-4953-b453-6b274f5c37f2", "name": "Download report", "request": { "name": "Download report", "description": { "content": "Returns a short-lived signed URL to download the CSV file.", "type": "text/plain" }, "url": { "path": [ "user", "report", ":id", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "11756848-f4c6-64de-3d1d-4f73e3415613", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "d05e67b3-e1c6-4c72-9595-39a4d360acdd", "name": "Signed download URL", "originalRequest": { "url": { "path": [ "user", "report", ":id", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "11756848-f4c6-64de-3d1d-4f73e3415613", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"url\": \"https://storage.googleapis.com/relatorios-transacoes/relatorio-transacoes-06-05-2026_06-05-2026_5224fd4e-...csv?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Expires=300&...\",\n \"expiresAt\": \"2026-05-06T16:48:34.889Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b4889b4-f894-4e01-9146-2249567d058d", "name": "Report not found", "originalRequest": { "url": { "path": [ "user", "report", ":id", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "11756848-f4c6-64de-3d1d-4f73e3415613", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 404,\n \"error\": \"Not Found\",\n \"message\": \"Resource not found\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e124ed4-5527-47d9-8e56-f40df3b2550f", "name": "Report file expired", "originalRequest": { "url": { "path": [ "user", "report", ":id", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "11756848-f4c6-64de-3d1d-4f73e3415613", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Gone", "code": 410, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 410,\n \"error\": \"Gone\",\n \"message\": \"Report file expired and is no longer available\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f8e6372-536d-420e-9ed4-4b6f59221862", "name": "Report not ready (still processing)", "originalRequest": { "url": { "path": [ "user", "report", ":id", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "11756848-f4c6-64de-3d1d-4f73e3415613", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 422,\n \"error\": \"Unprocessable Entity\",\n \"message\": \"Insufficient balance for this operation\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "f28f8480-3c1c-491d-a7fa-35e99546870d", "name": "Callbacks", "description": { "content": "Webhook callback inspection and re-trigger", "type": "text/plain" }, "item": [ { "id": "6a68c6f8-dfc3-468c-9bb1-f2e8401ab311", "name": "List Callbacks", "request": { "name": "List Callbacks", "description": { "content": "Returns a paginated list of webhook callback logs for the user's transactions.", "type": "text/plain" }, "url": { "path": [ "user", "callbacks" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "1" }, { "disabled": false, "key": "limit", "value": "10" }, { "disabled": false, "key": "sortBy", "value": "createdAt" }, { "disabled": false, "key": "sortDirection", "value": "desc" }, { "disabled": false, "key": "id", "value": "string", "description": "Filter by callback ID" }, { "disabled": false, "key": "url", "value": "string", "description": "Filter by callback URL" }, { "disabled": false, "key": "status", "value": "1492", "description": "HTTP status code" }, { "disabled": false, "key": "transactionId", "value": "string" }, { "disabled": false, "key": "hasError", "value": "true", "description": "Filter callbacks that errored" }, { "disabled": false, "key": "createdAtFrom", "value": "1981-06-05T00:45:55.849Z" }, { "disabled": false, "key": "createdAtTo", "value": "1981-06-05T00:45:55.849Z" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "5cf84fd4-bd4b-42a0-9a17-f9cec9e6f445", "name": "List of callback logs with pagination", "originalRequest": { "url": { "path": [ "user", "callbacks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "10" }, { "key": "sortBy", "value": "createdAt" }, { "key": "sortDirection", "value": "desc" }, { "key": "id", "value": "string" }, { "key": "url", "value": "string" }, { "key": "status", "value": "1492" }, { "key": "transactionId", "value": "string" }, { "key": "hasError", "value": "true" }, { "key": "createdAtFrom", "value": "1981-06-05T00:45:55.849Z" }, { "key": "createdAtTo", "value": "1981-06-05T00:45:55.849Z" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"pagination\": {\n \"page\": 1,\n \"limit\": 10,\n \"hasNextPage\": true\n },\n \"callbacks\": [\n {\n \"id\": \"cmh211yjm03ohs601kf7672du\",\n \"url\": \"https://great-lock-79.webhook.cool\",\n \"status\": 200,\n \"transactionId\": \"PIX2025102213082667EDC8079C\",\n \"createdAt\": \"2025-10-22T13:26:53.219Z\",\n \"responseTime\": 124,\n \"body\": {\n \"id\": \"PIX2025102213082667EDC8079C\",\n \"type\": \"DEPOSIT\",\n \"status\": \"REFUNDED\"\n },\n \"responseBody\": \"OK\",\n \"responseHeaders\": {\n \"content-type\": \"text/plain; charset=UTF-8\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f880d827-c229-489f-af4e-90f70589906d", "name": "Bad Request, payload or query string failed validation", "originalRequest": { "url": { "path": [ "user", "callbacks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "10" }, { "key": "sortBy", "value": "createdAt" }, { "key": "sortDirection", "value": "desc" }, { "key": "id", "value": "string" }, { "key": "url", "value": "string" }, { "key": "status", "value": "1492" }, { "key": "transactionId", "value": "string" }, { "key": "hasError", "value": "true" }, { "key": "createdAtFrom", "value": "1981-06-05T00:45:55.849Z" }, { "key": "createdAtTo", "value": "1981-06-05T00:45:55.849Z" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"querystring/dateFrom Invalid input: expected string, received undefined\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7404663-5494-4ae2-be76-142fddb55858", "name": "Unauthorized, missing or invalid Bearer token, or token lacks the required permission for this endpoint", "originalRequest": { "url": { "path": [ "user", "callbacks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "10" }, { "key": "sortBy", "value": "createdAt" }, { "key": "sortDirection", "value": "desc" }, { "key": "id", "value": "string" }, { "key": "url", "value": "string" }, { "key": "status", "value": "1492" }, { "key": "transactionId", "value": "string" }, { "key": "hasError", "value": "true" }, { "key": "createdAtFrom", "value": "1981-06-05T00:45:55.849Z" }, { "key": "createdAtTo", "value": "1981-06-05T00:45:55.849Z" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 401,\n \"error\": \"Unauthorized\",\n \"message\": \"Missing or invalid Bearer token\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f9240cc-9c88-447d-892f-5ef733bcb4e7", "name": "Resource not found", "originalRequest": { "url": { "path": [ "user", "callbacks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "10" }, { "key": "sortBy", "value": "createdAt" }, { "key": "sortDirection", "value": "desc" }, { "key": "id", "value": "string" }, { "key": "url", "value": "string" }, { "key": "status", "value": "1492" }, { "key": "transactionId", "value": "string" }, { "key": "hasError", "value": "true" }, { "key": "createdAtFrom", "value": "1981-06-05T00:45:55.849Z" }, { "key": "createdAtTo", "value": "1981-06-05T00:45:55.849Z" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 404,\n \"error\": \"Not Found\",\n \"message\": \"Resource not found\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d39d69b6-fddd-4420-bab8-ec13a37a652e", "name": "Get Callback", "request": { "name": "Get Callback", "description": { "content": "Returns the details of a specific callback log.", "type": "text/plain" }, "url": { "path": [ "user", "callbacks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Unique callback ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "9922e868-5d6d-48d6-880c-4dcb1df000a5", "name": "Callback details", "originalRequest": { "url": { "path": [ "user", "callbacks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Unique callback ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"cmh211yjm03ohs601kf7672du\",\n \"url\": \"https://great-lock-79.webhook.cool\",\n \"status\": 200,\n \"transactionId\": \"PIX2025102213082667EDC8079C\",\n \"createdAt\": \"2025-10-22T13:26:53.219Z\",\n \"responseTime\": 124,\n \"body\": {\n \"id\": \"PIX2025102213082667EDC8079C\",\n \"type\": \"DEPOSIT\",\n \"status\": \"REFUNDED\"\n },\n \"responseBody\": \"OK\",\n \"responseHeaders\": {\n \"content-type\": \"text/plain; charset=UTF-8\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f015a8e-05f4-4df4-9e07-0310b49b3b7a", "name": "Callback not found or does not belong to the user", "originalRequest": { "url": { "path": [ "user", "callbacks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Unique callback ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 404,\n \"error\": \"Not Found\",\n \"message\": \"Resource not found\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "97015200-9de9-4cb6-8333-de09b1293685", "name": "Re-send callbacks (bulk)", "request": { "name": "Re-send callbacks (bulk)", "description": { "content": "Resend callbacks in bulk for transactions matching the given filters.", "type": "text/plain" }, "url": { "path": [ "user", "callbacks", "resend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"createdAtFrom\": \"2026-05-05T00:00:00Z\",\n \"createdAtTo\": \"2026-05-06T00:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d7c96cc8-eef1-422c-81da-8906d8e1d47f", "name": "Resend dispatched", "originalRequest": { "url": { "path": [ "user", "callbacks", "resend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"createdAtFrom\": \"2026-05-05T00:00:00Z\",\n \"createdAtTo\": \"2026-05-06T00:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Callbacks reenviados com sucesso\",\n \"total\": 42\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b515e043-2040-40f5-9aba-26cecde873e5", "name": "No matching transactions", "originalRequest": { "url": { "path": [ "user", "callbacks", "resend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"createdAtFrom\": \"2026-05-05T00:00:00Z\",\n \"createdAtTo\": \"2026-05-06T00:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 404,\n \"error\": \"Not Found\",\n \"message\": \"Resource not found\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a30b4b57-f847-48e9-bf65-94f7b47a69db", "name": "Rate limit exceeded (5/min)", "originalRequest": { "url": { "path": [ "user", "callbacks", "resend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"createdAtFrom\": \"2026-05-05T00:00:00Z\",\n \"createdAtTo\": \"2026-05-06T00:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 429,\n \"error\": \"Too Many Requests\",\n \"message\": \"Limite de reenvios atingido. Tente novamente em 1 minuto.\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "909d4b0f-87f4-407e-a182-661f91678dff", "name": "Re-send callback (single)", "request": { "name": "Re-send callback (single)", "description": { "content": "Resend the callback of a single transaction.", "type": "text/plain" }, "url": { "path": [ "user", "callbacks", "resend", ":transactionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transactionId", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "774b0790-885b-498a-a8b5-dd91b2c14008", "name": "Resend dispatched", "originalRequest": { "url": { "path": [ "user", "callbacks", "resend", ":transactionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transactionId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Callback reenviado com sucesso\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f173bc62-4986-435c-826a-dc59a4bab2da", "name": "Transaction not found or has no callbackUrl configured", "originalRequest": { "url": { "path": [ "user", "callbacks", "resend", ":transactionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transactionId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 404,\n \"error\": \"Not Found\",\n \"message\": \"Resource not found\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c0e217e-b2ff-4b7b-ab05-31d58958a54d", "name": "Rate limit exceeded (5/min)", "originalRequest": { "url": { "path": [ "user", "callbacks", "resend", ":transactionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transactionId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 429,\n \"error\": \"Too Many Requests\",\n \"message\": \"Limite de reenvios atingido. Tente novamente em 1 minuto.\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "0bc4b806-de62-4645-b6ab-4f05173a86b0", "name": "Infractions", "description": { "content": "Manage Pix infractions (disputes, fraud reports) and submit defenses", "type": "text/plain" }, "item": [ { "id": "9ac29257-4972-4637-952f-403818f4520d", "name": "List Infractions", "request": { "name": "List Infractions", "description": { "content": "List all infractions for the authenticated user with pagination and filters.", "type": "text/plain" }, "url": { "path": [ "user", "infractions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "1" }, { "disabled": false, "key": "limit", "value": "10" }, { "disabled": false, "key": "status", "value": "string", "description": "Comma-separated InfractionStatus (WAITING_PSP,CLOSED,OPEN,CANCELLED,ACKNOWLEDGED,DEFENDED,ANSWERED,WAITING_ADJUSTMENTS)" }, { "disabled": false, "key": "type", "value": "string", "description": "Comma-separated InfractionType (REFUND_REQUEST,FRAUD,REFUND_CANCELLED)" }, { "disabled": false, "key": "endToEndId", "value": "string" }, { "disabled": false, "key": "transactionId", "value": "string" }, { "disabled": false, "key": "amountMin", "value": "9316.824872488278" }, { "disabled": false, "key": "amountMax", "value": "9316.824872488278" }, { "disabled": false, "key": "analysisResult", "value": "string", "description": "Comma-separated AnalysisResult" }, { "disabled": false, "key": "reportedBy", "value": "string", "description": "Comma-separated ReportedType (DEBITED_PARTICIPANT,CREDITED_PARTICIPANT)" }, { "disabled": false, "key": "participantDocument", "value": "string" }, { "disabled": false, "key": "participantName", "value": "string" }, { "disabled": false, "key": "sortBy", "value": "string", "description": "Sort field." }, { "disabled": false, "key": "sortDirection", "value": "asc", "description": "Sort direction." }, { "disabled": false, "key": "reportedAtFrom", "value": "1981-06-05T00:45:55.849Z", "description": "Filter: reportedAt from." }, { "disabled": false, "key": "reportedAtTo", "value": "1981-06-05T00:45:55.849Z", "description": "Filter: reportedAt up to." }, { "disabled": false, "key": "createdAtFrom", "value": "1981-06-05T00:45:55.849Z", "description": "Filter: createdAt from." }, { "disabled": false, "key": "createdAtTo", "value": "1981-06-05T00:45:55.849Z", "description": "Filter: createdAt up to." }, { "disabled": false, "key": "expiresAtFrom", "value": "1981-06-05T00:45:55.849Z", "description": "Filter: expiresAt from." }, { "disabled": false, "key": "expiresAtTo", "value": "1981-06-05T00:45:55.849Z", "description": "Filter: expiresAt up to." }, { "disabled": false, "key": "updatedAtFrom", "value": "1981-06-05T00:45:55.849Z", "description": "Filter: updatedAt from." }, { "disabled": false, "key": "updatedAtTo", "value": "1981-06-05T00:45:55.849Z", "description": "Filter: updatedAt up to." }, { "disabled": false, "key": "needsManualReview", "value": "true", "description": "Filter: needs manual review." }, { "disabled": false, "key": "id", "value": "string", "description": "Filter by infraction ID." }, { "disabled": false, "key": "protocol", "value": "string", "description": "Filter by protocol." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "8c505391-a368-4766-bd06-1699676538f5", "name": "List of infractions with pagination", "originalRequest": { "url": { "path": [ "user", "infractions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "10" }, { "key": "status", "value": "string" }, { "key": "type", "value": "string" }, { "key": "endToEndId", "value": "string" }, { "key": "transactionId", "value": "string" }, { "key": "amountMin", "value": "9316.824872488278" }, { "key": "amountMax", "value": "9316.824872488278" }, { "key": "analysisResult", "value": "string" }, { "key": "reportedBy", "value": "string" }, { "key": "participantDocument", "value": "string" }, { "key": "participantName", "value": "string" }, { "key": "sortBy", "value": "string" }, { "key": "sortDirection", "value": "asc" }, { "key": "reportedAtFrom", "value": "1981-06-05T00:45:55.849Z" }, { "key": "reportedAtTo", "value": "1981-06-05T00:45:55.849Z" }, { "key": "createdAtFrom", "value": "1981-06-05T00:45:55.849Z" }, { "key": "createdAtTo", "value": "1981-06-05T00:45:55.849Z" }, { "key": "expiresAtFrom", "value": "1981-06-05T00:45:55.849Z" }, { "key": "expiresAtTo", "value": "1981-06-05T00:45:55.849Z" }, { "key": "updatedAtFrom", "value": "1981-06-05T00:45:55.849Z" }, { "key": "updatedAtTo", "value": "1981-06-05T00:45:55.849Z" }, { "key": "needsManualReview", "value": "true" }, { "key": "id", "value": "string" }, { "key": "protocol", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"infractions\": [\n {\n \"id\": \"infraction_id\",\n \"protocol\": \"PROTOCOL123\",\n \"status\": \"OPEN\",\n \"type\": \"FRAUD\",\n \"reportedBy\": \"DEBITED_PARTICIPANT\",\n \"reportDetails\": \"Transação não autorizada\",\n \"analysisResult\": null,\n \"analysisDetails\": null,\n \"reportedAt\": \"2024-01-15T10:30:00Z\",\n \"expiresAt\": \"2024-02-15T10:30:00Z\",\n \"createdAt\": \"2024-01-15T10:30:00Z\",\n \"updatedAt\": \"2024-01-15T10:30:00Z\",\n \"transaction\": {\n \"id\": \"transaction_id\",\n \"amount\": 100.5,\n \"payerName\": \"João Silva\",\n \"payerDocument\": \"12345678901\",\n \"receiverName\": \"Maria Santos\",\n \"receiverDocument\": \"12345678901\",\n \"endToEndId\": \"E12345678202401151030001\"\n },\n \"defenseHistory\": []\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"limit\": 20,\n \"totalItems\": 45,\n \"totalPages\": 3\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73084aee-dd80-4ee9-9989-bd986af265f5", "name": "Bad Request, payload or query string failed validation", "originalRequest": { "url": { "path": [ "user", "infractions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "10" }, { "key": "status", "value": "string" }, { "key": "type", "value": "string" }, { "key": "endToEndId", "value": "string" }, { "key": "transactionId", "value": "string" }, { "key": "amountMin", "value": "9316.824872488278" }, { "key": "amountMax", "value": "9316.824872488278" }, { "key": "analysisResult", "value": "string" }, { "key": "reportedBy", "value": "string" }, { "key": "participantDocument", "value": "string" }, { "key": "participantName", "value": "string" }, { "key": "sortBy", "value": "string" }, { "key": "sortDirection", "value": "asc" }, { "key": "reportedAtFrom", "value": "1981-06-05T00:45:55.849Z" }, { "key": "reportedAtTo", "value": "1981-06-05T00:45:55.849Z" }, { "key": "createdAtFrom", "value": "1981-06-05T00:45:55.849Z" }, { "key": "createdAtTo", "value": "1981-06-05T00:45:55.849Z" }, { "key": "expiresAtFrom", "value": "1981-06-05T00:45:55.849Z" }, { "key": "expiresAtTo", "value": "1981-06-05T00:45:55.849Z" }, { "key": "updatedAtFrom", "value": "1981-06-05T00:45:55.849Z" }, { "key": "updatedAtTo", "value": "1981-06-05T00:45:55.849Z" }, { "key": "needsManualReview", "value": "true" }, { "key": "id", "value": "string" }, { "key": "protocol", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"querystring/dateFrom Invalid input: expected string, received undefined\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "735ed92d-dd89-491f-83a9-899d3a33e817", "name": "Unauthorized, missing or invalid Bearer token, or token lacks the required permission for this endpoint", "originalRequest": { "url": { "path": [ "user", "infractions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "10" }, { "key": "status", "value": "string" }, { "key": "type", "value": "string" }, { "key": "endToEndId", "value": "string" }, { "key": "transactionId", "value": "string" }, { "key": "amountMin", "value": "9316.824872488278" }, { "key": "amountMax", "value": "9316.824872488278" }, { "key": "analysisResult", "value": "string" }, { "key": "reportedBy", "value": "string" }, { "key": "participantDocument", "value": "string" }, { "key": "participantName", "value": "string" }, { "key": "sortBy", "value": "string" }, { "key": "sortDirection", "value": "asc" }, { "key": "reportedAtFrom", "value": "1981-06-05T00:45:55.849Z" }, { "key": "reportedAtTo", "value": "1981-06-05T00:45:55.849Z" }, { "key": "createdAtFrom", "value": "1981-06-05T00:45:55.849Z" }, { "key": "createdAtTo", "value": "1981-06-05T00:45:55.849Z" }, { "key": "expiresAtFrom", "value": "1981-06-05T00:45:55.849Z" }, { "key": "expiresAtTo", "value": "1981-06-05T00:45:55.849Z" }, { "key": "updatedAtFrom", "value": "1981-06-05T00:45:55.849Z" }, { "key": "updatedAtTo", "value": "1981-06-05T00:45:55.849Z" }, { "key": "needsManualReview", "value": "true" }, { "key": "id", "value": "string" }, { "key": "protocol", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 401,\n \"error\": \"Unauthorized\",\n \"message\": \"Missing or invalid Bearer token\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f510505-2257-4eb2-8754-077736ab0887", "name": "Resource not found", "originalRequest": { "url": { "path": [ "user", "infractions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "10" }, { "key": "status", "value": "string" }, { "key": "type", "value": "string" }, { "key": "endToEndId", "value": "string" }, { "key": "transactionId", "value": "string" }, { "key": "amountMin", "value": "9316.824872488278" }, { "key": "amountMax", "value": "9316.824872488278" }, { "key": "analysisResult", "value": "string" }, { "key": "reportedBy", "value": "string" }, { "key": "participantDocument", "value": "string" }, { "key": "participantName", "value": "string" }, { "key": "sortBy", "value": "string" }, { "key": "sortDirection", "value": "asc" }, { "key": "reportedAtFrom", "value": "1981-06-05T00:45:55.849Z" }, { "key": "reportedAtTo", "value": "1981-06-05T00:45:55.849Z" }, { "key": "createdAtFrom", "value": "1981-06-05T00:45:55.849Z" }, { "key": "createdAtTo", "value": "1981-06-05T00:45:55.849Z" }, { "key": "expiresAtFrom", "value": "1981-06-05T00:45:55.849Z" }, { "key": "expiresAtTo", "value": "1981-06-05T00:45:55.849Z" }, { "key": "updatedAtFrom", "value": "1981-06-05T00:45:55.849Z" }, { "key": "updatedAtTo", "value": "1981-06-05T00:45:55.849Z" }, { "key": "needsManualReview", "value": "true" }, { "key": "id", "value": "string" }, { "key": "protocol", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 404,\n \"error\": \"Not Found\",\n \"message\": \"Resource not found\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "963295c9-3819-4550-ae51-30a0a1f2e680", "name": "Get Infraction", "request": { "name": "Get Infraction", "description": { "content": "Get a specific infraction by ID.", "type": "text/plain" }, "url": { "path": [ "user", "infractions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Infraction ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "35abdae5-7f19-4371-ba0f-02794c93c127", "name": "Infraction details", "originalRequest": { "url": { "path": [ "user", "infractions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Infraction ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"infraction_123\",\n \"protocol\": \"PROTOCOL123\",\n \"status\": \"OPEN\",\n \"type\": \"FRAUD\",\n \"reportedBy\": \"DEBITED_PARTICIPANT\",\n \"reportDetails\": \"Transação não autorizada\",\n \"analysisResult\": null,\n \"analysisDetails\": null,\n \"reportedAt\": \"2024-01-15T10:30:00Z\",\n \"expiresAt\": \"2024-02-15T10:30:00Z\",\n \"createdAt\": \"2024-01-15T10:30:00Z\",\n \"updatedAt\": \"2024-01-15T10:30:00Z\",\n \"transaction\": {\n \"id\": \"transaction_id\",\n \"amount\": 100.5,\n \"payerName\": \"João Silva\",\n \"payerDocument\": \"12345678901\",\n \"receiverName\": \"Maria Santos\",\n \"receiverDocument\": \"12345678901\",\n \"endToEndId\": \"E12345678202401151030001\"\n },\n \"defenseHistory\": []\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f76b9527-de0e-4451-b7ee-4789e51fdbca", "name": "Infraction not found", "originalRequest": { "url": { "path": [ "user", "infractions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Infraction ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 404,\n \"error\": \"Not Found\",\n \"message\": \"Resource not found\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a7fa0231-9330-46c8-82eb-42ec1ac2518a", "name": "Create Defense", "request": { "name": "Create Defense", "description": { "content": "Create a defense for a specific infraction.", "type": "text/plain" }, "url": { "path": [ "user", "infractions", ":id", "defenses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Infraction ID" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "formdata", "formdata": [ { "key": "defense", "value": "string", "type": "text", "description": "(Required) Defense text (max: 1000 characters)" }, { "key": "files", "value": "[\"string\",\"string\"]", "type": "text", "description": "Evidence files (max: 10MB total)" } ] } }, "response": [ { "id": "1006063c-a562-4f40-bf12-0bae9b87e4c6", "name": "Defense created", "originalRequest": { "url": { "path": [ "user", "infractions", ":id", "defenses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Infraction ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Defense text (max: 1000 characters)", "type": "text/plain" }, "key": "defense", "value": "string", "type": "text" }, { "description": { "content": "Evidence files (max: 10MB total)", "type": "text/plain" }, "key": "files", "value": "[\"string\",\"string\"]", "type": "text" } ] } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"defense_id\",\n \"defense\": \"Esta transação foi devidamente autorizada pelo cliente através do app mobile.\",\n \"status\": \"PENDING\",\n \"infractionId\": \"infraction_123\",\n \"createdAt\": \"2024-01-16T14:20:00Z\",\n \"updatedAt\": \"2024-01-16T14:20:00Z\",\n \"files\": [\n {\n \"name\": \"evidencia1.pdf\",\n \"mimeType\": \"application/pdf\",\n \"size\": 245760,\n \"url\": \"https://storage.googleapis.com/bucket/signed-url-1\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3dbf179f-9803-4355-87f2-6a4b9ba2b343", "name": "Invalid file or provider does not support defense", "originalRequest": { "url": { "path": [ "user", "infractions", ":id", "defenses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Infraction ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Defense text (max: 1000 characters)", "type": "text/plain" }, "key": "defense", "value": "string", "type": "text" }, { "description": { "content": "Evidence files (max: 10MB total)", "type": "text/plain" }, "key": "files", "value": "[\"string\",\"string\"]", "type": "text" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"querystring/dateFrom Invalid input: expected string, received undefined\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a3c9d39-28af-4b98-86ea-abe6d152d38f", "name": "Infraction not found", "originalRequest": { "url": { "path": [ "user", "infractions", ":id", "defenses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Infraction ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Defense text (max: 1000 characters)", "type": "text/plain" }, "key": "defense", "value": "string", "type": "text" }, { "description": { "content": "Evidence files (max: 10MB total)", "type": "text/plain" }, "key": "files", "value": "[\"string\",\"string\"]", "type": "text" } ] } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 404,\n \"error\": \"Not Found\",\n \"message\": \"Resource not found\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd2fee2d-0bb2-439f-8686-328523c726e2", "name": "Infraction not open for defense", "originalRequest": { "url": { "path": [ "user", "infractions", ":id", "defenses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Infraction ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Defense text (max: 1000 characters)", "type": "text/plain" }, "key": "defense", "value": "string", "type": "text" }, { "description": { "content": "Evidence files (max: 10MB total)", "type": "text/plain" }, "key": "files", "value": "[\"string\",\"string\"]", "type": "text" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 422,\n \"error\": \"Unprocessable Entity\",\n \"message\": \"Insufficient balance for this operation\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "389a3708-5c2e-4e92-aace-8dc331fc0020", "name": "List Defenses", "request": { "name": "List Defenses", "description": { "content": "List all defenses for a specific infraction. **Requires support privileges**.", "type": "text/plain" }, "url": { "path": [ "user", "infractions", ":id", "defenses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Infraction ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ee955607-9d0f-42a9-b013-d6af1f226fff", "name": "List of defenses", "originalRequest": { "url": { "path": [ "user", "infractions", ":id", "defenses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Infraction ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"defense_id_1\",\n \"defense\": \"Primeira defesa enviada\",\n \"status\": \"DEFENDED\",\n \"infractionId\": \"infraction_123\",\n \"createdAt\": \"2024-01-16T14:20:00Z\",\n \"updatedAt\": \"2024-01-17T09:15:00Z\",\n \"files\": []\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e22655d6-1c33-45dc-8bfa-a768db561fbd", "name": "Bad Request, payload or query string failed validation", "originalRequest": { "url": { "path": [ "user", "infractions", ":id", "defenses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Infraction ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"querystring/dateFrom Invalid input: expected string, received undefined\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8fd47b7f-49e5-44ba-b673-5bde33a81a02", "name": "Unauthorized, missing or invalid Bearer token, or token lacks the required permission for this endpoint", "originalRequest": { "url": { "path": [ "user", "infractions", ":id", "defenses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Infraction ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 401,\n \"error\": \"Unauthorized\",\n \"message\": \"Missing or invalid Bearer token\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c39a4a25-fa7b-4ea6-943f-1871c0dd582b", "name": "Resource not found", "originalRequest": { "url": { "path": [ "user", "infractions", ":id", "defenses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Infraction ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 404,\n \"error\": \"Not Found\",\n \"message\": \"Resource not found\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8baef536-b0a8-4081-b67b-5bfa637fd68b", "name": "Get Defense", "request": { "name": "Get Defense", "description": { "content": "Get a specific defense for an infraction. **Requires support privileges**.", "type": "text/plain" }, "url": { "path": [ "user", "infractions", ":infractionId", "defenses", ":defenseId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "infractionId", "description": "(Required) Infraction ID" }, { "disabled": false, "type": "any", "value": "string", "key": "defenseId", "description": "(Required) Defense ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "89b1059f-6029-41c6-b673-8843af4a4ef2", "name": "Defense details", "originalRequest": { "url": { "path": [ "user", "infractions", ":infractionId", "defenses", ":defenseId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "infractionId", "description": "(Required) Infraction ID" }, { "disabled": false, "type": "any", "value": "string", "key": "defenseId", "description": "(Required) Defense ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"defense_id\",\n \"defense\": \"Esta transação foi devidamente autorizada.\",\n \"status\": \"DEFENDED\",\n \"infractionId\": \"infraction_123\",\n \"createdAt\": \"2024-01-16T14:20:00Z\",\n \"updatedAt\": \"2024-01-17T09:15:00Z\",\n \"files\": [\n {\n \"name\": \"evidencia1.pdf\",\n \"size\": 245760,\n \"mimeType\": \"application/pdf\",\n \"url\": \"https://storage.googleapis.com/bucket/signed-url-1\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e70c259-5c8d-4f13-adf9-7d021250b2ff", "name": "Defense not found", "originalRequest": { "url": { "path": [ "user", "infractions", ":infractionId", "defenses", ":defenseId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "infractionId", "description": "(Required) Infraction ID" }, { "disabled": false, "type": "any", "value": "string", "key": "defenseId", "description": "(Required) Defense ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 404,\n \"error\": \"Not Found\",\n \"message\": \"Resource not found\",\n \"requestId\": \"cmou00000abcdef01s6ghij1k2lm\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [], "variable": [ { "key": "baseUrl", "value": "https://api.exemplo.processamento.com/v1", "type": "string", "description": "Base URL da API Pix Processamento" }, { "key": "token", "value": "", "type": "string", "description": "Bearer token Pix Processamento" } ], "info": { "_postman_id": "50aaed54-27c0-4ae8-8992-3434050a302d", "name": "Pix Processamento Pix API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "REST API for Pix operations on the Pix Processamento platform, deposits, withdrawals, internal transfers, infractions, reports, and callback inspection. All amounts are in BRL (reais) unless explicitly noted. Authentication uses a Bearer token issued during onboarding.\n\n## SDKs oficiais\n\n- Node.js: `npm install pix-pix`\n- Python: `pip install pix-pix`\n- Go: `go get __STRIP_SDK_REF__/go`\n- PHP: `composer require pix/pix`\n\nRepo: https://__STRIP_SDK_REF__\n\n\nContact Support:\n Name: Suporte Pix Processamento", "type": "text/plain" } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] } }