{ "item": [ { "id": "2495e89a-213e-443d-96a1-60acf9743caa", "name": "Pix Operations", "description": { "content": "Create and manage Pix charges (deposits)", "type": "text/plain" }, "item": [ { "id": "a8514f43-41b9-4d0b-ae02-33f7dba39d77", "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": "8f37be75-a191-4844-ad59-20d58f9d537c", "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\": \"MAGEN20250817215911F49RDOBJ\",\n \"status\": \"PENDING\",\n \"amount\": 10,\n \"type\": \"DEPOSIT\",\n \"callbackUrl\": \"https://webhook.cool/\",\n \"qrCodeText\": \"00020126870014br.gov.bcb.pix2565qrcode.magen.com.br/dynamic/d7790b91-3979-4ad5-9d96-ee941e5a42765204000053039865802BR5908MAGENPLUS6009SAO PAULO62070503***63047EE4\",\n \"qrCodeBase64\": \"iVBORw0KGgoAAAANSUhEUgAAAZAAAAGQCAYAAAC...\",\n \"qrCodeUrl\": \"https://pix.magen.com.br/v1/pix/qr-code/MAGEN20250817215911F49RDOBJ\",\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": "0371771e-cd44-4b27-b7c3-2cf9947584ea", "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": "a9f1740a-d44b-4dea-823f-3109e76f1683", "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": "6e35c9bd-6f76-431c-a83c-2f281a3b0647", "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`. Use apenas um destes parâmetros: id, clientReference, endToEndId. Combinar mais de um retorna erro.", "type": "text/plain" }, "url": { "path": [ "pix" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "id", "value": "MAGEN20250817215911F49RDOBJ", "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": "Subconta virtual (até 50 caracteres) usada na criação. Aceito como chave de busca alternativa." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "d0e0813f-5e43-4f1e-ac17-e0aba24fdc74", "name": "Current transaction state", "originalRequest": { "url": { "path": [ "pix" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "id", "value": "MAGEN20250817215911F49RDOBJ" }, { "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 " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"MAGEN20250817215911F49RDOBJ\",\n \"status\": \"PENDING\",\n \"amount\": 10,\n \"type\": \"DEPOSIT\",\n \"callbackUrl\": \"https://webhook.cool/\",\n \"qrCodeText\": \"00020126870014br.gov.bcb.pix2565qrcode.magen.com.br/dynamic/d7790b91-3979-4ad5-9d96-ee941e5a42765204000053039865802BR5908MAGENPLUS6009SAO PAULO62070503***63047EE4\",\n \"qrCodeBase64\": \"iVBORw0KGgoAAAANSUhEUgAAAZAAAAGQCAYAAAC...\",\n \"qrCodeUrl\": \"https://pix.magen.com.br/v1/pix/qr-code/MAGEN20250817215911F49RDOBJ\",\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": "d540968e-f5f8-476a-80d0-5f18f88edea1", "name": "Bad Request, payload or query string failed validation", "originalRequest": { "url": { "path": [ "pix" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "id", "value": "MAGEN20250817215911F49RDOBJ" }, { "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 " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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": "2ee70a37-5f6d-472b-baf8-1249b9d2a718", "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": "MAGEN20250817215911F49RDOBJ" }, { "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 " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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": "17db97c5-5cdf-4e91-995d-00183acb437c", "name": "Resource not found", "originalRequest": { "url": { "path": [ "pix" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "id", "value": "MAGEN20250817215911F49RDOBJ" }, { "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 " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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": "c69687c9-eed3-48c8-b3e0-f97842737575", "name": "Get Transaction Receipt", "request": { "name": "Get Transaction Receipt", "description": { "content": "Retorna o comprovante da transação como JSON com o campo `base64` (PDF codificado). Decodifique pra exibir ou salvar como `.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": "MAGEN2025081418333632CYKN8M", "key": "id", "description": "(Required) Transaction ID." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "f30d74e4-7e53-4f5a-9fee-4c24a104aa0f", "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": "MAGEN2025081418333632CYKN8M", "key": "id", "description": "(Required) Transaction ID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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": "2cbd179a-d530-4a10-925e-dec1be99e9ad", "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": "MAGEN2025081418333632CYKN8M", "key": "id", "description": "(Required) Transaction ID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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": "6aa6506b-025b-4dbd-8737-bab6a90617e1", "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": "MAGEN2025081418333632CYKN8M", "key": "id", "description": "(Required) Transaction ID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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": "5318314a-6be4-4648-9b92-923b245bd5d8", "name": "Resource not found", "originalRequest": { "url": { "path": [ "proof", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "type", "value": "pdf" } ], "variable": [ { "disabled": false, "type": "any", "value": "MAGEN2025081418333632CYKN8M", "key": "id", "description": "(Required) Transaction ID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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": "ec4eb97d-5022-4cbe-8668-35f812d0810e", "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": "5c4c386e-ceb2-4395-abd0-5f1e4c652c1e", "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 " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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": "b976f2e1-cc00-48b1-830c-8e72f1aa0a60", "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 " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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": "d1a94343-e6ff-4d8f-9db4-cea3333ef5f3", "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 " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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": "a2d421f5-df72-4782-b778-b40188334421", "name": "Withdrawals", "description": { "content": "Send money via Pix (cash out) and DICT key/QR-code consultation", "type": "text/plain" }, "item": [ { "id": "a83652b8-f36f-40bd-85cd-7142590ee558", "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@magen.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": "dbf3bfc0-3a40-4c47-851a-4082690b7774", "name": "Pix key information retrieved successfully", "originalRequest": { "url": { "path": [ "pix", "key" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "pixKey", "value": "example@magen.com.br" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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": "d04577ae-86f3-4036-9a71-fde9ca3e42d3", "name": "Invalid Pix key format", "originalRequest": { "url": { "path": [ "pix", "key" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "pixKey", "value": "example@magen.com.br" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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": "e08c4a2b-f86c-4394-8ef4-b66a40d8f00c", "name": "Pix key not found in DICT", "originalRequest": { "url": { "path": [ "pix", "key" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "pixKey", "value": "example@magen.com.br" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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": "d6878ee9-dc4e-4dae-9279-71b2ad8b0ce2", "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. No momento a Magen só suporta QR Code dinâmico. QR estático ainda não é processado.", "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.magen/pix/qr/v2/013318d6-2d7d-479e-8bb3-b5c7b9da688c5204000053039865802BR5916MAGEN 6007SAOPAULO6217051320260118278956304EC55\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4e236025-2c42-4d62-8d38-a69bc9a681b5", "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.magen/pix/qr/v2/013318d6-2d7d-479e-8bb3-b5c7b9da688c5204000053039865802BR5916MAGEN 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": "115b2314-2410-4b92-9170-bc014c3b2276", "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.magen/pix/qr/v2/013318d6-2d7d-479e-8bb3-b5c7b9da688c5204000053039865802BR5916MAGEN 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": "224ca99c-1337-4aaf-aa13-21840137b802", "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": "04ffd58d-fb95-44cf-918a-7faccf644dcb", "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\": \"MAGEN2025081721512946OOLK75\",\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": "fc410d09-6dae-46d1-a539-9d4f574a1577", "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": "bbd62f4a-e9f3-4c90-a756-69533284265a", "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": "85f76e67-f669-4487-844f-ec9c0481cdd6", "name": "Retrieve Withdrawal", "request": { "name": "Retrieve Withdrawal", "description": { "content": "Get the latest status and details for a **withdrawal**. You can provide any **one** of the following parameters: `id`, `clientReference`, or `endToEndId`. All three are optional and you can use any one of them to retrieve the withdrawal. Use apenas um destes parâmetros: id, clientReference, endToEndId. Combinar mais de um retorna erro.", "type": "text/plain" }, "url": { "path": [ "withdraw" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "id", "value": "MAGEN2025081721512946OOLK75", "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": "Subconta virtual (até 50 caracteres) usada na criação. Aceito como chave de busca alternativa." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "0dea8ac6-21a5-4ab5-b4c3-712eb0cefd1b", "name": "Current withdrawal state", "originalRequest": { "url": { "path": [ "withdraw" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "id", "value": "MAGEN2025081721512946OOLK75" }, { "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 " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"MAGEN2025081721512946OOLK75\",\n \"status\": \"PENDING\",\n \"amount\": 2,\n \"type\": \"WITHDRAW\",\n \"callbackUrl\": \"https://webhook.cool/\",\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": "f48ceba5-a67d-406e-900f-f45458b21c98", "name": "Bad Request, payload or query string failed validation", "originalRequest": { "url": { "path": [ "withdraw" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "id", "value": "MAGEN2025081721512946OOLK75" }, { "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 " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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": "0b3a92c8-8b30-4612-a943-1001dd85f743", "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": "MAGEN2025081721512946OOLK75" }, { "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 " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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": "9c639af8-aa37-4757-9c0b-81a6537878d8", "name": "Resource not found", "originalRequest": { "url": { "path": [ "withdraw" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "id", "value": "MAGEN2025081721512946OOLK75" }, { "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 " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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": "7a5b1afe-5be8-47a5-bc95-0707334d29c8", "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. No momento a Magen só suporta QR Code dinâmico. QR estático ainda não é processado.", "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.magen/pix/qr/v2/013318d6-2d7d-479e-8bb3-b5c7b9da688c5204000053039865802BR5916MAGEN 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": "bce3b3fb-6575-47c1-8335-634498aa0e99", "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.magen/pix/qr/v2/013318d6-2d7d-479e-8bb3-b5c7b9da688c5204000053039865802BR5916MAGEN 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\": \"MAGEN202511061998787515D0PH2Y\",\n \"status\": \"PENDING\",\n \"amount\": 20,\n \"type\": \"WITHDRAW\",\n \"callbackUrl\": \"https://bright-lightning-66.webhook.cool\",\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": "34af2e6f-7a8c-425e-922f-5d22863e9376", "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.magen/pix/qr/v2/013318d6-2d7d-479e-8bb3-b5c7b9da688c5204000053039865802BR5916MAGEN 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": "40c78806-634b-4cb9-a173-4c6f21e2f734", "name": "Get Withdrawal Receipt", "request": { "name": "Get Withdrawal Receipt", "description": { "content": "Retorna o comprovante da transação como JSON com o campo `base64` (PDF codificado). Decodifique pra exibir ou salvar como `.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": "MAGEN2025081721512946OOLK75", "key": "id", "description": "(Required) Transaction ID." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "f7e660b5-981e-42a0-95be-8bc849304d38", "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": "MAGEN2025081721512946OOLK75", "key": "id", "description": "(Required) Transaction ID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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": "1a6e213a-0f08-4f29-8603-ec7124d8e58a", "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": "MAGEN2025081721512946OOLK75", "key": "id", "description": "(Required) Transaction ID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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": "8f7e26e0-c316-4197-af34-4883351ce350", "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": "MAGEN2025081721512946OOLK75", "key": "id", "description": "(Required) Transaction ID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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": "a7d89155-e399-41cf-93f8-56f523bee136", "name": "Resource not found", "originalRequest": { "url": { "path": [ "withdraw", "proof", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "type", "value": "pdf" } ], "variable": [ { "disabled": false, "type": "any", "value": "MAGEN2025081721512946OOLK75", "key": "id", "description": "(Required) Transaction ID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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": "728795eb-8298-4b84-ba5d-13bd23b172a3", "name": "Internal Transfer", "description": { "content": "Transfer funds between Magen accounts (free, instant)", "type": "text/plain" }, "item": [ { "id": "23bda844-f942-4fd3-9bc3-1f03c091e9f4", "name": "Create internal transfer", "request": { "name": "Create internal transfer", "description": { "content": "Send funds to another Magen account using its 6-digit accountNumber. Settles instantly within Magen.", "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": "2099dc52-968d-4081-82cb-1f9d66131eeb", "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\": \"MAGEN20260506T142500ABC123\",\n \"status\": \"COMPLETED\",\n \"amount\": 100.5,\n \"type\": \"WITHDRAW\",\n \"callbackUrl\": null,\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\": \"MAGEN IP LTDA.\",\n \"payerAccountNumber\": \"513579\",\n \"withdrawPixKey\": null,\n \"withdrawPixType\": null,\n \"receiverName\": \"Maria Santos\",\n \"receiverDocument\": \"98765432109\",\n \"receiverInstitutionIspb\": \"23066240\",\n \"receiverInstitutionName\": \"MAGEN 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": "02dfa92c-cdc0-4f88-bd7b-90b2480262d1", "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": "33bba710-e230-4e9f-a1ef-7f61f4071efb", "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": "cc93a39a-0a56-45d2-bebb-ff40c87d7f87", "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": "07da299e-38c5-499e-961f-ec9285e68b42", "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": "06cedec6-7613-4b6a-878f-75ca2c96b9d6", "name": "Get internal transfer", "request": { "name": "Get internal transfer", "description": { "content": "Retrieve an internal transfer by id or clientReference Use apenas um destes parâmetros: id, clientReference. Combinar mais de um retorna erro.", "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": "Subconta virtual (até 50 caracteres) usada na criação. Aceito como chave de busca alternativa." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "cbf0930f-23a0-433a-b239-b9376301de37", "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 " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"MAGEN20260506T142500ABC123\",\n \"status\": \"COMPLETED\",\n \"amount\": 100.5,\n \"type\": \"WITHDRAW\",\n \"callbackUrl\": null,\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\": \"MAGEN IP LTDA.\",\n \"payerAccountNumber\": \"513579\",\n \"withdrawPixKey\": null,\n \"withdrawPixType\": null,\n \"receiverName\": \"Maria Santos\",\n \"receiverDocument\": \"98765432109\",\n \"receiverInstitutionIspb\": \"23066240\",\n \"receiverInstitutionName\": \"MAGEN 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": "20c4b776-e05c-48dd-83ef-057e3ec1b4cc", "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 " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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": "64602a90-08a9-48b1-a055-cdeebb454dc9", "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 " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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": "1953ec59-5b4d-4fd5-aa08-fb411b6e9bb1", "name": "Account", "description": { "content": "Account profile, balance, and auto-withdraw configuration", "type": "text/plain" }, "item": [ { "id": "e7ddfb44-d3d6-4a45-ba7e-6a6af3a2cc50", "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": "21453ed0-491d-4158-945a-178dd6991704", "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 " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"accountNumber\": \"513579\",\n \"name\": \"MAGEN\",\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": "9154e4b6-f338-4b09-b349-c340cc18a374", "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 " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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": "bcf9ca76-1dbb-4d4a-8055-9966c0e8fb90", "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 " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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": "3f4bf35b-c9a2-44d5-bbbc-89266ad07288", "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": "89badb99-8c0a-4534-8152-48dbc332c431", "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 " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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": "83432bcd-9831-4144-a697-02bce1b1fc1f", "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 " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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": "92e79942-2585-4c11-ae63-a600e0fac53d", "name": "Reports", "description": { "content": "Transaction history, reports, bank statements, and pending deposits", "type": "text/plain" }, "item": [ { "id": "6f1087b2-2d0d-420b-bc97-5d450ad01c00", "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": "MAGEN2025081418333632CYKN8M", "description": "Transaction ID." }, { "disabled": false, "key": "status", "value": "COMPLETED", "description": "Status da transação. Aceita CSV: PENDING,COMPLETED,etc." }, { "disabled": false, "key": "type", "value": "DEPOSIT", "description": "Tipo da transação. Aceita CSV: DEPOSIT,WITHDRAW,COMMISSION." }, { "disabled": false, "key": "amount", "value": "15000", "description": "Amount filter." }, { "disabled": false, "key": "document", "value": "12345678901", "description": "CPF (11 dígitos) ou CNPJ (14 dígitos), apenas números sem formatação." }, { "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": "Subconta virtual (até 50 caracteres) usada na criação. Aceito como chave de busca alternativa." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "7f1baf0a-4255-479b-a1fd-aba0da8d149a", "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": "MAGEN2025081418333632CYKN8M" }, { "key": "status", "value": "COMPLETED" }, { "key": "type", "value": "DEPOSIT" }, { "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 " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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\": \"MAGEN202511061998787515D0PH2Y\",\n \"amount\": 10,\n \"status\": \"PENDING\",\n \"type\": \"DEPOSIT\",\n \"callbackUrl\": \"https://webhook.site/9cdd5879-5767-4e95-bf57-1ac29e0ad3d7\",\n \"qrCodeText\": \"00020126860014br.gov.bcb.pix2564qrcode.magen.com.br/pix/84f95c33-3c86-4708-87f1-0e09b96b35795204000053039865802BR5908PAYZPLUS6009SAO PAULO62070503***63048227\",\n \"qrCodeBase64\": null,\n \"qrCodeUrl\": \"https://pix.magen.com.br/v1/pix/qr-code/MAGEN202511061998787515D0PH2Y\",\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\": \"MAGEN202511061998787515D0PH2Y\",\n \"amount\": 5.5,\n \"status\": \"ERROR\",\n \"type\": \"WITHDRAW\",\n \"callbackUrl\": \"https://webhook.site/9cdd5879-5767-4e95-bf57-1ac29e0ad3d7\",\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": "8ced4bcc-93e4-49e2-bc75-4c954137246f", "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": "MAGEN2025081418333632CYKN8M" }, { "key": "status", "value": "COMPLETED" }, { "key": "type", "value": "DEPOSIT" }, { "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 " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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": "1fbdb246-a4bc-4cf5-8338-1517d37264e5", "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": "MAGEN2025081418333632CYKN8M" }, { "key": "status", "value": "COMPLETED" }, { "key": "type", "value": "DEPOSIT" }, { "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 " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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": "d6cc53f9-3b19-4c91-bca9-86499f8d783a", "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": "MAGEN2025081418333632CYKN8M" }, { "key": "status", "value": "COMPLETED" }, { "key": "type", "value": "DEPOSIT" }, { "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 " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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": "6f383ee2-6550-4939-ad5e-8b0d22eb323c", "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": "77ed24a5-2868-4320-bf54-c47aa9536135", "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 " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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\": 9421.522261503298,\n \"type\": \"string\",\n \"callbackUrl\": \"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\": 5461.830227867046,\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\": \"string\",\n \"refundStatus\": \"string\",\n \"refundReason\": \"string\",\n \"refundDescription\": \"string\",\n \"refundedAt\": \"string\",\n \"cancellationReason\": \"string\",\n \"infraction\": {\n \"id\": \"string\",\n \"protocol\": \"string\",\n \"status\": \"OPEN\",\n \"type\": \"FRAUD\",\n \"reportDetails\": \"string\",\n \"reportedBy\": \"DEBITED_PARTICIPANT\",\n \"analysisResult\": \"string\",\n \"analysisDetails\": \"string\",\n \"reportedAt\": \"2014-03-24T14:23:13.034Z\",\n \"expiresAt\": \"1950-09-24T04:48:32.889Z\",\n \"createdAt\": \"1950-06-24T04:39:45.485Z\",\n \"updatedAt\": \"1968-09-11T04:18:48.283Z\"\n },\n \"virtualAccount\": \"string\",\n \"infractions\": [\n {\n \"id\": \"string\",\n \"status\": \"string\",\n \"createdAt\": \"1959-11-28T22:04:52.954Z\",\n \"updatedAt\": \"1996-05-16T05:23:09.999Z\"\n },\n {\n \"id\": \"string\",\n \"status\": \"string\",\n \"createdAt\": \"1946-09-11T20:53:21.492Z\",\n \"updatedAt\": \"2024-01-13T19:31:33.003Z\"\n }\n ],\n \"callbackLogs\": [\n {\n \"id\": \"string\",\n \"url\": \"string\",\n \"status\": 1156,\n \"responseTime\": 3700.3411076295943,\n \"createdAt\": \"1996-12-07T10:15:39.519Z\"\n },\n {\n \"id\": \"string\",\n \"url\": \"string\",\n \"status\": 7492,\n \"responseTime\": 7222.45134212248,\n \"createdAt\": \"1954-05-24T17:41:59.722Z\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "50b6172f-3131-4402-a26d-b7094e1ad3d9", "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 " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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": "6b78410c-95a4-498d-b9a7-da59911e1453", "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\": \"1988-05-09T11:24:39.065Z\",\n \"dateTo\": \"1993-02-02T19:19:41.797Z\",\n \"status\": [\n \"PENDING\",\n \"REFUNDED\"\n ],\n \"type\": [\n \"COMMISSION\",\n \"DEPOSIT\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f20bfa06-2437-4d19-9478-cfc21905e8d9", "name": "Report job enqueued", "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\": \"1990-05-20T17:44:23.115Z\",\n \"dateTo\": \"1962-08-01T18:24:20.505Z\",\n \"status\": [\n \"ERROR\",\n \"COMPLETED\"\n ],\n \"type\": [\n \"DEPOSIT\",\n \"DEPOSIT\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"ee5c963e-aade-8fb8-2334-dde1fa8d6b75\",\n \"status\": \"FAILED\",\n \"createdAt\": \"1999-09-23T17:34:00.168Z\",\n \"updatedAt\": \"2013-06-28T03:56:34.384Z\",\n \"expiresAt\": \"1958-11-09T09:46:54.724Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "45472b60-c120-41a1-b020-9b7c05182ab0", "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\": \"1990-05-20T17:44:23.115Z\",\n \"dateTo\": \"1962-08-01T18:24:20.505Z\",\n \"status\": [\n \"ERROR\",\n \"COMPLETED\"\n ],\n \"type\": [\n \"DEPOSIT\",\n \"DEPOSIT\"\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": "921a4b34-b98e-4187-a826-104b28cec911", "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" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "5d3308a8-46e0-42ca-907e-61ad01889ab1", "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" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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": "8ab3432f-ed5f-4783-8973-384ba71e2d0e", "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" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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": "9163c605-4b75-4823-b6c9-448dd5da9733", "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" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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": "aa82a1d3-8816-4458-9795-b1a194cc252c", "name": "Resource not found", "originalRequest": { "url": { "path": [ "user", "report" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "10" }, { "key": "status", "value": "PENDING" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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": "b29f6306-b42d-4e5c-a2d2-fc22877983ca", "name": "List report job status", "request": { "name": "List report job status", "description": { "content": "List report jobs created by the authenticated user.", "type": "text/plain" }, "url": { "path": [ "user", "report", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "f8d643f0-5de5-25e9-f2cb-e89a06e4d399", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b0c35a1f-6e58-4a76-bff8-8c49025f945a", "name": "Report job", "originalRequest": { "url": { "path": [ "user", "report", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "f8d643f0-5de5-25e9-f2cb-e89a06e4d399", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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": "e36dfe9e-3506-4996-99cd-ebf17f590d7d", "name": "Report not found", "originalRequest": { "url": { "path": [ "user", "report", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "f8d643f0-5de5-25e9-f2cb-e89a06e4d399", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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": "387fa7e5-db4d-4c0a-a32e-ab772bffd101", "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": "f8d643f0-5de5-25e9-f2cb-e89a06e4d399", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "76a1cf1a-e939-43f6-8ede-a4522d9e24db", "name": "Signed download URL", "originalRequest": { "url": { "path": [ "user", "report", ":id", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "f8d643f0-5de5-25e9-f2cb-e89a06e4d399", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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": "193225a4-992f-4803-b4d3-095a73c630f6", "name": "Report not found", "originalRequest": { "url": { "path": [ "user", "report", ":id", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "f8d643f0-5de5-25e9-f2cb-e89a06e4d399", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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": "519b7ac5-7c91-4c58-a17d-33c9df414530", "name": "Report file expired", "originalRequest": { "url": { "path": [ "user", "report", ":id", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "f8d643f0-5de5-25e9-f2cb-e89a06e4d399", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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": "2c11590d-e8b0-44ae-8c58-ba9582f5fc9d", "name": "Report not ready (still processing)", "originalRequest": { "url": { "path": [ "user", "report", ":id", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "f8d643f0-5de5-25e9-f2cb-e89a06e4d399", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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": "e3b312c3-d21e-4992-9acc-10aaf90e29de", "name": "Callbacks", "description": { "content": "Webhook callback inspection and re-trigger", "type": "text/plain" }, "item": [ { "id": "f5e7fafc-5e97-49df-9ddf-c7db17d8b6e1", "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": "463", "description": "HTTP status code" }, { "disabled": false, "key": "transactionId", "value": "string" }, { "disabled": false, "key": "hasError", "value": "false", "description": "Filter callbacks that errored" }, { "disabled": false, "key": "createdAtFrom", "value": "1987-03-30T06:54:15.114Z" }, { "disabled": false, "key": "createdAtTo", "value": "1987-03-30T06:54:15.114Z" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "0a43770f-fc0b-40cb-bee7-0729f6ed58b4", "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": "463" }, { "key": "transactionId", "value": "string" }, { "key": "hasError", "value": "true" }, { "key": "createdAtFrom", "value": "1987-03-30T06:54:15.114Z" }, { "key": "createdAtTo", "value": "1987-03-30T06:54:15.114Z" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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\": \"MAGEN2025102213082667EDC8079C\",\n \"createdAt\": \"2025-10-22T13:26:53.219Z\",\n \"responseTime\": 124,\n \"body\": {\n \"id\": \"MAGEN2025102213082667EDC8079C\",\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": "0d54c1ee-6ea4-4000-87af-54938d1babe6", "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": "463" }, { "key": "transactionId", "value": "string" }, { "key": "hasError", "value": "true" }, { "key": "createdAtFrom", "value": "1987-03-30T06:54:15.114Z" }, { "key": "createdAtTo", "value": "1987-03-30T06:54:15.114Z" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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": "8e40ea9d-f049-4a0f-a304-b9c5a59fa8f5", "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": "463" }, { "key": "transactionId", "value": "string" }, { "key": "hasError", "value": "true" }, { "key": "createdAtFrom", "value": "1987-03-30T06:54:15.114Z" }, { "key": "createdAtTo", "value": "1987-03-30T06:54:15.114Z" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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": "e1087ba8-1ea4-4509-8290-5363661ebe83", "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": "463" }, { "key": "transactionId", "value": "string" }, { "key": "hasError", "value": "true" }, { "key": "createdAtFrom", "value": "1987-03-30T06:54:15.114Z" }, { "key": "createdAtTo", "value": "1987-03-30T06:54:15.114Z" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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": "ce75da43-a297-46be-ab20-023f4449641f", "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": "91f70aff-f466-4348-a5b2-8f14636311e9", "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 " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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\": \"MAGEN2025102213082667EDC8079C\",\n \"createdAt\": \"2025-10-22T13:26:53.219Z\",\n \"responseTime\": 124,\n \"body\": {\n \"id\": \"MAGEN2025102213082667EDC8079C\",\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": "c303c7dc-cbdd-4233-94c1-57c2a804a049", "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 " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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": "29c3f19c-239f-4ef3-863c-607ddce4c434", "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": "ba86345f-ba3e-40a8-8ef2-9b7e043db5ea", "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": "628547a5-6a82-4c7e-9686-31c8ccdecf16", "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": "dea40b95-4afe-48a8-82c1-df6cb3c22d59", "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": "83a0a8f4-7915-498f-b597-dc12be6b1092", "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": "6b64a362-2be2-440d-974b-3c7bc287a833", "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 " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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": "50b023f3-c786-4dbb-b428-f2497cb993a1", "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 " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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": "474c45be-06df-4756-8ef8-78f8109a9627", "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 " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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": "578c14c3-d88f-4642-9f27-5f9887be0c9b", "name": "Infractions", "description": { "content": "Manage Pix infractions (disputes, fraud reports) and submit defenses", "type": "text/plain" }, "item": [ { "id": "608ef081-21e4-4a5e-8400-b0342e0cc869", "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": "3202.0987264308555" }, { "disabled": false, "key": "amountMax", "value": "3202.0987264308555" }, { "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" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "f6dd1d16-6cac-40e0-a437-b5de17444a25", "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": "3202.0987264308555" }, { "key": "amountMax", "value": "3202.0987264308555" }, { "key": "analysisResult", "value": "string" }, { "key": "reportedBy", "value": "string" }, { "key": "participantDocument", "value": "string" }, { "key": "participantName", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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": "1635cb3d-ffc3-4967-b6a3-9e7feddca2ca", "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": "3202.0987264308555" }, { "key": "amountMax", "value": "3202.0987264308555" }, { "key": "analysisResult", "value": "string" }, { "key": "reportedBy", "value": "string" }, { "key": "participantDocument", "value": "string" }, { "key": "participantName", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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": "8d7f9c82-d22e-48ed-8ada-f3a9464c9632", "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": "3202.0987264308555" }, { "key": "amountMax", "value": "3202.0987264308555" }, { "key": "analysisResult", "value": "string" }, { "key": "reportedBy", "value": "string" }, { "key": "participantDocument", "value": "string" }, { "key": "participantName", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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": "e46e36ba-08fb-4b2f-aca1-0bbd45da88c4", "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": "3202.0987264308555" }, { "key": "amountMax", "value": "3202.0987264308555" }, { "key": "analysisResult", "value": "string" }, { "key": "reportedBy", "value": "string" }, { "key": "participantDocument", "value": "string" }, { "key": "participantName", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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": "f3386ee3-0c41-405b-9f43-721922964530", "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": "34c6386c-3dd3-4a89-be7a-4aaee5fd9867", "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 " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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": "40c031fa-5f26-4f84-bd27-f739f477f24d", "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 " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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": "a8a6496f-54ca-49a3-b008-c7315d57acb0", "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": "1a6271c7-b2be-41f5-bcca-adacd874424a", "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": "115e2e97-4353-47fb-bcf5-8cf1b3102be9", "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": "de02d3b3-30fb-4eef-ac32-2bb3e204c338", "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": "ba120fba-881c-4d61-93d5-49f188995d78", "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": "ce498124-2153-4c52-81d3-64ca6fd698ac", "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": "dc2d9cdf-9bbd-4a9b-934b-52fc39647e0c", "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 " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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": "e603a299-e976-43f3-8afe-109861436816", "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 " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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": "82a7aeb7-5bd2-42d0-a9da-60d952e5d96a", "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 " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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": "73e31cf9-1f36-424a-9eba-1caeec467a0c", "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 " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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": "af7c2011-16eb-4bf7-8a37-e1fbfaf6d61f", "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": "bae045b4-03c9-4df3-8797-78b98dd9d8f5", "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 " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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": "5d91ea57-92fc-4fba-a7aa-b21e8a1b7328", "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 " }, { "disabled": false, "description": "(Required) Obrigatório em toda chamada Magen.", "key": "Content-Type", "value": "application/json" }, { "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.magen.processamento.com/v1", "type": "string", "description": "Base URL da API Magen" }, { "key": "token", "value": "", "type": "string", "description": "Bearer token Magen" } ], "info": { "_postman_id": "50dc123e-7af7-4ed3-ad59-e701d06ef5d4", "name": "Magen Pix API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "REST API for Pix operations on the Magen 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 magen-pix`\n- Python: `pip install magen-pix`\n- Go: `go get __STRIP_SDK_REF__/go`\n- PHP: `composer require magen/pix`\n\nRepo: https://__STRIP_SDK_REF__\n\n\nContact Support:\n Name: Suporte Magen", "type": "text/plain" } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] } }