{ "info": { "_postman_id": "a1f0c2d4-7b3e-4c91-8a52-monetarie0001", "name": "Monetarie Partner API v1", "description": "Coleção oficial da Partner API da Monetarie (catálogo /api/partner/v1).\n\nAutenticação OAuth2 client_credentials. O parceiro troca client_id e client_secret por um token Bearer de curta duração no endpoint POST /api/partner/v1/oauth/token e usa esse token no cabeçalho Authorization: Bearer em todas as demais chamadas.\n\nPreencha as variáveis de coleção baseUrl, client_id e client_secret. Rode primeiro a requisição OAuth > Obter token, que salva automaticamente o access_token na variável da coleção. Em seguida execute qualquer outra requisição.\n\nConvenções de valores:\n- Valores de entrada em PIX e transferências são em centavos (inteiro). Exemplo: 1500 representa R$ 15,00.\n- Valores de saldo, extrato e comprovante saem em reais (número com casas decimais).\n\nSwagger UI disponível em /api/swaggerui.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "variable": [ { "key": "baseUrl", "value": "http://coreapi-h.monetarie.internal", "type": "string" }, { "key": "client_id", "value": "", "type": "string" }, { "key": "client_secret", "value": "", "type": "string" }, { "key": "access_token", "value": "", "type": "string" }, { "key": "webhook_receiver_url", "value": "https://sua-aplicacao.com.br/webhooks/monetarie" }, { "key": "accountId", "value": "", "description": "Id da conta demandante, obrigatorio na consulta ao DICT." } ], "item": [ { "name": "OAuth", "description": "Emissão do token de acesso. Execute esta pasta primeiro.", "item": [ { "name": "Obter token", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test(\"status 200\", function () {", " pm.response.to.have.status(200);", "});", "", "var data = {};", "try { data = pm.response.json(); } catch (e) {}", "", "pm.test(\"retornou access_token\", function () {", " pm.expect(data).to.have.property(\"access_token\");", "});", "", "if (data.access_token) {", " pm.collectionVariables.set(\"access_token\", data.access_token);", " console.log(\"access_token salvo. Expira em \" + data.expires_in + \" segundos. Escopos: \" + data.scope);", "}" ] } } ], "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "grant_type", "value": "client_credentials", "type": "text" }, { "key": "client_id", "value": "{{client_id}}", "type": "text" }, { "key": "client_secret", "value": "{{client_secret}}", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/api/partner/v1/oauth/token", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "oauth", "token" ] }, "description": "Troca client_id e client_secret pelo token Bearer (grant client_credentials, RFC 6749 seção 4.4). O escopo concedido é a interseção dos escopos solicitados com as permissões da chave. O token tem validade de 8 horas (28800 segundos). O script de teste salva o access_token na variável da coleção." }, "response": [ { "name": "200 OK - token emitido", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "grant_type", "value": "client_credentials", "type": "text" }, { "key": "client_id", "value": "{{client_id}}", "type": "text" }, { "key": "client_secret", "value": "{{client_secret}}", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/api/partner/v1/oauth/token", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "oauth", "token" ] }, "description": "Troca client_id e client_secret pelo token Bearer (grant client_credentials, RFC 6749 seção 4.4). O escopo concedido é a interseção dos escopos solicitados com as permissões da chave. O token tem validade de 8 horas (28800 segundos). O script de teste salva o access_token na variável da coleção." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"access_token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJjbGllbnRfaWQiLCJpc3MiOiJtb25ldGFyaWUiLCJhdWQiOiJwYXJ0bmVyX2FwaSIsImlhdCI6MTc1MDkwMDAwMCwiZXhwIjoxNzUwOTI4ODAwLCJqdGkiOiI5ZDRmMmMxYS03YjNlLTRjOTEtOGE1Mi0wZjFlMmQzYzRiNWEiLCJwYXJ0bmVyX2lkIjoiMjUxYTIzNzUtNDQ5Mi00OTM2LTkyNGYtZjEwYmE0MTFmYmE0Iiwic2NvcGUiOiJhY2NvdW50OnJlYWQgcGl4OnJlYWQifQ.qg7s3yQmYpZk2v0aT9rWcXhN1bLpUe6FdJ8oI4nKzMc\",\n \"token_type\": \"Bearer\",\n \"expires_in\": 28800,\n \"scope\": \"customer:create customer:read account:read statement:read pix:read pix:write transfer:read transfer:write webhook:read webhook:write\"\n}" }, { "name": "401 Unauthorized - credenciais inválidas", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "grant_type", "value": "client_credentials", "type": "text" }, { "key": "client_id", "value": "{{client_id}}", "type": "text" }, { "key": "client_secret", "value": "{{client_secret}}", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/api/partner/v1/oauth/token", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "oauth", "token" ] }, "description": "Troca client_id e client_secret pelo token Bearer (grant client_credentials, RFC 6749 seção 4.4). O escopo concedido é a interseção dos escopos solicitados com as permissões da chave. O token tem validade de 8 horas (28800 segundos). O script de teste salva o access_token na variável da coleção." }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"invalid_client\",\n \"error_description\": \"Client authentication failed\"\n}" }, { "name": "400 Bad Request - grant_type não suportado", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "grant_type", "value": "client_credentials", "type": "text" }, { "key": "client_id", "value": "{{client_id}}", "type": "text" }, { "key": "client_secret", "value": "{{client_secret}}", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/api/partner/v1/oauth/token", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "oauth", "token" ] }, "description": "Troca client_id e client_secret pelo token Bearer (grant client_credentials, RFC 6749 seção 4.4). O escopo concedido é a interseção dos escopos solicitados com as permissões da chave. O token tem validade de 8 horas (28800 segundos). O script de teste salva o access_token na variável da coleção." }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"unsupported_grant_type\",\n \"error_description\": \"grant_type 'password' is not supported; use 'client_credentials'\"\n}" }, { "name": "400 Bad Request - parâmetro ausente", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "grant_type", "value": "client_credentials", "type": "text" }, { "key": "client_id", "value": "{{client_id}}", "type": "text" }, { "key": "client_secret", "value": "{{client_secret}}", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/api/partner/v1/oauth/token", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "oauth", "token" ] }, "description": "Troca client_id e client_secret pelo token Bearer (grant client_credentials, RFC 6749 seção 4.4). O escopo concedido é a interseção dos escopos solicitados com as permissões da chave. O token tem validade de 8 horas (28800 segundos). O script de teste salva o access_token na variável da coleção." }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"invalid_request\",\n \"error_description\": \"Missing required parameter: client_id\"\n}" } ] }, { "name": "Verificar credencial (ping)", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test(\"status 200\", function () {", " pm.response.to.have.status(200);", "});" ] } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/ping", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "ping" ] }, "description": "Primeira chamada de sanidade da integração: ecoa o partner_id da credencial usada no token. Aceita qualquer token de parceiro válido, sem escopo adicional. Use após obter o token para confirmar que a credencial está ativa e apontando para o parceiro esperado." }, "response": [ { "name": "200 OK - credencial válida", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/ping", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "ping" ] }, "description": "Primeira chamada de sanidade da integração: ecoa o partner_id da credencial usada no token. Aceita qualquer token de parceiro válido, sem escopo adicional. Use após obter o token para confirmar que a credencial está ativa e apontando para o parceiro esperado." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"ok\",\n \"partner_id\": 42\n}" } ] } ] }, { "name": "Clientes", "description": "Ciclo de vida de clientes. Cadastra o cliente e abre a conta, com verificação de KYC. A checagem de sanções e PEP é aplicada no cadastro.", "item": [ { "name": "Criar cliente", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test(\"status 2xx\", function () {", " pm.expect(pm.response.code).to.be.within(200, 299);", "});" ] } } ], "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "criar-cliente-001", "description": "Opcional. Reenvios com a mesma chave retornam a resposta original." } ], "body": { "mode": "raw", "raw": "{\n \"document\": \"12345678909\",\n \"name\": \"Maria Oliveira\",\n \"password\": \"SenhaForte#2026\",\n \"login\": \"12345678909\",\n \"email\": \"maria.oliveira@exemplo.com.br\",\n \"phone\": \"+5511999990000\",\n \"account_type\": \"payment\",\n \"kyc\": {\n \"outcome\": \"approved\",\n \"document\": \"12345678909\",\n \"name\": \"Maria Oliveira\"\n }\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/customers", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "customers" ] }, "description": "Cadastra o cliente, abre a conta e registra a verificação de KYC, tudo escopado ao parceiro do token. Campos obrigatórios: document, name e password. Em caso de match de sanção ou PEP, a conta nasce bloqueada ou em EDD. Escopo necessário: customer:create. Idempotente pelo cabeçalho Idempotency-Key." }, "response": [ { "name": "201 Created - cliente criado", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "criar-cliente-001", "description": "Opcional. Reenvios com a mesma chave retornam a resposta original." } ], "body": { "mode": "raw", "raw": "{\n \"document\": \"12345678909\",\n \"name\": \"Maria Oliveira\",\n \"password\": \"SenhaForte#2026\",\n \"login\": \"12345678909\",\n \"email\": \"maria.oliveira@exemplo.com.br\",\n \"phone\": \"+5511999990000\",\n \"account_type\": \"payment\",\n \"kyc\": {\n \"outcome\": \"approved\",\n \"document\": \"12345678909\",\n \"name\": \"Maria Oliveira\"\n }\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/customers", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "customers" ] }, "description": "Cadastra o cliente, abre a conta e registra a verificação de KYC, tudo escopado ao parceiro do token. Campos obrigatórios: document, name e password. Em caso de match de sanção ou PEP, a conta nasce bloqueada ou em EDD. Escopo necessário: customer:create. Idempotente pelo cabeçalho Idempotency-Key." }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": 123,\n \"name\": \"Maria Oliveira\",\n \"document\": \"12345678909\",\n \"status\": \"active\",\n \"partner_id\": \"251a2375-4492-4936-924f-f10ba411fba4\",\n \"kyc\": {\n \"outcome\": \"clear\",\n \"edd_required\": false,\n \"sanctions_hit\": false,\n \"pep_hit\": false,\n \"compliance_case_id\": null\n },\n \"accounts\": [\n {\n \"id\": 1001,\n \"kind\": 1,\n \"account_type\": \"payment\",\n \"agency\": \"0001\",\n \"account_number\": \"113964-9\",\n \"status\": \"active\"\n }\n ]\n }\n}" }, { "name": "201 Created - match de sanção (conta bloqueada/EDD)", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "criar-cliente-001", "description": "Opcional. Reenvios com a mesma chave retornam a resposta original." } ], "body": { "mode": "raw", "raw": "{\n \"document\": \"12345678909\",\n \"name\": \"Maria Oliveira\",\n \"password\": \"SenhaForte#2026\",\n \"login\": \"12345678909\",\n \"email\": \"maria.oliveira@exemplo.com.br\",\n \"phone\": \"+5511999990000\",\n \"account_type\": \"payment\",\n \"kyc\": {\n \"outcome\": \"approved\",\n \"document\": \"12345678909\",\n \"name\": \"Maria Oliveira\"\n }\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/customers", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "customers" ] }, "description": "Cadastra o cliente, abre a conta e registra a verificação de KYC, tudo escopado ao parceiro do token. Campos obrigatórios: document, name e password. Em caso de match de sanção ou PEP, a conta nasce bloqueada ou em EDD. Escopo necessário: customer:create. Idempotente pelo cabeçalho Idempotency-Key." }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": 124,\n \"name\": \"Joao Pereira\",\n \"document\": \"98765432100\",\n \"status\": \"blocked\",\n \"partner_id\": \"251a2375-4492-4936-924f-f10ba411fba4\",\n \"kyc\": {\n \"outcome\": \"edd\",\n \"edd_required\": true,\n \"sanctions_hit\": true,\n \"pep_hit\": false,\n \"compliance_case_id\": \"case_2026_000123\"\n },\n \"accounts\": [\n {\n \"id\": 1002,\n \"kind\": 1,\n \"account_type\": \"payment\",\n \"agency\": \"0001\",\n \"account_number\": \"113965-7\",\n \"status\": \"blocked\"\n }\n ]\n }\n}" }, { "name": "422 Unprocessable Entity - campo obrigatório ausente", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "criar-cliente-001", "description": "Opcional. Reenvios com a mesma chave retornam a resposta original." } ], "body": { "mode": "raw", "raw": "{\n \"document\": \"12345678909\",\n \"name\": \"Maria Oliveira\",\n \"password\": \"SenhaForte#2026\",\n \"login\": \"12345678909\",\n \"email\": \"maria.oliveira@exemplo.com.br\",\n \"phone\": \"+5511999990000\",\n \"account_type\": \"payment\",\n \"kyc\": {\n \"outcome\": \"approved\",\n \"document\": \"12345678909\",\n \"name\": \"Maria Oliveira\"\n }\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/customers", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "customers" ] }, "description": "Cadastra o cliente, abre a conta e registra a verificação de KYC, tudo escopado ao parceiro do token. Campos obrigatórios: document, name e password. Em caso de match de sanção ou PEP, a conta nasce bloqueada ou em EDD. Escopo necessário: customer:create. Idempotente pelo cabeçalho Idempotency-Key." }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 422,\n \"message\": \"missing required field: document\"\n }\n}" }, { "name": "403 Forbidden - chave não é de parceiro", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "criar-cliente-001", "description": "Opcional. Reenvios com a mesma chave retornam a resposta original." } ], "body": { "mode": "raw", "raw": "{\n \"document\": \"12345678909\",\n \"name\": \"Maria Oliveira\",\n \"password\": \"SenhaForte#2026\",\n \"login\": \"12345678909\",\n \"email\": \"maria.oliveira@exemplo.com.br\",\n \"phone\": \"+5511999990000\",\n \"account_type\": \"payment\",\n \"kyc\": {\n \"outcome\": \"approved\",\n \"document\": \"12345678909\",\n \"name\": \"Maria Oliveira\"\n }\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/customers", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "customers" ] }, "description": "Cadastra o cliente, abre a conta e registra a verificação de KYC, tudo escopado ao parceiro do token. Campos obrigatórios: document, name e password. Em caso de match de sanção ou PEP, a conta nasce bloqueada ou em EDD. Escopo necessário: customer:create. Idempotente pelo cabeçalho Idempotency-Key." }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 403,\n \"message\": \"this endpoint requires a partner-scoped API key\"\n }\n}" }, { "name": "401 Unauthorized - token ausente ou expirado", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "criar-cliente-001", "description": "Opcional. Reenvios com a mesma chave retornam a resposta original." } ], "body": { "mode": "raw", "raw": "{\n \"document\": \"12345678909\",\n \"name\": \"Maria Oliveira\",\n \"password\": \"SenhaForte#2026\",\n \"login\": \"12345678909\",\n \"email\": \"maria.oliveira@exemplo.com.br\",\n \"phone\": \"+5511999990000\",\n \"account_type\": \"payment\",\n \"kyc\": {\n \"outcome\": \"approved\",\n \"document\": \"12345678909\",\n \"name\": \"Maria Oliveira\"\n }\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/customers", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "customers" ] }, "description": "Cadastra o cliente, abre a conta e registra a verificação de KYC, tudo escopado ao parceiro do token. Campos obrigatórios: document, name e password. Em caso de match de sanção ou PEP, a conta nasce bloqueada ou em EDD. Escopo necessário: customer:create. Idempotente pelo cabeçalho Idempotency-Key." }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"message\": \"Invalid or expired partner access token\",\n \"status\": 401\n }\n}" } ] }, { "name": "Consultar cliente", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test(\"status 2xx\", function () {", " pm.expect(pm.response.code).to.be.within(200, 299);", "});" ] } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/customers/123", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "customers", "123" ], "variable": [ { "key": "id", "value": "123", "description": "Id do cliente (usuário)" } ] }, "description": "Retorna status, resumo de KYC e contas do cliente. O parceiro só lê clientes que ele mesmo criou. Acesso cruzado ou id desconhecido retorna 404. Escopo necessário: customer:read." }, "response": [ { "name": "200 OK - status do cliente", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/customers/123", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "customers", "123" ], "variable": [ { "key": "id", "value": "123", "description": "Id do cliente (usuário)" } ] }, "description": "Retorna status, resumo de KYC e contas do cliente. O parceiro só lê clientes que ele mesmo criou. Acesso cruzado ou id desconhecido retorna 404. Escopo necessário: customer:read." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": 123,\n \"name\": \"Maria Oliveira\",\n \"document\": \"12345678909\",\n \"status\": \"active\",\n \"partner_id\": \"251a2375-4492-4936-924f-f10ba411fba4\",\n \"kyc\": {\n \"status\": \"approved\",\n \"risk_level\": \"low\",\n \"is_pep\": false,\n \"last_reviewed_at\": \"2026-06-20T14:30:00Z\",\n \"edd_required\": false\n },\n \"accounts\": [\n {\n \"id\": 1001,\n \"kind\": 1,\n \"account_type\": \"payment\",\n \"agency\": \"0001\",\n \"account_number\": \"113964-9\",\n \"status\": \"active\"\n }\n ]\n }\n}" }, { "name": "404 Not Found - cliente não encontrado", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/customers/123", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "customers", "123" ], "variable": [ { "key": "id", "value": "123", "description": "Id do cliente (usuário)" } ] }, "description": "Retorna status, resumo de KYC e contas do cliente. O parceiro só lê clientes que ele mesmo criou. Acesso cruzado ou id desconhecido retorna 404. Escopo necessário: customer:read." }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 404,\n \"message\": \"customer not found\"\n }\n}" }, { "name": "401 Unauthorized - token ausente ou expirado", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/customers/123", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "customers", "123" ], "variable": [ { "key": "id", "value": "123", "description": "Id do cliente (usuário)" } ] }, "description": "Retorna status, resumo de KYC e contas do cliente. O parceiro só lê clientes que ele mesmo criou. Acesso cruzado ou id desconhecido retorna 404. Escopo necessário: customer:read." }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"message\": \"Invalid or expired partner access token\",\n \"status\": 401\n }\n}" }, { "name": "403 Forbidden - token sem escopo customer:read", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/customers/123", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "customers", "123" ], "variable": [ { "key": "id", "value": "123", "description": "Id do cliente (usuário)" } ] }, "description": "Retorna status, resumo de KYC e contas do cliente. O parceiro só lê clientes que ele mesmo criou. Acesso cruzado ou id desconhecido retorna 404. Escopo necessário: customer:read." }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 403,\n \"message\": \"this endpoint requires a partner-scoped API key\"\n }\n}" } ] }, { "name": "Abrir conta adicional", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/customers/25165/accounts", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "customers", "25165", "accounts" ] }, "body": { "mode": "raw", "raw": "{\n \"account_type\": \"savings\"\n}" }, "description": "Abre uma conta adicional para um cliente existente. Escopo account:write. account_type entre payment, checking, savings, salary, client, client_external, escrow." } } ] }, { "name": "Contas e saldo", "description": "Leitura de contas, saldo, extrato e comprovante. Todos os recursos são escopados ao parceiro do token.", "item": [ { "name": "Listar contas", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test(\"status 2xx\", function () {", " pm.expect(pm.response.code).to.be.within(200, 299);", "});" ] } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/accounts?page=1&page_size=50", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "accounts" ], "query": [ { "key": "page", "value": "1", "description": "Pagina (>= 1, padrao 1)" }, { "key": "page_size", "value": "50", "description": "Itens por pagina (1 a 100, padrao 50)" } ] }, "description": "Lista as contas dos clientes criados pelo parceiro, da mais recente para a mais antiga, paginada. Escopo necessário: account:read." }, "response": [ { "name": "200 OK - lista de contas", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/accounts?page=1&page_size=50", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "accounts" ], "query": [ { "key": "page", "value": "1", "description": "Pagina (>= 1, padrao 1)" }, { "key": "page_size", "value": "50", "description": "Itens por pagina (1 a 100, padrao 50)" } ] }, "description": "Lista as contas dos clientes criados pelo parceiro, da mais recente para a mais antiga, paginada. Escopo necessário: account:read." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": 1001,\n \"user_id\": 501,\n \"kind\": 1,\n \"account_type\": \"payment\",\n \"agency\": \"0001\",\n \"account_number\": \"113964-9\",\n \"status\": \"active\"\n },\n {\n \"id\": 1002,\n \"user_id\": 502,\n \"kind\": 1,\n \"account_type\": \"payment\",\n \"agency\": \"0001\",\n \"account_number\": \"113965-7\",\n \"status\": \"active\"\n }\n ],\n \"meta\": {\n \"page\": 1,\n \"page_size\": 50,\n \"total\": 2\n }\n}" }, { "name": "200 OK - sem contas", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/accounts?page=1&page_size=50", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "accounts" ], "query": [ { "key": "page", "value": "1", "description": "Pagina (>= 1, padrao 1)" }, { "key": "page_size", "value": "50", "description": "Itens por pagina (1 a 100, padrao 50)" } ] }, "description": "Lista as contas dos clientes criados pelo parceiro, da mais recente para a mais antiga, paginada. Escopo necessário: account:read." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [],\n \"meta\": {\n \"total\": 0,\n \"page\": 1,\n \"page_size\": 50\n }\n}" }, { "name": "401 Unauthorized - token ausente ou expirado", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/accounts?page=1&page_size=50", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "accounts" ], "query": [ { "key": "page", "value": "1", "description": "Pagina (>= 1, padrao 1)" }, { "key": "page_size", "value": "50", "description": "Itens por pagina (1 a 100, padrao 50)" } ] }, "description": "Lista as contas dos clientes criados pelo parceiro, da mais recente para a mais antiga, paginada. Escopo necessário: account:read." }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"message\": \"Invalid or expired partner access token\",\n \"status\": 401\n }\n}" }, { "name": "403 Forbidden - chave não é de parceiro", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/accounts?page=1&page_size=50", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "accounts" ], "query": [ { "key": "page", "value": "1", "description": "Pagina (>= 1, padrao 1)" }, { "key": "page_size", "value": "50", "description": "Itens por pagina (1 a 100, padrao 50)" } ] }, "description": "Lista as contas dos clientes criados pelo parceiro, da mais recente para a mais antiga, paginada. Escopo necessário: account:read." }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 403,\n \"message\": \"this endpoint requires a partner-scoped API key\"\n }\n}" } ] }, { "name": "Detalhar conta", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test(\"status 2xx\", function () {", " pm.expect(pm.response.code).to.be.within(200, 299);", "});" ] } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/accounts/1001", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "accounts", "1001" ], "variable": [ { "key": "id", "value": "1001", "description": "Id da conta" } ] }, "description": "Detalhe e status de uma conta do parceiro. Escopo necessário: account:read." }, "response": [ { "name": "200 OK - detalhe da conta", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/accounts/1001", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "accounts", "1001" ], "variable": [ { "key": "id", "value": "1001", "description": "Id da conta" } ] }, "description": "Detalhe e status de uma conta do parceiro. Escopo necessário: account:read." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": 1001,\n \"user_id\": 501,\n \"kind\": 1,\n \"account_type\": \"payment\",\n \"agency\": \"0001\",\n \"account_number\": \"113964-9\",\n \"status\": \"active\",\n \"currency\": \"BRL\",\n \"created_at\": \"2026-05-10T09:00:00Z\",\n \"updated_at\": \"2026-06-20T14:30:00Z\"\n }\n}" }, { "name": "403 Forbidden - conta de outro parceiro", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/accounts/1001", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "accounts", "1001" ], "variable": [ { "key": "id", "value": "1001", "description": "Id da conta" } ] }, "description": "Detalhe e status de uma conta do parceiro. Escopo necessário: account:read." }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 403,\n \"message\": \"account does not belong to this partner\"\n }\n}" }, { "name": "404 Not Found - conta não encontrada", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/accounts/1001", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "accounts", "1001" ], "variable": [ { "key": "id", "value": "1001", "description": "Id da conta" } ] }, "description": "Detalhe e status de uma conta do parceiro. Escopo necessário: account:read." }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 404,\n \"message\": \"account not found\"\n }\n}" }, { "name": "401 Unauthorized - token ausente ou expirado", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/accounts/1001", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "accounts", "1001" ], "variable": [ { "key": "id", "value": "1001", "description": "Id da conta" } ] }, "description": "Detalhe e status de uma conta do parceiro. Escopo necessário: account:read." }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"message\": \"Invalid or expired partner access token\",\n \"status\": 401\n }\n}" } ] }, { "name": "Consultar saldo", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test(\"status 2xx\", function () {", " pm.expect(pm.response.code).to.be.within(200, 299);", "});" ] } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/accounts/1001/balance", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "accounts", "1001", "balance" ], "variable": [ { "key": "id", "value": "1001", "description": "Id da conta" } ] }, "description": "Saldo atual da conta. O valor sai em reais. Escopo necessário: account:read." }, "response": [ { "name": "200 OK - saldo (centavos)", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/accounts/1001/balance", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "accounts", "1001", "balance" ], "variable": [ { "key": "id", "value": "1001", "description": "Id da conta" } ] }, "description": "Saldo atual da conta. O valor sai em reais. Escopo necessário: account:read." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"account_id\": 1001,\n \"balance\": 62586190,\n \"available\": 62586190,\n \"blocked\": 0,\n \"currency\": \"BRL\",\n \"updated_at\": \"2026-06-27T12:00:00Z\"\n }\n}" }, { "name": "403 Forbidden - conta de outro parceiro", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/accounts/1001/balance", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "accounts", "1001", "balance" ], "variable": [ { "key": "id", "value": "1001", "description": "Id da conta" } ] }, "description": "Saldo atual da conta. O valor sai em reais. Escopo necessário: account:read." }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 403,\n \"message\": \"account does not belong to this partner\"\n }\n}" }, { "name": "404 Not Found - conta não encontrada", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/accounts/1001/balance", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "accounts", "1001", "balance" ], "variable": [ { "key": "id", "value": "1001", "description": "Id da conta" } ] }, "description": "Saldo atual da conta. O valor sai em reais. Escopo necessário: account:read." }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 404,\n \"message\": \"account not found\"\n }\n}" }, { "name": "401 Unauthorized - token ausente ou expirado", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/accounts/1001/balance", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "accounts", "1001", "balance" ], "variable": [ { "key": "id", "value": "1001", "description": "Id da conta" } ] }, "description": "Saldo atual da conta. O valor sai em reais. Escopo necessário: account:read." }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"message\": \"Invalid or expired partner access token\",\n \"status\": 401\n }\n}" } ] }, { "name": "Consultar extrato", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test(\"status 2xx\", function () {", " pm.expect(pm.response.code).to.be.within(200, 299);", "});" ] } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/accounts/1001/statement?page=1&page_size=50&date_from=2026-06-01&date_to=2026-06-30", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "accounts", "1001", "statement" ], "query": [ { "key": "page", "value": "1", "description": "Pagina (>= 1, padrao 1)" }, { "key": "page_size", "value": "50", "description": "Itens por pagina (1 a 100, padrao 50)" }, { "key": "date_from", "value": "2026-06-01", "description": "Data inicial opcional (ISO 8601)" }, { "key": "date_to", "value": "2026-06-30", "description": "Data final opcional (ISO 8601)" } ], "variable": [ { "key": "id", "value": "1001", "description": "Id da conta" } ] }, "description": "Extrato da conta sobre um intervalo opcional de datas, paginado. Valores em reais. Escopo necessário: statement:read." }, "response": [ { "name": "200 OK - extrato paginado (centavos)", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/accounts/1001/statement?page=1&page_size=50&date_from=2026-06-01&date_to=2026-06-30", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "accounts", "1001", "statement" ], "query": [ { "key": "page", "value": "1", "description": "Pagina (>= 1, padrao 1)" }, { "key": "page_size", "value": "50", "description": "Itens por pagina (1 a 100, padrao 50)" }, { "key": "date_from", "value": "2026-06-01", "description": "Data inicial opcional (ISO 8601)" }, { "key": "date_to", "value": "2026-06-30", "description": "Data final opcional (ISO 8601)" } ], "variable": [ { "key": "id", "value": "1001", "description": "Id da conta" } ] }, "description": "Extrato da conta sobre um intervalo opcional de datas, paginado. Valores em reais. Escopo necessário: statement:read." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"PIXOUT20260624a1b2c3d4e5f6a7b8c9d0\",\n \"direction\": \"debit\",\n \"type\": \"pix\",\n \"amount\": 1500,\n \"description\": \"PIX enviado\",\n \"status\": \"completed\",\n \"end_to_end_id\": \"E46026562202606241015000000001\",\n \"created_at\": \"2026-06-24T10:15:00Z\",\n \"completed_at\": \"2026-06-24T10:15:05Z\"\n },\n {\n \"id\": 7788,\n \"direction\": \"credit\",\n \"type\": \"transfer\",\n \"amount\": 500000,\n \"description\": \"Crédito recebido\",\n \"status\": \"confirmed\",\n \"end_to_end_id\": null,\n \"created_at\": \"2026-06-01\",\n \"completed_at\": \"2026-06-01\",\n \"source\": \"legacy\"\n }\n ],\n \"meta\": {\n \"account_id\": 1001,\n \"page\": 1,\n \"page_size\": 50,\n \"total\": 2,\n \"date_from\": \"2026-06-01\",\n \"date_to\": \"2026-06-30\"\n }\n}" }, { "name": "403 Forbidden - conta de outro parceiro", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/accounts/1001/statement?page=1&page_size=50&date_from=2026-06-01&date_to=2026-06-30", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "accounts", "1001", "statement" ], "query": [ { "key": "page", "value": "1", "description": "Pagina (>= 1, padrao 1)" }, { "key": "page_size", "value": "50", "description": "Itens por pagina (1 a 100, padrao 50)" }, { "key": "date_from", "value": "2026-06-01", "description": "Data inicial opcional (ISO 8601)" }, { "key": "date_to", "value": "2026-06-30", "description": "Data final opcional (ISO 8601)" } ], "variable": [ { "key": "id", "value": "1001", "description": "Id da conta" } ] }, "description": "Extrato da conta sobre um intervalo opcional de datas, paginado. Valores em reais. Escopo necessário: statement:read." }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 403,\n \"message\": \"account does not belong to this partner\"\n }\n}" }, { "name": "404 Not Found - conta não encontrada", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/accounts/1001/statement?page=1&page_size=50&date_from=2026-06-01&date_to=2026-06-30", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "accounts", "1001", "statement" ], "query": [ { "key": "page", "value": "1", "description": "Pagina (>= 1, padrao 1)" }, { "key": "page_size", "value": "50", "description": "Itens por pagina (1 a 100, padrao 50)" }, { "key": "date_from", "value": "2026-06-01", "description": "Data inicial opcional (ISO 8601)" }, { "key": "date_to", "value": "2026-06-30", "description": "Data final opcional (ISO 8601)" } ], "variable": [ { "key": "id", "value": "1001", "description": "Id da conta" } ] }, "description": "Extrato da conta sobre um intervalo opcional de datas, paginado. Valores em reais. Escopo necessário: statement:read." }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 404,\n \"message\": \"account not found\"\n }\n}" }, { "name": "401 Unauthorized - token ausente ou expirado", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/accounts/1001/statement?page=1&page_size=50&date_from=2026-06-01&date_to=2026-06-30", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "accounts", "1001", "statement" ], "query": [ { "key": "page", "value": "1", "description": "Pagina (>= 1, padrao 1)" }, { "key": "page_size", "value": "50", "description": "Itens por pagina (1 a 100, padrao 50)" }, { "key": "date_from", "value": "2026-06-01", "description": "Data inicial opcional (ISO 8601)" }, { "key": "date_to", "value": "2026-06-30", "description": "Data final opcional (ISO 8601)" } ], "variable": [ { "key": "id", "value": "1001", "description": "Id da conta" } ] }, "description": "Extrato da conta sobre um intervalo opcional de datas, paginado. Valores em reais. Escopo necessário: statement:read." }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"message\": \"Invalid or expired partner access token\",\n \"status\": 401\n }\n}" } ] }, { "name": "Obter comprovante", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test(\"status 2xx\", function () {", " pm.expect(pm.response.code).to.be.within(200, 299);", "});" ] } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/accounts/1001/statement/PIXOUT20260624abc123/receipt", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "accounts", "1001", "statement", "PIXOUT20260624abc123", "receipt" ], "variable": [ { "key": "id", "value": "1001", "description": "Id da conta" }, { "key": "entry_id", "value": "PIXOUT20260624abc123", "description": "Id da entrada do extrato" } ] }, "description": "Comprovante de uma entrada do extrato, escopado à conta do parceiro. Escopo necessário: statement:read." }, "response": [ { "name": "200 OK - comprovante (centavos)", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/accounts/1001/statement/PIXOUT20260624abc123/receipt", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "accounts", "1001", "statement", "PIXOUT20260624abc123", "receipt" ], "variable": [ { "key": "id", "value": "1001", "description": "Id da conta" }, { "key": "entry_id", "value": "PIXOUT20260624abc123", "description": "Id da entrada do extrato" } ] }, "description": "Comprovante de uma entrada do extrato, escopado à conta do parceiro. Escopo necessário: statement:read." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"PIXOUT20260624a1b2c3d4e5f6a7b8c9d0\",\n \"type\": \"pix\",\n \"status\": \"completed\",\n \"direction\": \"debit\",\n \"amount\": 1500,\n \"description\": \"PIX enviado\",\n \"auth_code\": \"A1B2C3D4E5F6A7B8\",\n \"end_to_end_id\": \"E46026562202606241015000000001\",\n \"created_at\": \"2026-06-24T10:15:00Z\",\n \"completed_at\": \"2026-06-24T10:15:05Z\",\n \"account\": {\n \"id\": 1001,\n \"institution\": \"MONETARIE SOCIEDADE DE CREDITO DIRETO S.A.\",\n \"ispb\": \"46026562\",\n \"agency\": \"0001\",\n \"account_number\": \"113964-9\"\n }\n }\n}" }, { "name": "404 Not Found - entrada do extrato não encontrada", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/accounts/1001/statement/PIXOUT20260624abc123/receipt", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "accounts", "1001", "statement", "PIXOUT20260624abc123", "receipt" ], "variable": [ { "key": "id", "value": "1001", "description": "Id da conta" }, { "key": "entry_id", "value": "PIXOUT20260624abc123", "description": "Id da entrada do extrato" } ] }, "description": "Comprovante de uma entrada do extrato, escopado à conta do parceiro. Escopo necessário: statement:read." }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 404,\n \"message\": \"statement entry not found\"\n }\n}" }, { "name": "403 Forbidden - conta de outro parceiro", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/accounts/1001/statement/PIXOUT20260624abc123/receipt", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "accounts", "1001", "statement", "PIXOUT20260624abc123", "receipt" ], "variable": [ { "key": "id", "value": "1001", "description": "Id da conta" }, { "key": "entry_id", "value": "PIXOUT20260624abc123", "description": "Id da entrada do extrato" } ] }, "description": "Comprovante de uma entrada do extrato, escopado à conta do parceiro. Escopo necessário: statement:read." }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 403,\n \"message\": \"account does not belong to this partner\"\n }\n}" }, { "name": "401 Unauthorized - token ausente ou expirado", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/accounts/1001/statement/PIXOUT20260624abc123/receipt", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "accounts", "1001", "statement", "PIXOUT20260624abc123", "receipt" ], "variable": [ { "key": "id", "value": "1001", "description": "Id da conta" }, { "key": "entry_id", "value": "PIXOUT20260624abc123", "description": "Id da entrada do extrato" } ] }, "description": "Comprovante de uma entrada do extrato, escopado à conta do parceiro. Escopo necessário: statement:read." }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"message\": \"Invalid or expired partner access token\",\n \"status\": 401\n }\n}" } ] }, { "name": "Trilha de eventos da conta", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/accounts/1001/events?limit=50", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "accounts", "1001", "events" ], "query": [ { "key": "limit", "value": "50", "description": "Máximo de eventos (padrão 50, teto 100)" } ] }, "description": "Trilha de auditoria da conta (registros administrativos: criação, bloqueio, alteração de limites). Filtros opcionais from e to (ISO8601) e limit (padrão 50, máximo 100). Resposta 200 com data.events (id, action, resourceType, actorType, changes, metadata, occurredAt) e data.source audit_trail. Não é o catálogo de notificações: os eventos de webhook ficam em GET /webhooks/events. Escopo account:read." } }, { "name": "Consultar limites", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/accounts/1001/limits", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "accounts", "1001", "limits" ] }, "description": "Limites efetivos de PIX de saida e TED (transacional, diario, mensal e noturno Res. 142) e overrides da conta. Valores em centavos. Escopo account:read." } }, { "name": "Alterar limites", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/accounts/1001/limits", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "accounts", "1001", "limits" ] }, "body": { "mode": "raw", "raw": "{\n \"pix_out_transaction_limit\": 500000,\n \"nighttime_limit\": 100000\n}" }, "description": "Altera os overrides de limite da conta, em centavos. Enviar null remove o override. Escopo account:write." } }, { "name": "Bloquear conta", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/accounts/1001/block", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "accounts", "1001", "block" ] }, "description": "Bloqueia a conta para saida de dinheiro. Escopo account:write." } }, { "name": "Desbloquear conta", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/accounts/1001/unblock", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "accounts", "1001", "unblock" ] }, "description": "Desbloqueia a conta. Escopo account:write." } }, { "name": "Encerrar conta", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/accounts/1001/close", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "accounts", "1001", "close" ] }, "description": "Encerra a conta. Exige saldo zero; com saldo responde 422. Escopo account:write." } } ] }, { "name": "PIX", "description": "Chaves DICT, consulta DICT, envio, devolução, status e cobrança PIX. Toda operação é escopada a uma conta do parceiro. Valores de entrada em centavos.", "item": [ { "name": "Registrar chave DICT", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test(\"status 2xx\", function () {", " pm.expect(pm.response.code).to.be.within(200, 299);", "});" ] } } ], "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": 1001,\n \"type\": \"evp\",\n \"key\": \"\"\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/keys", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "keys" ], "description": "Tipos aceitos: cpf, cnpj, phone, email, evp. Para cpf e cnpj a chave deriva do documento do titular. Para evp a chave e gerada pelo servidor. Para phone e email use o campo key." }, "description": "Registra uma chave PIX/DICT para uma conta do parceiro. Obrigatório: account_id. Escopo necessário: pix:write." }, "response": [ { "name": "202 Accepted - registro aceito", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": 1001,\n \"type\": \"evp\",\n \"key\": \"\"\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/keys", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "keys" ], "description": "Tipos aceitos: cpf, cnpj, phone, email, evp. Para cpf e cnpj a chave deriva do documento do titular. Para evp a chave e gerada pelo servidor. Para phone e email use o campo key." }, "description": "Registra uma chave PIX/DICT para uma conta do parceiro. Obrigatório: account_id. Escopo necessário: pix:write." }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"evp\",\n \"key\": \"a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d\",\n \"status\": \"pending\"\n }\n}" }, { "name": "422 Unprocessable Entity - account_id ausente", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": 1001,\n \"type\": \"evp\",\n \"key\": \"\"\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/keys", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "keys" ], "description": "Tipos aceitos: cpf, cnpj, phone, email, evp. Para cpf e cnpj a chave deriva do documento do titular. Para evp a chave e gerada pelo servidor. Para phone e email use o campo key." }, "description": "Registra uma chave PIX/DICT para uma conta do parceiro. Obrigatório: account_id. Escopo necessário: pix:write." }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 422,\n \"message\": \"account_id is required\"\n }\n}" }, { "name": "404 Not Found - conta não encontrada", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": 1001,\n \"type\": \"evp\",\n \"key\": \"\"\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/keys", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "keys" ], "description": "Tipos aceitos: cpf, cnpj, phone, email, evp. Para cpf e cnpj a chave deriva do documento do titular. Para evp a chave e gerada pelo servidor. Para phone e email use o campo key." }, "description": "Registra uma chave PIX/DICT para uma conta do parceiro. Obrigatório: account_id. Escopo necessário: pix:write." }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 404,\n \"message\": \"account not found\"\n }\n}" }, { "name": "403 Forbidden - conta de outro parceiro", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": 1001,\n \"type\": \"evp\",\n \"key\": \"\"\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/keys", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "keys" ], "description": "Tipos aceitos: cpf, cnpj, phone, email, evp. Para cpf e cnpj a chave deriva do documento do titular. Para evp a chave e gerada pelo servidor. Para phone e email use o campo key." }, "description": "Registra uma chave PIX/DICT para uma conta do parceiro. Obrigatório: account_id. Escopo necessário: pix:write." }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 403,\n \"message\": \"account does not belong to this partner\"\n }\n}" }, { "name": "502 Bad Gateway - cabine PIX indisponível", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": 1001,\n \"type\": \"evp\",\n \"key\": \"\"\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/keys", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "keys" ], "description": "Tipos aceitos: cpf, cnpj, phone, email, evp. Para cpf e cnpj a chave deriva do documento do titular. Para evp a chave e gerada pelo servidor. Para phone e email use o campo key." }, "description": "Registra uma chave PIX/DICT para uma conta do parceiro. Obrigatório: account_id. Escopo necessário: pix:write." }, "status": "Bad Gateway", "code": 502, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 502,\n \"message\": \"Serviço PIX indisponível ao registrar chave PIX\"\n }\n}" } ] }, { "name": "Listar chaves DICT", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test(\"status 2xx\", function () {", " pm.expect(pm.response.code).to.be.within(200, 299);", "});" ] } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/keys?account_id=1001", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "keys" ], "query": [ { "key": "account_id", "value": "1001", "description": "Id da conta do parceiro (obrigatório)" } ] }, "description": "Lista as chaves PIX/DICT registradas para uma conta do parceiro. Escopo necessário: pix:read." }, "response": [ { "name": "200 OK - chaves da conta", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/keys?account_id=1001", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "keys" ], "query": [ { "key": "account_id", "value": "1001", "description": "Id da conta do parceiro (obrigatório)" } ] }, "description": "Lista as chaves PIX/DICT registradas para uma conta do parceiro. Escopo necessário: pix:read." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"maria.oliveira@exemplo.com.br\",\n \"type\": \"EMAIL\",\n \"key\": \"maria.oliveira@exemplo.com.br\",\n \"status\": \"active\",\n \"owner_name\": \"Maria Oliveira\",\n \"created_at\": \"2026-05-12T08:00:00Z\"\n },\n {\n \"id\": \"a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d\",\n \"type\": \"EVP\",\n \"key\": \"a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d\",\n \"status\": \"active\",\n \"owner_name\": \"Maria Oliveira\",\n \"created_at\": \"2026-06-01T09:30:00Z\"\n }\n ]\n}" }, { "name": "422 Unprocessable Entity - account_id ausente", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/keys?account_id=1001", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "keys" ], "query": [ { "key": "account_id", "value": "1001", "description": "Id da conta do parceiro (obrigatório)" } ] }, "description": "Lista as chaves PIX/DICT registradas para uma conta do parceiro. Escopo necessário: pix:read." }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 422,\n \"message\": \"account_id is required\"\n }\n}" }, { "name": "403 Forbidden - conta de outro parceiro", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/keys?account_id=1001", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "keys" ], "query": [ { "key": "account_id", "value": "1001", "description": "Id da conta do parceiro (obrigatório)" } ] }, "description": "Lista as chaves PIX/DICT registradas para uma conta do parceiro. Escopo necessário: pix:read." }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 403,\n \"message\": \"account does not belong to this partner\"\n }\n}" }, { "name": "502 Bad Gateway - cabine PIX indisponível", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/keys?account_id=1001", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "keys" ], "query": [ { "key": "account_id", "value": "1001", "description": "Id da conta do parceiro (obrigatório)" } ] }, "description": "Lista as chaves PIX/DICT registradas para uma conta do parceiro. Escopo necessário: pix:read." }, "status": "Bad Gateway", "code": 502, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 502,\n \"message\": \"Serviço PIX indisponível ao listar chaves PIX\"\n }\n}" } ] }, { "name": "Excluir chave DICT", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test(\"status 2xx\", function () {", " pm.expect(pm.response.code).to.be.within(200, 299);", "});" ] } } ], "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/keys/maria.oliveira@exemplo.com.br?account_id=1001", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "keys", "maria.oliveira@exemplo.com.br" ], "query": [ { "key": "account_id", "value": "1001", "description": "Id da conta do parceiro (obrigatório)" } ], "variable": [ { "key": "key", "value": "maria.oliveira@exemplo.com.br", "description": "Chave DICT a remover" } ] }, "description": "Remove uma chave PIX/DICT de uma conta do parceiro. A exclusão é processada de forma assíncrona. Escopo necessário: pix:write." }, "response": [ { "name": "202 Accepted - exclusão aceita", "originalRequest": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/keys/maria.oliveira@exemplo.com.br?account_id=1001", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "keys", "maria.oliveira@exemplo.com.br" ], "query": [ { "key": "account_id", "value": "1001", "description": "Id da conta do parceiro (obrigatório)" } ], "variable": [ { "key": "key", "value": "maria.oliveira@exemplo.com.br", "description": "Chave DICT a remover" } ] }, "description": "Remove uma chave PIX/DICT de uma conta do parceiro. A exclusão é processada de forma assíncrona. Escopo necessário: pix:write." }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Exclusão de chave PIX enviada para processamento\"\n}" }, { "name": "404 Not Found - conta não encontrada", "originalRequest": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/keys/maria.oliveira@exemplo.com.br?account_id=1001", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "keys", "maria.oliveira@exemplo.com.br" ], "query": [ { "key": "account_id", "value": "1001", "description": "Id da conta do parceiro (obrigatório)" } ], "variable": [ { "key": "key", "value": "maria.oliveira@exemplo.com.br", "description": "Chave DICT a remover" } ] }, "description": "Remove uma chave PIX/DICT de uma conta do parceiro. A exclusão é processada de forma assíncrona. Escopo necessário: pix:write." }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 404,\n \"message\": \"account not found\"\n }\n}" }, { "name": "403 Forbidden - conta de outro parceiro", "originalRequest": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/keys/maria.oliveira@exemplo.com.br?account_id=1001", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "keys", "maria.oliveira@exemplo.com.br" ], "query": [ { "key": "account_id", "value": "1001", "description": "Id da conta do parceiro (obrigatório)" } ], "variable": [ { "key": "key", "value": "maria.oliveira@exemplo.com.br", "description": "Chave DICT a remover" } ] }, "description": "Remove uma chave PIX/DICT de uma conta do parceiro. A exclusão é processada de forma assíncrona. Escopo necessário: pix:write." }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 403,\n \"message\": \"account does not belong to this partner\"\n }\n}" }, { "name": "502 Bad Gateway - cabine PIX indisponível", "originalRequest": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/keys/maria.oliveira@exemplo.com.br?account_id=1001", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "keys", "maria.oliveira@exemplo.com.br" ], "query": [ { "key": "account_id", "value": "1001", "description": "Id da conta do parceiro (obrigatório)" } ], "variable": [ { "key": "key", "value": "maria.oliveira@exemplo.com.br", "description": "Chave DICT a remover" } ] }, "description": "Remove uma chave PIX/DICT de uma conta do parceiro. A exclusão é processada de forma assíncrona. Escopo necessário: pix:write." }, "status": "Bad Gateway", "code": 502, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 502,\n \"message\": \"Serviço PIX indisponível ao excluir chave PIX\"\n }\n}" } ] }, { "name": "Consultar chave externa (DICT)", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test(\"status 2xx\", function () {", " pm.expect(pm.response.code).to.be.within(200, 299);", "});" ] } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/dict/joao.silva@exemplo.com.br?accountId={{accountId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "dict", "joao.silva@exemplo.com.br" ], "variable": [ { "key": "key", "value": "joao.silva@exemplo.com.br", "description": "Chave PIX/DICT a consultar" } ], "query": [ { "key": "accountId", "value": "{{accountId}}", "description": "OBRIGATORIO. Conta demandante; o documento do titular dela vai como PI-PayerId." }, { "key": "payerDocument", "value": "", "disabled": true, "description": "Opcional, so conferencia: precisa bater com o titular de accountId." } ] }, "description": "Resolve uma chave externa no DICT para pagar.\n\naccountId e OBRIGATORIO. O BACEN exige, em toda consulta lookup-to-pay, o documento de quem vai pagar (cabecalho PI-PayerId da API DICT), e esse documento e sempre o titular da conta informada em accountId. Sem ele a requisicao devolve 422 payer_account_required e o diretorio nem e consultado.\n\npayerDocument e opcional e serve APENAS como conferencia: se enviado, tem que bater com o titular de accountId, senao 422 payer_document_mismatch. Ele nao e fonte do pagador.\n\nChave inexistente devolve 404 key_not_found com corpo de erro estruturado." }, "response": [ { "name": "200 OK - entrada do diretório", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/dict/joao.silva@exemplo.com.br", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "dict", "joao.silva@exemplo.com.br" ], "variable": [ { "key": "key", "value": "joao.silva@exemplo.com.br", "description": "Chave PIX/DICT a consultar" } ] }, "description": "Resolve uma chave PIX/DICT externa no diretório para pagar. Consulta somente leitura. Escopo necessário: pix:read." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key\": \"joao.silva@exemplo.com.br\",\n \"key_type\": \"EMAIL\",\n \"account\": {\n \"participant\": \"00000000\",\n \"branch\": \"0001\",\n \"account_number\": \"123456-7\",\n \"account_type\": \"CACC\",\n \"opening_date\": \"2024-01-10T00:00:00Z\"\n },\n \"owner\": {\n \"type\": \"NATURAL_PERSON\",\n \"name\": \"João Silva\",\n \"tax_id_number\": \"***765432**\"\n }\n }\n}" }, { "name": "403 Forbidden - chave não é de parceiro", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/dict/joao.silva@exemplo.com.br", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "dict", "joao.silva@exemplo.com.br" ], "variable": [ { "key": "key", "value": "joao.silva@exemplo.com.br", "description": "Chave PIX/DICT a consultar" } ] }, "description": "Resolve uma chave PIX/DICT externa no diretório para pagar. Consulta somente leitura. Escopo necessário: pix:read." }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 403,\n \"message\": \"this endpoint requires a partner-scoped API key\"\n }\n}" }, { "name": "502 Bad Gateway - cabine PIX indisponível", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/dict/joao.silva@exemplo.com.br", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "dict", "joao.silva@exemplo.com.br" ], "variable": [ { "key": "key", "value": "joao.silva@exemplo.com.br", "description": "Chave PIX/DICT a consultar" } ] }, "description": "Resolve uma chave PIX/DICT externa no diretório para pagar. Consulta somente leitura. Escopo necessário: pix:read." }, "status": "Bad Gateway", "code": 502, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 502,\n \"message\": \"Serviço PIX indisponível ao consultar chave DICT\"\n }\n}" } ] }, { "name": "Criar QR estático (valor em aberto)", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test(\"status 201\", function () {", " pm.response.to.have.status(201);", "});" ] } } ], "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": 1001,\n \"description\": \"Doacao\"\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/qrcodes/static", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "qrcodes", "static" ] }, "description": "Gera um QR estático com valor em aberto: sem amount, a tag de valor (EMV 54) não é emitida e o pagador digita o valor no app dele. O QR estático é reutilizável e não expira. Obrigatório: account_id. Opcionais: pix_key (padrão: documento do titular da conta), description e city. Escopo necessário: pix:write." }, "response": [ { "name": "201 Created - QR com valor em aberto", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": 1001,\n \"description\": \"Doacao\"\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/qrcodes/static", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "qrcodes", "static" ] }, "description": "Gera um QR estático com valor em aberto: sem amount, a tag de valor (EMV 54) não é emitida e o pagador digita o valor no app dele. O QR estático é reutilizável e não expira. Obrigatório: account_id. Opcionais: pix_key (padrão: documento do titular da conta), description e city. Escopo necessário: pix:write." }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"account_id\": 1001,\n \"type\": \"static\",\n \"brcode\": \"00020101021126580014br.gov.bcb.pix...6304AB12\",\n \"qrcode_base64\": \"data:image/png;base64,...\",\n \"amount\": null,\n \"description\": \"Doacao\",\n \"txId\": \"A1B2C3D4E5\",\n \"pixKey\": \"12345678901\"\n }\n}" } ] }, { "name": "Criar QR estático (valor fixo)", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test(\"status 201\", function () {", " pm.response.to.have.status(201);", "});" ] } } ], "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": 1001,\n \"amount\": 2599,\n \"description\": \"Pedido 4210\"\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/qrcodes/static", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "qrcodes", "static" ] }, "description": "Gera um QR estático com valor fixo: amount em centavos entra na tag de valor (EMV 54) e o pagador não altera o valor. O QR estático é reutilizável e não expira. Obrigatório: account_id. Opcionais: pix_key (padrão: documento do titular da conta), description e city. Escopo necessário: pix:write." }, "response": [ { "name": "201 Created - QR com valor fixo", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": 1001,\n \"amount\": 2599,\n \"description\": \"Pedido 4210\"\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/qrcodes/static", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "qrcodes", "static" ] }, "description": "Gera um QR estático com valor fixo: amount em centavos entra na tag de valor (EMV 54) e o pagador não altera o valor. O QR estático é reutilizável e não expira. Obrigatório: account_id. Opcionais: pix_key (padrão: documento do titular da conta), description e city. Escopo necessário: pix:write." }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"account_id\": 1001,\n \"type\": \"static\",\n \"brcode\": \"00020101021126580014br.gov.bcb.pix...6304CD34\",\n \"qrcode_base64\": \"data:image/png;base64,...\",\n \"amount\": 2599,\n \"description\": \"Pedido 4210\",\n \"txId\": \"F6G7H8I9J0\",\n \"pixKey\": \"12345678901\"\n }\n}" } ] }, { "name": "Enviar PIX", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test(\"status 2xx\", function () {", " pm.expect(pm.response.code).to.be.within(200, 299);", "});" ] } } ], "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "enviar-pix-001", "description": "Opcional. Reenvios com a mesma chave retornam a resposta original." } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": 1001,\n \"amount\": 1500,\n \"pixKey\": \"joao.silva@exemplo.com.br\",\n \"recipientIspb\": \"00000000\",\n \"description\": \"Pagamento de servico\"\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/payments", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "payments" ] }, "description": "Envia um PIX a partir de uma conta do parceiro. Obrigatórios: account_id, amount, pixKey e recipientIspb. O valor amount é em centavos. Os fundos são reservados e o pagamento é processado. Escopo necessário: pix:write. Idempotente pelo cabeçalho Idempotency-Key." }, "response": [ { "name": "202 Accepted - PIX aceito", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "enviar-pix-001", "description": "Opcional. Reenvios com a mesma chave retornam a resposta original." } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": 1001,\n \"amount\": 1500,\n \"pixKey\": \"joao.silva@exemplo.com.br\",\n \"recipientIspb\": \"00000000\",\n \"description\": \"Pagamento de servico\"\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/payments", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "payments" ] }, "description": "Envia um PIX a partir de uma conta do parceiro. Obrigatórios: account_id, amount, pixKey e recipientIspb. O valor amount é em centavos. Os fundos são reservados e o pagamento é processado. Escopo necessário: pix:write. Idempotente pelo cabeçalho Idempotency-Key." }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"accepted\",\n \"transactionId\": \"PIXOUT20260627a1b2c3d4e5f6a7b8c9d0\",\n \"endToEndId\": \"E46026562202606271200000000001\",\n \"amount\": 1500,\n \"message\": \"PIX enviado para processamento\"\n}" }, { "name": "400 Bad Request - parâmetro obrigatório ausente", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "enviar-pix-001", "description": "Opcional. Reenvios com a mesma chave retornam a resposta original." } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": 1001,\n \"amount\": 1500,\n \"pixKey\": \"joao.silva@exemplo.com.br\",\n \"recipientIspb\": \"00000000\",\n \"description\": \"Pagamento de servico\"\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/payments", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "payments" ] }, "description": "Envia um PIX a partir de uma conta do parceiro. Obrigatórios: account_id, amount, pixKey e recipientIspb. O valor amount é em centavos. Os fundos são reservados e o pagamento é processado. Escopo necessário: pix:write. Idempotente pelo cabeçalho Idempotency-Key." }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 400,\n \"message\": \"Parâmetro obrigatório ausente\"\n }\n}" }, { "name": "422 Unprocessable Entity - saldo insuficiente", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "enviar-pix-001", "description": "Opcional. Reenvios com a mesma chave retornam a resposta original." } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": 1001,\n \"amount\": 1500,\n \"pixKey\": \"joao.silva@exemplo.com.br\",\n \"recipientIspb\": \"00000000\",\n \"description\": \"Pagamento de servico\"\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/payments", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "payments" ] }, "description": "Envia um PIX a partir de uma conta do parceiro. Obrigatórios: account_id, amount, pixKey e recipientIspb. O valor amount é em centavos. Os fundos são reservados e o pagamento é processado. Escopo necessário: pix:write. Idempotente pelo cabeçalho Idempotency-Key." }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 422,\n \"message\": \"Saldo insuficiente\"\n }\n}" }, { "name": "403 Forbidden - conta de outro parceiro", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "enviar-pix-001", "description": "Opcional. Reenvios com a mesma chave retornam a resposta original." } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": 1001,\n \"amount\": 1500,\n \"pixKey\": \"joao.silva@exemplo.com.br\",\n \"recipientIspb\": \"00000000\",\n \"description\": \"Pagamento de servico\"\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/payments", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "payments" ] }, "description": "Envia um PIX a partir de uma conta do parceiro. Obrigatórios: account_id, amount, pixKey e recipientIspb. O valor amount é em centavos. Os fundos são reservados e o pagamento é processado. Escopo necessário: pix:write. Idempotente pelo cabeçalho Idempotency-Key." }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 403,\n \"message\": \"account does not belong to this partner\"\n }\n}" }, { "name": "404 Not Found - conta não encontrada", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "enviar-pix-001", "description": "Opcional. Reenvios com a mesma chave retornam a resposta original." } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": 1001,\n \"amount\": 1500,\n \"pixKey\": \"joao.silva@exemplo.com.br\",\n \"recipientIspb\": \"00000000\",\n \"description\": \"Pagamento de servico\"\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/payments", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "payments" ] }, "description": "Envia um PIX a partir de uma conta do parceiro. Obrigatórios: account_id, amount, pixKey e recipientIspb. O valor amount é em centavos. Os fundos são reservados e o pagamento é processado. Escopo necessário: pix:write. Idempotente pelo cabeçalho Idempotency-Key." }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 404,\n \"message\": \"account not found\"\n }\n}" } ] }, { "name": "Status do PIX", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test(\"status 2xx\", function () {", " pm.expect(pm.response.code).to.be.within(200, 299);", "});" ] } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/payments/PIXOUT20260624abc123", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "payments", "PIXOUT20260624abc123" ], "variable": [ { "key": "id", "value": "PIXOUT20260624abc123", "description": "Id da transação" } ] }, "description": "Status de um pagamento PIX pelo id da transação, escopado ao parceiro. Valor em centavos. Escopo necessário: pix:read." }, "response": [ { "name": "200 OK - status do PIX (centavos)", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/payments/PIXOUT20260624abc123", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "payments", "PIXOUT20260624abc123" ], "variable": [ { "key": "id", "value": "PIXOUT20260624abc123", "description": "Id da transação" } ] }, "description": "Status de um pagamento PIX pelo id da transação, escopado ao parceiro. Valor em centavos. Escopo necessário: pix:read." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"transactionId\": \"PIXOUT20260627a1b2c3d4e5f6a7b8c9d0\",\n \"type\": \"pix\",\n \"status\": \"completed\",\n \"amount\": 1500,\n \"recipientKey\": \"joao.silva@exemplo.com.br\",\n \"endToEndId\": \"E46026562202606271200000000001\",\n \"errorReason\": null,\n \"createdAt\": \"2026-06-27T12:00:00Z\",\n \"completedAt\": \"2026-06-27T12:00:05Z\"\n }\n}" }, { "name": "404 Not Found - transação não encontrada", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/payments/PIXOUT20260624abc123", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "payments", "PIXOUT20260624abc123" ], "variable": [ { "key": "id", "value": "PIXOUT20260624abc123", "description": "Id da transação" } ] }, "description": "Status de um pagamento PIX pelo id da transação, escopado ao parceiro. Valor em centavos. Escopo necessário: pix:read." }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 404,\n \"message\": \"transação não encontrada\"\n }\n}" }, { "name": "403 Forbidden - transação de outro parceiro", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/payments/PIXOUT20260624abc123", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "payments", "PIXOUT20260624abc123" ], "variable": [ { "key": "id", "value": "PIXOUT20260624abc123", "description": "Id da transação" } ] }, "description": "Status de um pagamento PIX pelo id da transação, escopado ao parceiro. Valor em centavos. Escopo necessário: pix:read." }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 403,\n \"message\": \"transação não pertence a este parceiro\"\n }\n}" }, { "name": "401 Unauthorized - token ausente ou expirado", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/payments/PIXOUT20260624abc123", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "payments", "PIXOUT20260624abc123" ], "variable": [ { "key": "id", "value": "PIXOUT20260624abc123", "description": "Id da transação" } ] }, "description": "Status de um pagamento PIX pelo id da transação, escopado ao parceiro. Valor em centavos. Escopo necessário: pix:read." }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"message\": \"Invalid or expired partner access token\",\n \"status\": 401\n }\n}" } ] }, { "name": "Devolver PIX", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test(\"status 2xx\", function () {", " pm.expect(pm.response.code).to.be.within(200, 299);", "});" ] } } ], "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": 1001,\n \"amount\": 5000,\n \"reason\": \"MD06\",\n \"description\": \"Devolução solicitada pelo pagador\"\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/payments/PIXIN20260718abc123/refund", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "payments", "PIXIN20260718abc123", "refund" ], "variable": [ { "key": "id", "value": "PIXIN20260718abc123", "description": "Id da transação original recebida que está sendo devolvida" } ] }, "description": "Devolve um PIX RECEBIDO pela conta do parceiro: a devolução (pacs.004) é emitida pela Monetarie dentro da janela regulamentar de 90 dias da liquidação original. O id no caminho é a transação original recebida. Obrigatórios: account_id e amount (centavos). O campo reason é opcional (padrão MD06) e restrito à lista MD06, SL02, BE08, FR01, AC03, AC06, AC07, AC14, AG03, AG13, AM09, AM18, RR04. Devolução parcial é permitida até o restante devolvível da transação (devoluções pendentes contam contra o restante). Resposta 202 é o aceite, não o desfecho: a conclusão chega pelos webhooks pix.refund.completed ou pix.refund.failed. A devolução de um PIX que você ENVIOU é feita pelo recebedor e chega a você pelo webhook pix.payout.returned. Escopo necessário: pix:write." }, "response": [ { "name": "202 Accepted - devolução aceita", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": 1001,\n \"amount\": 5000,\n \"reason\": \"MD06\",\n \"description\": \"Devolução solicitada pelo pagador\"\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/payments/PIXIN20260718abc123/refund", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "payments", "PIXIN20260718abc123", "refund" ], "variable": [ { "key": "id", "value": "PIXIN20260718abc123", "description": "Id da transação original recebida que está sendo devolvida" } ] }, "description": "Devolve um PIX RECEBIDO pela conta do parceiro: a devolução (pacs.004) é emitida pela Monetarie dentro da janela regulamentar de 90 dias da liquidação original. O id no caminho é a transação original recebida. Obrigatórios: account_id e amount (centavos). O campo reason é opcional (padrão MD06) e restrito à lista MD06, SL02, BE08, FR01, AC03, AC06, AC07, AC14, AG03, AG13, AM09, AM18, RR04. Devolução parcial é permitida até o restante devolvível da transação (devoluções pendentes contam contra o restante). Resposta 202 é o aceite, não o desfecho: a conclusão chega pelos webhooks pix.refund.completed ou pix.refund.failed. A devolução de um PIX que você ENVIOU é feita pelo recebedor e chega a você pelo webhook pix.payout.returned. Escopo necessário: pix:write." }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"refundId\": \"PIXRET20260718b1c2d3e4f5a6\",\n \"originalTransactionId\": \"PIXIN20260718abc123\",\n \"endToEndId\": \"E4602656220260718091500aa11bb22c\",\n \"amount\": 5000,\n \"remainingRefundable\": 5000,\n \"status\": \"processing\",\n \"message\": \"Devolução PIX enviada para processamento\"\n }\n}" }, { "name": "404 Not Found - original inexistente ou de outra conta", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": 1001,\n \"amount\": 5000,\n \"reason\": \"MD06\",\n \"description\": \"Devolução solicitada pelo pagador\"\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/payments/PIXIN20260718abc123/refund", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "payments", "PIXIN20260718abc123", "refund" ], "variable": [ { "key": "id", "value": "PIXIN20260718abc123", "description": "Id da transação original recebida que está sendo devolvida" } ] }, "description": "Devolve um PIX RECEBIDO pela conta do parceiro: a devolução (pacs.004) é emitida pela Monetarie dentro da janela regulamentar de 90 dias da liquidação original. O id no caminho é a transação original recebida. Obrigatórios: account_id e amount (centavos). O campo reason é opcional (padrão MD06) e restrito à lista MD06, SL02, BE08, FR01, AC03, AC06, AC07, AC14, AG03, AG13, AM09, AM18, RR04. Devolução parcial é permitida até o restante devolvível da transação (devoluções pendentes contam contra o restante). Resposta 202 é o aceite, não o desfecho: a conclusão chega pelos webhooks pix.refund.completed ou pix.refund.failed. A devolução de um PIX que você ENVIOU é feita pelo recebedor e chega a você pelo webhook pix.payout.returned. Escopo necessário: pix:write." }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 404,\n \"message\": \"Transação original não encontrada para esta conta\"\n }\n}" }, { "name": "422 Unprocessable Entity - fora da janela de 90 dias", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": 1001,\n \"amount\": 5000,\n \"reason\": \"MD06\",\n \"description\": \"Devolução solicitada pelo pagador\"\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/payments/PIXIN20260718abc123/refund", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "payments", "PIXIN20260718abc123", "refund" ], "variable": [ { "key": "id", "value": "PIXIN20260718abc123", "description": "Id da transação original recebida que está sendo devolvida" } ] }, "description": "Devolve um PIX RECEBIDO pela conta do parceiro: a devolução (pacs.004) é emitida pela Monetarie dentro da janela regulamentar de 90 dias da liquidação original. O id no caminho é a transação original recebida. Obrigatórios: account_id e amount (centavos). O campo reason é opcional (padrão MD06) e restrito à lista MD06, SL02, BE08, FR01, AC03, AC06, AC07, AC14, AG03, AG13, AM09, AM18, RR04. Devolução parcial é permitida até o restante devolvível da transação (devoluções pendentes contam contra o restante). Resposta 202 é o aceite, não o desfecho: a conclusão chega pelos webhooks pix.refund.completed ou pix.refund.failed. A devolução de um PIX que você ENVIOU é feita pelo recebedor e chega a você pelo webhook pix.payout.returned. Escopo necessário: pix:write." }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 422,\n \"message\": \"Janela de devolução pelo fluxo original (90 dias) expirada\"\n }\n}" }, { "name": "422 Unprocessable Entity - PIX enviado não é devolvível por aqui", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": 1001,\n \"amount\": 5000,\n \"reason\": \"MD06\",\n \"description\": \"Devolução solicitada pelo pagador\"\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/payments/PIXIN20260718abc123/refund", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "payments", "PIXIN20260718abc123", "refund" ], "variable": [ { "key": "id", "value": "PIXIN20260718abc123", "description": "Id da transação original recebida que está sendo devolvida" } ] }, "description": "Devolve um PIX RECEBIDO pela conta do parceiro: a devolução (pacs.004) é emitida pela Monetarie dentro da janela regulamentar de 90 dias da liquidação original. O id no caminho é a transação original recebida. Obrigatórios: account_id e amount (centavos). O campo reason é opcional (padrão MD06) e restrito à lista MD06, SL02, BE08, FR01, AC03, AC06, AC07, AC14, AG03, AG13, AM09, AM18, RR04. Devolução parcial é permitida até o restante devolvível da transação (devoluções pendentes contam contra o restante). Resposta 202 é o aceite, não o desfecho: a conclusão chega pelos webhooks pix.refund.completed ou pix.refund.failed. A devolução de um PIX que você ENVIOU é feita pelo recebedor e chega a você pelo webhook pix.payout.returned. Escopo necessário: pix:write." }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 422,\n \"message\": \"Apenas PIX recebido pode ser devolvido; a devolução de um PIX enviado é feita pelo recebedor\"\n }\n}" }, { "name": "422 Unprocessable Entity - valor acima do restante devolvível", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": 1001,\n \"amount\": 5000,\n \"reason\": \"MD06\",\n \"description\": \"Devolução solicitada pelo pagador\"\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/payments/PIXIN20260718abc123/refund", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "payments", "PIXIN20260718abc123", "refund" ], "variable": [ { "key": "id", "value": "PIXIN20260718abc123", "description": "Id da transação original recebida que está sendo devolvida" } ] }, "description": "Devolve um PIX RECEBIDO pela conta do parceiro: a devolução (pacs.004) é emitida pela Monetarie dentro da janela regulamentar de 90 dias da liquidação original. O id no caminho é a transação original recebida. Obrigatórios: account_id e amount (centavos). O campo reason é opcional (padrão MD06) e restrito à lista MD06, SL02, BE08, FR01, AC03, AC06, AC07, AC14, AG03, AG13, AM09, AM18, RR04. Devolução parcial é permitida até o restante devolvível da transação (devoluções pendentes contam contra o restante). Resposta 202 é o aceite, não o desfecho: a conclusão chega pelos webhooks pix.refund.completed ou pix.refund.failed. A devolução de um PIX que você ENVIOU é feita pelo recebedor e chega a você pelo webhook pix.payout.returned. Escopo necessário: pix:write." }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 422,\n \"message\": \"Valor excede o restante devolvível da transação original (2500 centavos)\"\n }\n}" } ] }, { "name": "Trilha de devoluções da transação", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test(\"status 200\", function () {", " pm.response.to.have.status(200);", "});" ] } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/payments/PIXIN20260718abc123/refunds?account_id=1001", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "payments", "PIXIN20260718abc123", "refunds" ], "query": [ { "key": "account_id", "value": "1001" } ], "variable": [ { "key": "id", "value": "PIXIN20260718abc123", "description": "Id da transação original recebida" } ] }, "description": "Trilha de devoluções de um PIX recebido: devolve a transação original, o restante devolvível e a lista de devoluções já solicitadas, cada uma com o seu estado. O campo rtrId (identificador da devolução no arranjo PIX) fica nulo enquanto a devolução processa e é preenchido no desfecho. Valores em centavos. Um id inexistente ou de outra conta responde 404. Escopo necessário: pix:read." }, "response": [ { "name": "200 OK - trilha de devoluções", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/payments/PIXIN20260718abc123/refunds?account_id=1001", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "payments", "PIXIN20260718abc123", "refunds" ], "query": [ { "key": "account_id", "value": "1001" } ], "variable": [ { "key": "id", "value": "PIXIN20260718abc123", "description": "Id da transação original recebida" } ] }, "description": "Trilha de devoluções de um PIX recebido: devolve a transação original, o restante devolvível e a lista de devoluções já solicitadas, cada uma com o seu estado. O campo rtrId (identificador da devolução no arranjo PIX) fica nulo enquanto a devolução processa e é preenchido no desfecho. Valores em centavos. Um id inexistente ou de outra conta responde 404. Escopo necessário: pix:read." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"original\": {\n \"transactionId\": \"PIXIN20260718abc123\",\n \"endToEndId\": \"E4602656220260718091500aa11bb22c\",\n \"amount\": 10000,\n \"status\": \"settled\",\n \"completedAt\": \"2026-07-18T09:15:01Z\"\n },\n \"remainingRefundable\": 5000,\n \"refunds\": [\n {\n \"refundId\": \"PIXRET20260718b1c2d3e4f5a6\",\n \"rtrId\": \"D46026562202607180920aabbccddeef\",\n \"amount\": 5000,\n \"status\": \"settled\",\n \"reasonCode\": \"MD06\",\n \"reasonDescription\": \"Devolução solicitada pelo pagador\",\n \"requestedAt\": \"2026-07-18T09:20:00Z\",\n \"completedAt\": \"2026-07-18T09:20:02Z\"\n }\n ]\n }\n}" } ] }, { "name": "Criar cobrança PIX", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test(\"status 2xx\", function () {", " pm.expect(pm.response.code).to.be.within(200, 299);", "});" ] } } ], "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": 1001,\n \"amount\": 9990,\n \"description\": \"Cobranca de mensalidade\",\n \"pix_key\": \"maria.oliveira@exemplo.com.br\",\n \"city\": \"SAO PAULO\"\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/charges", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "charges" ] }, "description": "Cria uma cobrança/QR (BR Code EMV-MPM com CRC16, mais imagem QR em base64) para uma conta do parceiro. Obrigatórios: account_id e amount. O valor é em centavos. Escopo necessário: pix:write." }, "response": [ { "name": "201 Created - cobrança criada (centavos)", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": 1001,\n \"amount\": 9990,\n \"description\": \"Cobranca de mensalidade\",\n \"pix_key\": \"maria.oliveira@exemplo.com.br\",\n \"city\": \"SAO PAULO\"\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/charges", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "charges" ] }, "description": "Cria uma cobrança/QR (BR Code EMV-MPM com CRC16, mais imagem QR em base64) para uma conta do parceiro. Obrigatórios: account_id e amount. O valor é em centavos. Escopo necessário: pix:write." }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"account_id\": 1001,\n \"brcode\": \"00020126360014br.gov.bcb.pix0114maria.oliveira@exemplo.com.br52040000530398654049.9058025802BR5914MARIA OLIVEIRA6009SAO PAULO62070503***6304A1B2\",\n \"qrcode_base64\": \"iVBORw0KGgoAAAANSUhEUgAAAQAAAAEACAYAAABccqhmAAAABmJLR0QA\",\n \"amount\": 9990,\n \"description\": \"Cobrança de mensalidade\",\n \"txId\": \"abc123def456ghi789jkl\",\n \"expiresAt\": \"2026-06-27T13:00:00Z\"\n }\n}" }, { "name": "400 Bad Request - valor inválido", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": 1001,\n \"amount\": 9990,\n \"description\": \"Cobranca de mensalidade\",\n \"pix_key\": \"maria.oliveira@exemplo.com.br\",\n \"city\": \"SAO PAULO\"\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/charges", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "charges" ] }, "description": "Cria uma cobrança/QR (BR Code EMV-MPM com CRC16, mais imagem QR em base64) para uma conta do parceiro. Obrigatórios: account_id e amount. O valor é em centavos. Escopo necessário: pix:write." }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 400,\n \"message\": \"Valor inválido\"\n }\n}" }, { "name": "422 Unprocessable Entity - account_id ausente", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": 1001,\n \"amount\": 9990,\n \"description\": \"Cobranca de mensalidade\",\n \"pix_key\": \"maria.oliveira@exemplo.com.br\",\n \"city\": \"SAO PAULO\"\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/charges", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "charges" ] }, "description": "Cria uma cobrança/QR (BR Code EMV-MPM com CRC16, mais imagem QR em base64) para uma conta do parceiro. Obrigatórios: account_id e amount. O valor é em centavos. Escopo necessário: pix:write." }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 422,\n \"message\": \"account_id is required\"\n }\n}" }, { "name": "403 Forbidden - conta de outro parceiro", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": 1001,\n \"amount\": 9990,\n \"description\": \"Cobranca de mensalidade\",\n \"pix_key\": \"maria.oliveira@exemplo.com.br\",\n \"city\": \"SAO PAULO\"\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/charges", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "charges" ] }, "description": "Cria uma cobrança/QR (BR Code EMV-MPM com CRC16, mais imagem QR em base64) para uma conta do parceiro. Obrigatórios: account_id e amount. O valor é em centavos. Escopo necessário: pix:write." }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 403,\n \"message\": \"account does not belong to this partner\"\n }\n}" }, { "name": "404 Not Found - conta não encontrada", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": 1001,\n \"amount\": 9990,\n \"description\": \"Cobranca de mensalidade\",\n \"pix_key\": \"maria.oliveira@exemplo.com.br\",\n \"city\": \"SAO PAULO\"\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/charges", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "charges" ] }, "description": "Cria uma cobrança/QR (BR Code EMV-MPM com CRC16, mais imagem QR em base64) para uma conta do parceiro. Obrigatórios: account_id e amount. O valor é em centavos. Escopo necessário: pix:write." }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 404,\n \"message\": \"account not found\"\n }\n}" } ] }, { "name": "Status da cobrança PIX", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test(\"status 2xx\", function () {", " pm.expect(pm.response.code).to.be.within(200, 299);", "});" ] } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/charges/abc123def456ghi789jkl", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "charges", "abc123def456ghi789jkl" ], "variable": [ { "key": "id", "value": "abc123def456ghi789jkl", "description": "tx_id da cobrança" } ] }, "description": "Status de uma cobrança PIX pelo tx_id, escopado ao parceiro. Valor em centavos. Escopo necessário: pix:read." }, "response": [ { "name": "200 OK - status da cobrança (centavos)", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/charges/abc123def456ghi789jkl", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "charges", "abc123def456ghi789jkl" ], "variable": [ { "key": "id", "value": "abc123def456ghi789jkl", "description": "tx_id da cobrança" } ] }, "description": "Status de uma cobrança PIX pelo tx_id, escopado ao parceiro. Valor em centavos. Escopo necessário: pix:read." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"txId\": \"abc123def456ghi789jkl\",\n \"account_id\": 1001,\n \"type\": \"dynamic\",\n \"status\": \"active\",\n \"amount\": 9990,\n \"description\": \"Cobrança de mensalidade\",\n \"brcode\": \"00020126360014br.gov.bcb.pix0114maria.oliveira@exemplo.com.br6304A1B2\",\n \"expiresAt\": \"2026-06-27T13:00:00Z\",\n \"paidAt\": null\n }\n}" }, { "name": "404 Not Found - cobrança não encontrada", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/charges/abc123def456ghi789jkl", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "charges", "abc123def456ghi789jkl" ], "variable": [ { "key": "id", "value": "abc123def456ghi789jkl", "description": "tx_id da cobrança" } ] }, "description": "Status de uma cobrança PIX pelo tx_id, escopado ao parceiro. Valor em centavos. Escopo necessário: pix:read." }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 404,\n \"message\": \"cobrança não encontrada\"\n }\n}" }, { "name": "403 Forbidden - cobrança de outro parceiro", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/charges/abc123def456ghi789jkl", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "charges", "abc123def456ghi789jkl" ], "variable": [ { "key": "id", "value": "abc123def456ghi789jkl", "description": "tx_id da cobrança" } ] }, "description": "Status de uma cobrança PIX pelo tx_id, escopado ao parceiro. Valor em centavos. Escopo necessário: pix:read." }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 403,\n \"message\": \"cobrança não pertence a este parceiro\"\n }\n}" }, { "name": "401 Unauthorized - token ausente ou expirado", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/charges/abc123def456ghi789jkl", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "charges", "abc123def456ghi789jkl" ], "variable": [ { "key": "id", "value": "abc123def456ghi789jkl", "description": "tx_id da cobrança" } ] }, "description": "Status de uma cobrança PIX pelo tx_id, escopado ao parceiro. Valor em centavos. Escopo necessário: pix:read." }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"message\": \"Invalid or expired partner access token\",\n \"status\": 401\n }\n}" } ] }, { "name": "Decodificar BR Code", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/brcode/decode", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "brcode", "decode" ] }, "body": { "mode": "raw", "raw": "{\n \"brcode\": \"00020101021126...\"\n}" }, "description": "Decodifica um BR Code (copia e cola) e devolve os campos interpretados, sem pagar. amount em centavos. Escopo pix:write." } }, { "name": "Cobranca com vencimento (CobV)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "", "description": "Opcional. Reenvios com a mesma chave retornam a resposta original." } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/cobv", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "cobv" ] }, "body": { "mode": "raw", "raw": "{\n \"account_id\": 1001,\n \"amount\": 12345,\n \"due_date\": \"2026-09-30\",\n \"interest_type\": \"PERCENTUAL\",\n \"interest_value\": \"1.00\",\n \"fine_type\": \"FIXO\",\n \"fine_value\": \"5.00\",\n \"debtor_name\": \"Cliente Exemplo\",\n \"debtor_document\": \"12345678909\"\n}" }, "description": "Cobranca PIX com vencimento. Obrigatorios: account_id, amount (centavos), due_date (AAAA-MM-DD). Juros/multa/desconto opcionais (FIXO ou PERCENTUAL). Escopo pix:write." } }, { "name": "Criar reivindicacao (portabilidade)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/claims", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "claims" ] }, "body": { "mode": "raw", "raw": "{\n \"account_id\": 1001,\n \"key\": \"maria@exemplo.com.br\",\n \"keyType\": \"EMAIL\"\n}" }, "description": "Cria uma reivindicacao/portabilidade de chave para a conta do parceiro. Escopo pix:write." } }, { "name": "Listar reivindicacoes", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/claims?account_id=1001&status=", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "claims" ], "query": [ { "key": "account_id", "value": "1001", "description": "Conta do parceiro" }, { "key": "status", "value": "", "description": "Filtro opcional por status" } ] }, "description": "Lista as reivindicações de portabilidade que envolvem a conta informada, como reivindicadora ou doadora (claimer_account ou donor_account). Filtros opcionais status, limit (padrão 50) e offset. Resposta 200 com data.claims e data.total. Escopo pix:read." } }, { "name": "Consultar reivindicacao", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/claims/CLAIM_ID?account_id=1001", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "claims", "CLAIM_ID" ], "query": [ { "key": "account_id", "value": "1001" } ] }, "description": "Status de uma reivindicacao, escopada a conta. Escopo pix:read." } }, { "name": "Confirmar reivindicacao", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/claims/CLAIM_ID/confirm", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "claims", "CLAIM_ID", "confirm" ] }, "body": { "mode": "raw", "raw": "{\n \"account_id\": 1001\n}" }, "description": "Confirma a reivindicacao. Escopo pix:write." } }, { "name": "Completar reivindicacao", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/claims/CLAIM_ID/complete", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "claims", "CLAIM_ID", "complete" ] }, "body": { "mode": "raw", "raw": "{\n \"account_id\": 1001\n}" }, "description": "Completa a reivindicação (ação da reivindicadora ao fim da portabilidade ou reivindicação de posse). A reivindicação precisa envolver a conta informada (senão 403); id desconhecido responde 404. Resposta 200 com o estado atualizado em data. Escopo pix:write." } }, { "name": "Cancelar reivindicacao", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/claims/CLAIM_ID/cancel", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "claims", "CLAIM_ID", "cancel" ] }, "body": { "mode": "raw", "raw": "{\n \"account_id\": 1001\n}" }, "description": "Cancela a reivindicacao. Escopo pix:write." } }, { "name": "Abrir MED (recuperação de fundos)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/med", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "med" ] }, "body": { "mode": "raw", "raw": "{\n \"account_id\": 1001,\n \"end_to_end_id\": \"E4602656220260714210000aabbccdd0\",\n \"fraud_category\": \"SCAM\",\n \"details\": \"Cliente relata golpe na negociação\"\n}" }, "description": "Abre uma intervenção MED (recuperação de fundos) sobre um PIX. fraud_category aceita FRAUDULENT_ACCESS, SCAM, ACCOUNT_TAKEOVER ou OTHER. A transação do end_to_end_id precisa pertencer à conta informada (senão 422). Resposta 202 com data.medId, status CREATED, rootTransactionId, fraudCategory e createdAt. Escopo pix:write." } }, { "name": "Consultar MED", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/med/MED_ID?account_id=1001", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "med", "MED_ID" ], "query": [ { "key": "account_id", "value": "1001", "description": "Conta do parceiro dona da transação" } ] }, "description": "Consulta uma intervenção MED. Responde 404 quando a intervenção não pertence à conta informada. Acompanhe também pelos webhooks pix.infraction.created e pix.infraction.resolved. Escopo pix:read." } }, { "name": "Listar MED", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/med?account_id=1001", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "med" ], "query": [ { "key": "account_id", "value": "1001", "description": "Conta do parceiro dona da transação raiz" } ] }, "description": "Lista as intervenções MED cuja transação raiz envolve a conta informada. Filtro opcional limit (padrão 50). Resposta 200 com data.recoveries (medId, status, rootTransactionId, fraudCategory, createdAt) e data.total. Escopo pix:read." } }, { "name": "Cancelar MED", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/med/MED_ID/cancel", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "med", "MED_ID", "cancel" ] }, "body": { "mode": "raw", "raw": "{\n \"account_id\": 1001\n}" }, "description": "Cancela a intervenção MED. Responde 404 quando a intervenção não pertence à conta informada. Resposta 200 com data (medId, status, rootTransactionId, fraudCategory, createdAt). O cancelamento também é notificado pelo webhook pix.med.cancelled. Escopo pix:write." } }, { "name": "Grafo de rastreamento do MED", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/med/MED_ID/graph?account_id=1001", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "med", "MED_ID", "graph" ], "query": [ { "key": "account_id", "value": "1001", "description": "Conta do parceiro dona da transação raiz" } ] }, "description": "Devolve em data o grafo de rastreamento dos fundos da intervenção MED, no formato do arranjo PIX (repasse do rastreamento entre instituições). Responde 404 quando a intervenção não pertence à conta informada. Escopo pix:read." } }, { "name": "Solicitar devolucao do MED", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/med/MED_ID/refund", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "med", "MED_ID", "refund" ] }, "body": { "mode": "raw", "raw": "{\n \"account_id\": 1001,\n \"amount\": 5000\n}" }, "description": "Solicita a devolução dos fundos da intervenção MED. amount em centavos é opcional: sem ele, a devolução sai pelo valor integral da transação raiz. Responde 404 quando a intervenção não pertence à conta informada. Resposta 202 com data (refundId, recoveryId, status, amount). Escopo pix:write." } }, { "name": "Abrir infracao DICT", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/infractions", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "infractions" ] }, "body": { "mode": "raw", "raw": "{\n \"account_id\": 1001,\n \"end_to_end_id\": \"E4602656220260714210000aabbccdd0\",\n \"details\": \"Cliente relata fraude na transação\"\n}" }, "description": "Abre um relato de infração DICT sobre uma transação da conta. Obrigatórios: account_id e end_to_end_id; details descreve o caso. A transação precisa pertencer à conta informada (senão 422). Resposta 202 com data (infractionId, status, endToEndId, debtorIspb, creditorIspb, analysisResult, analysisDetails, createdAt, updatedAt). Escopo pix:write." } }, { "name": "Listar infracoes DICT", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/infractions?account_id=1001&limit=50&offset=0", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "infractions" ], "query": [ { "key": "account_id", "value": "1001", "description": "Conta do parceiro" }, { "key": "limit", "value": "50", "description": "Máximo de itens (padrão 50)" }, { "key": "offset", "value": "0", "description": "Deslocamento da página" } ] }, "description": "Lista os relatos de infração DICT sobre transações da conta informada. Resposta 200 com data.infractions e data.total. Escopo pix:read." } }, { "name": "Consultar infracao DICT", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/infractions/INFRACTION_ID?account_id=1001", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "infractions", "INFRACTION_ID" ], "query": [ { "key": "account_id", "value": "1001", "description": "Conta do parceiro" } ] }, "description": "Consulta um relato de infração DICT. Responde 404 quando a infração não envolve transação da conta informada. Resposta 200 com data (infractionId, status, endToEndId, debtorIspb, creditorIspb, analysisResult, analysisDetails, createdAt, updatedAt). Escopo pix:read." } }, { "name": "Cancelar infracao DICT", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/infractions/INFRACTION_ID/cancel", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "infractions", "INFRACTION_ID", "cancel" ] }, "body": { "mode": "raw", "raw": "{\n \"account_id\": 1001\n}" }, "description": "Cancela o relato de infração DICT. Mesmo escopo da consulta: infração que não envolve a conta responde 404. Resposta 200 com a infração atualizada em data. Escopo pix:write." } }, { "name": "Enviar defesa da infracao", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/pix/infractions/INFRACTION_ID/defense", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "pix", "infractions", "INFRACTION_ID", "defense" ] }, "body": { "mode": "raw", "raw": "{\n \"account_id\": 1001,\n \"defense_text\": \"Prestação de serviço comprovada, nota fiscal 4210 anexada ao atendimento\"\n}" }, "description": "Envia a defesa do cliente para uma infração que bloqueou valores da conta cautelarmente. Obrigatórios: account_id e defense_text. O id aceita o identificador da infração ou do bloqueio. Resposta 200 com data (infractionId, blockId, status defense_submitted); infração que não está mais em fase de defesa responde 422. O registro também é notificado pelo webhook pix.infraction.defense_submitted. Escopo pix:write." } } ] }, { "name": "Transferências", "description": "TED externo, transferência interna entre contas do parceiro, status e favoritos. Valores de entrada em centavos.", "item": [ { "name": "Enviar TED", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test(\"status 2xx\", function () {", " pm.expect(pm.response.code).to.be.within(200, 299);", "});" ] } } ], "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "enviar-ted-001", "description": "Opcional. Reenvios com a mesma chave retornam a resposta original." } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": 1001,\n \"amount\": 25000,\n \"recipientBankCode\": \"00000000\",\n \"recipientName\": \"Joao Silva\",\n \"recipientDocument\": \"98765432100\",\n \"recipientBranch\": \"0001\",\n \"recipientAccount\": \"123456-7\",\n \"purposeCode\": \"10\",\n \"description\": \"Pagamento de fornecedor\"\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/transfers/ted", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "transfers", "ted" ] }, "description": "Inicia um TED externo a partir de uma conta do parceiro. Obrigatórios: account_id e amount. recipientBankCode é o ISPB do banco destino. O valor é em centavos. Escopo necessário: transfer:write. Idempotente pelo cabeçalho Idempotency-Key." }, "response": [ { "name": "202 Accepted - TED aceito", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "enviar-ted-001", "description": "Opcional. Reenvios com a mesma chave retornam a resposta original." } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": 1001,\n \"amount\": 25000,\n \"recipientBankCode\": \"00000000\",\n \"recipientName\": \"Joao Silva\",\n \"recipientDocument\": \"98765432100\",\n \"recipientBranch\": \"0001\",\n \"recipientAccount\": \"123456-7\",\n \"purposeCode\": \"10\",\n \"description\": \"Pagamento de fornecedor\"\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/transfers/ted", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "transfers", "ted" ] }, "description": "Inicia um TED externo a partir de uma conta do parceiro. Obrigatórios: account_id e amount. recipientBankCode é o ISPB do banco destino. O valor é em centavos. Escopo necessário: transfer:write. Idempotente pelo cabeçalho Idempotency-Key." }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"accepted\",\n \"transactionId\": \"TED20260627a1b2c3d4e5f6a7b8c9d0\",\n \"amount\": 25000,\n \"message\": \"TED enviado para processamento via SPB/BACEN\"\n}" }, { "name": "400 Bad Request - valor inválido", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "enviar-ted-001", "description": "Opcional. Reenvios com a mesma chave retornam a resposta original." } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": 1001,\n \"amount\": 25000,\n \"recipientBankCode\": \"00000000\",\n \"recipientName\": \"Joao Silva\",\n \"recipientDocument\": \"98765432100\",\n \"recipientBranch\": \"0001\",\n \"recipientAccount\": \"123456-7\",\n \"purposeCode\": \"10\",\n \"description\": \"Pagamento de fornecedor\"\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/transfers/ted", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "transfers", "ted" ] }, "description": "Inicia um TED externo a partir de uma conta do parceiro. Obrigatórios: account_id e amount. recipientBankCode é o ISPB do banco destino. O valor é em centavos. Escopo necessário: transfer:write. Idempotente pelo cabeçalho Idempotency-Key." }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 400,\n \"message\": \"Valor inválido\"\n }\n}" }, { "name": "422 Unprocessable Entity - saldo insuficiente", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "enviar-ted-001", "description": "Opcional. Reenvios com a mesma chave retornam a resposta original." } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": 1001,\n \"amount\": 25000,\n \"recipientBankCode\": \"00000000\",\n \"recipientName\": \"Joao Silva\",\n \"recipientDocument\": \"98765432100\",\n \"recipientBranch\": \"0001\",\n \"recipientAccount\": \"123456-7\",\n \"purposeCode\": \"10\",\n \"description\": \"Pagamento de fornecedor\"\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/transfers/ted", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "transfers", "ted" ] }, "description": "Inicia um TED externo a partir de uma conta do parceiro. Obrigatórios: account_id e amount. recipientBankCode é o ISPB do banco destino. O valor é em centavos. Escopo necessário: transfer:write. Idempotente pelo cabeçalho Idempotency-Key." }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 422,\n \"message\": \"Saldo insuficiente\"\n }\n}" }, { "name": "403 Forbidden - conta de outro parceiro", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "enviar-ted-001", "description": "Opcional. Reenvios com a mesma chave retornam a resposta original." } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": 1001,\n \"amount\": 25000,\n \"recipientBankCode\": \"00000000\",\n \"recipientName\": \"Joao Silva\",\n \"recipientDocument\": \"98765432100\",\n \"recipientBranch\": \"0001\",\n \"recipientAccount\": \"123456-7\",\n \"purposeCode\": \"10\",\n \"description\": \"Pagamento de fornecedor\"\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/transfers/ted", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "transfers", "ted" ] }, "description": "Inicia um TED externo a partir de uma conta do parceiro. Obrigatórios: account_id e amount. recipientBankCode é o ISPB do banco destino. O valor é em centavos. Escopo necessário: transfer:write. Idempotente pelo cabeçalho Idempotency-Key." }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 403,\n \"message\": \"account does not belong to this partner\"\n }\n}" }, { "name": "404 Not Found - conta de origem não encontrada", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "enviar-ted-001", "description": "Opcional. Reenvios com a mesma chave retornam a resposta original." } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": 1001,\n \"amount\": 25000,\n \"recipientBankCode\": \"00000000\",\n \"recipientName\": \"Joao Silva\",\n \"recipientDocument\": \"98765432100\",\n \"recipientBranch\": \"0001\",\n \"recipientAccount\": \"123456-7\",\n \"purposeCode\": \"10\",\n \"description\": \"Pagamento de fornecedor\"\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/transfers/ted", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "transfers", "ted" ] }, "description": "Inicia um TED externo a partir de uma conta do parceiro. Obrigatórios: account_id e amount. recipientBankCode é o ISPB do banco destino. O valor é em centavos. Escopo necessário: transfer:write. Idempotente pelo cabeçalho Idempotency-Key." }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 404,\n \"message\": \"account not found\"\n }\n}" } ] }, { "name": "Transferência interna", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test(\"status 2xx\", function () {", " pm.expect(pm.response.code).to.be.within(200, 299);", "});" ] } } ], "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "transferencia-interna-001", "description": "Opcional. Reenvios com a mesma chave retornam a resposta original." } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": 1001,\n \"destination_account_id\": 1002,\n \"amount\": 5000,\n \"description\": \"Transferencia entre contas\"\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/transfers/internal", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "transfers", "internal" ] }, "description": "Move dinheiro entre duas contas do parceiro. Tanto a origem (account_id) quanto o destino (destination_account_id) são autorizados contra o parceiro antes da operação. Obrigatórios: account_id, destination_account_id e amount. O valor é em centavos. Escopo necessário: transfer:write. Idempotente pelo cabeçalho Idempotency-Key." }, "response": [ { "name": "202 Accepted - transferência interna aceita", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "transferencia-interna-001", "description": "Opcional. Reenvios com a mesma chave retornam a resposta original." } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": 1001,\n \"destination_account_id\": 1002,\n \"amount\": 5000,\n \"description\": \"Transferencia entre contas\"\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/transfers/internal", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "transfers", "internal" ] }, "description": "Move dinheiro entre duas contas do parceiro. Tanto a origem (account_id) quanto o destino (destination_account_id) são autorizados contra o parceiro antes da operação. Obrigatórios: account_id, destination_account_id e amount. O valor é em centavos. Escopo necessário: transfer:write. Idempotente pelo cabeçalho Idempotency-Key." }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"accepted\",\n \"transactionId\": \"TEF20260627a1b2c3d4e5f6a7b8c9d0\",\n \"amount\": 5000,\n \"message\": \"Transferência interna aceita para processamento\"\n}" }, { "name": "400 Bad Request - valor inválido", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "transferencia-interna-001", "description": "Opcional. Reenvios com a mesma chave retornam a resposta original." } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": 1001,\n \"destination_account_id\": 1002,\n \"amount\": 5000,\n \"description\": \"Transferencia entre contas\"\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/transfers/internal", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "transfers", "internal" ] }, "description": "Move dinheiro entre duas contas do parceiro. Tanto a origem (account_id) quanto o destino (destination_account_id) são autorizados contra o parceiro antes da operação. Obrigatórios: account_id, destination_account_id e amount. O valor é em centavos. Escopo necessário: transfer:write. Idempotente pelo cabeçalho Idempotency-Key." }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 400,\n \"message\": \"Valor inválido\"\n }\n}" }, { "name": "422 Unprocessable Entity - destino obrigatório", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "transferencia-interna-001", "description": "Opcional. Reenvios com a mesma chave retornam a resposta original." } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": 1001,\n \"destination_account_id\": 1002,\n \"amount\": 5000,\n \"description\": \"Transferencia entre contas\"\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/transfers/internal", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "transfers", "internal" ] }, "description": "Move dinheiro entre duas contas do parceiro. Tanto a origem (account_id) quanto o destino (destination_account_id) são autorizados contra o parceiro antes da operação. Obrigatórios: account_id, destination_account_id e amount. O valor é em centavos. Escopo necessário: transfer:write. Idempotente pelo cabeçalho Idempotency-Key." }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 422,\n \"message\": \"destination_account_id is required\"\n }\n}" }, { "name": "403 Forbidden - conta de destino de outro parceiro", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "transferencia-interna-001", "description": "Opcional. Reenvios com a mesma chave retornam a resposta original." } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": 1001,\n \"destination_account_id\": 1002,\n \"amount\": 5000,\n \"description\": \"Transferencia entre contas\"\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/transfers/internal", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "transfers", "internal" ] }, "description": "Move dinheiro entre duas contas do parceiro. Tanto a origem (account_id) quanto o destino (destination_account_id) são autorizados contra o parceiro antes da operação. Obrigatórios: account_id, destination_account_id e amount. O valor é em centavos. Escopo necessário: transfer:write. Idempotente pelo cabeçalho Idempotency-Key." }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 403,\n \"message\": \"destination account does not belong to this partner\"\n }\n}" }, { "name": "404 Not Found - conta de destino não encontrada", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "transferencia-interna-001", "description": "Opcional. Reenvios com a mesma chave retornam a resposta original." } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": 1001,\n \"destination_account_id\": 1002,\n \"amount\": 5000,\n \"description\": \"Transferencia entre contas\"\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/transfers/internal", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "transfers", "internal" ] }, "description": "Move dinheiro entre duas contas do parceiro. Tanto a origem (account_id) quanto o destino (destination_account_id) são autorizados contra o parceiro antes da operação. Obrigatórios: account_id, destination_account_id e amount. O valor é em centavos. Escopo necessário: transfer:write. Idempotente pelo cabeçalho Idempotency-Key." }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 404,\n \"message\": \"destination account not found\"\n }\n}" } ] }, { "name": "Status da transferência", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test(\"status 2xx\", function () {", " pm.expect(pm.response.code).to.be.within(200, 299);", "});" ] } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/transfers/TED20260624abc123", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "transfers", "TED20260624abc123" ], "variable": [ { "key": "id", "value": "TED20260624abc123", "description": "Id da transação da transferência" } ] }, "description": "Status de uma transferência pelo transactionId, escopado ao parceiro. Escopo necessário: transfer:read." }, "response": [ { "name": "200 OK - status da transferência (centavos)", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/transfers/TED20260624abc123", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "transfers", "TED20260624abc123" ], "variable": [ { "key": "id", "value": "TED20260624abc123", "description": "Id da transação da transferência" } ] }, "description": "Status de uma transferência pelo transactionId, escopado ao parceiro. Escopo necessário: transfer:read." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"transactionId\": \"TED20260627a1b2c3d4e5f6a7b8c9d0\",\n \"type\": \"ted\",\n \"status\": \"completed\",\n \"amount\": 25000,\n \"recipientKey\": \"123456-7\",\n \"direction\": \"outbound\",\n \"createdAt\": \"2026-06-27T12:00:00Z\",\n \"completedAt\": \"2026-06-27T12:01:00Z\"\n }\n}" }, { "name": "404 Not Found - transação não encontrada", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/transfers/TED20260624abc123", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "transfers", "TED20260624abc123" ], "variable": [ { "key": "id", "value": "TED20260624abc123", "description": "Id da transação da transferência" } ] }, "description": "Status de uma transferência pelo transactionId, escopado ao parceiro. Escopo necessário: transfer:read." }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 404,\n \"message\": \"transação não encontrada\"\n }\n}" }, { "name": "403 Forbidden - transação de outro parceiro", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/transfers/TED20260624abc123", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "transfers", "TED20260624abc123" ], "variable": [ { "key": "id", "value": "TED20260624abc123", "description": "Id da transação da transferência" } ] }, "description": "Status de uma transferência pelo transactionId, escopado ao parceiro. Escopo necessário: transfer:read." }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 403,\n \"message\": \"transação não pertence a este parceiro\"\n }\n}" }, { "name": "401 Unauthorized - token ausente ou expirado", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/transfers/TED20260624abc123", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "transfers", "TED20260624abc123" ], "variable": [ { "key": "id", "value": "TED20260624abc123", "description": "Id da transação da transferência" } ] }, "description": "Status de uma transferência pelo transactionId, escopado ao parceiro. Escopo necessário: transfer:read." }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"message\": \"Invalid or expired partner access token\",\n \"status\": 401\n }\n}" } ] }, { "name": "Criar favorito", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test(\"status 2xx\", function () {", " pm.expect(pm.response.code).to.be.within(200, 299);", "});" ] } } ], "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": 1001,\n \"name\": \"Joao Silva\",\n \"document\": \"98765432100\",\n \"bankCode\": \"00000000\",\n \"branch\": \"0001\",\n \"accountNumber\": \"123456-7\",\n \"accountType\": \"checking\",\n \"pixKey\": \"joao.silva@exemplo.com.br\",\n \"pixKeyType\": \"email\"\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/transfers/favorites", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "transfers", "favorites" ] }, "description": "Cria um favorito de beneficiário escopado a uma conta do parceiro. Obrigatórios: account_id e name. Escopo necessário: transfer:write." }, "response": [ { "name": "201 Created - favorito criado", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": 1001,\n \"name\": \"Joao Silva\",\n \"document\": \"98765432100\",\n \"bankCode\": \"00000000\",\n \"branch\": \"0001\",\n \"accountNumber\": \"123456-7\",\n \"accountType\": \"checking\",\n \"pixKey\": \"joao.silva@exemplo.com.br\",\n \"pixKeyType\": \"email\"\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/transfers/favorites", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "transfers", "favorites" ] }, "description": "Cria um favorito de beneficiário escopado a uma conta do parceiro. Obrigatórios: account_id e name. Escopo necessário: transfer:write." }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"9d4f2c1a-7b3e-4c91-8a52-0f1e2d3c4b5a\",\n \"name\": \"João Silva\",\n \"document\": \"98765432100\",\n \"bankCode\": \"00000000\",\n \"branch\": \"0001\",\n \"accountNumber\": \"123456-7\",\n \"accountType\": \"checking\",\n \"pixKey\": \"joao.silva@exemplo.com.br\",\n \"pixKeyType\": \"email\",\n \"createdAt\": \"2026-06-27T12:00:00Z\"\n }\n}" }, { "name": "422 Unprocessable Entity - validação do favorito", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": 1001,\n \"name\": \"Joao Silva\",\n \"document\": \"98765432100\",\n \"bankCode\": \"00000000\",\n \"branch\": \"0001\",\n \"accountNumber\": \"123456-7\",\n \"accountType\": \"checking\",\n \"pixKey\": \"joao.silva@exemplo.com.br\",\n \"pixKeyType\": \"email\"\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/transfers/favorites", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "transfers", "favorites" ] }, "description": "Cria um favorito de beneficiário escopado a uma conta do parceiro. Obrigatórios: account_id e name. Escopo necessário: transfer:write." }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 422,\n \"message\": \"Erro ao criar favorito: name can't be blank\"\n }\n}" }, { "name": "403 Forbidden - conta de outro parceiro", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": 1001,\n \"name\": \"Joao Silva\",\n \"document\": \"98765432100\",\n \"bankCode\": \"00000000\",\n \"branch\": \"0001\",\n \"accountNumber\": \"123456-7\",\n \"accountType\": \"checking\",\n \"pixKey\": \"joao.silva@exemplo.com.br\",\n \"pixKeyType\": \"email\"\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/transfers/favorites", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "transfers", "favorites" ] }, "description": "Cria um favorito de beneficiário escopado a uma conta do parceiro. Obrigatórios: account_id e name. Escopo necessário: transfer:write." }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 403,\n \"message\": \"account does not belong to this partner\"\n }\n}" }, { "name": "404 Not Found - conta não encontrada", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": 1001,\n \"name\": \"Joao Silva\",\n \"document\": \"98765432100\",\n \"bankCode\": \"00000000\",\n \"branch\": \"0001\",\n \"accountNumber\": \"123456-7\",\n \"accountType\": \"checking\",\n \"pixKey\": \"joao.silva@exemplo.com.br\",\n \"pixKeyType\": \"email\"\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/transfers/favorites", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "transfers", "favorites" ] }, "description": "Cria um favorito de beneficiário escopado a uma conta do parceiro. Obrigatórios: account_id e name. Escopo necessário: transfer:write." }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 404,\n \"message\": \"account not found\"\n }\n}" } ] }, { "name": "Listar favoritos", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test(\"status 2xx\", function () {", " pm.expect(pm.response.code).to.be.within(200, 299);", "});" ] } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/transfers/favorites?account_id=1001", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "transfers", "favorites" ], "query": [ { "key": "account_id", "value": "1001", "description": "Id da conta do parceiro (obrigatório)" } ] }, "description": "Lista os favoritos de beneficiário escopados a uma conta do parceiro. Escopo necessário: transfer:read." }, "response": [ { "name": "200 OK - lista de favoritos", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/transfers/favorites?account_id=1001", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "transfers", "favorites" ], "query": [ { "key": "account_id", "value": "1001", "description": "Id da conta do parceiro (obrigatório)" } ] }, "description": "Lista os favoritos de beneficiário escopados a uma conta do parceiro. Escopo necessário: transfer:read." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"9d4f2c1a-7b3e-4c91-8a52-0f1e2d3c4b5a\",\n \"name\": \"João Silva\",\n \"document\": \"98765432100\",\n \"bankCode\": \"00000000\",\n \"branch\": \"0001\",\n \"accountNumber\": \"123456-7\",\n \"accountType\": \"checking\",\n \"pixKey\": \"joao.silva@exemplo.com.br\",\n \"pixKeyType\": \"email\",\n \"createdAt\": \"2026-06-27T12:00:00Z\"\n }\n ]\n}" }, { "name": "403 Forbidden - conta de outro parceiro", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/transfers/favorites?account_id=1001", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "transfers", "favorites" ], "query": [ { "key": "account_id", "value": "1001", "description": "Id da conta do parceiro (obrigatório)" } ] }, "description": "Lista os favoritos de beneficiário escopados a uma conta do parceiro. Escopo necessário: transfer:read." }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 403,\n \"message\": \"account does not belong to this partner\"\n }\n}" }, { "name": "404 Not Found - conta não encontrada", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/transfers/favorites?account_id=1001", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "transfers", "favorites" ], "query": [ { "key": "account_id", "value": "1001", "description": "Id da conta do parceiro (obrigatório)" } ] }, "description": "Lista os favoritos de beneficiário escopados a uma conta do parceiro. Escopo necessário: transfer:read." }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 404,\n \"message\": \"account not found\"\n }\n}" }, { "name": "401 Unauthorized - token ausente ou expirado", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/transfers/favorites?account_id=1001", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "transfers", "favorites" ], "query": [ { "key": "account_id", "value": "1001", "description": "Id da conta do parceiro (obrigatório)" } ] }, "description": "Lista os favoritos de beneficiário escopados a uma conta do parceiro. Escopo necessário: transfer:read." }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"message\": \"Invalid or expired partner access token\",\n \"status\": 401\n }\n}" } ] }, { "name": "Excluir favorito", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test(\"status 2xx\", function () {", " pm.expect(pm.response.code).to.be.within(200, 299);", "});" ] } } ], "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/transfers/favorites/9d4f2c1a-7b3e-4c91-8a52-0f1e2d3c4b5a?account_id=1001", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "transfers", "favorites", "9d4f2c1a-7b3e-4c91-8a52-0f1e2d3c4b5a" ], "query": [ { "key": "account_id", "value": "1001", "description": "Id da conta do parceiro (obrigatório)" } ], "variable": [ { "key": "id", "value": "9d4f2c1a-7b3e-4c91-8a52-0f1e2d3c4b5a", "description": "Id do favorito (UUID)" } ] }, "description": "Remove um favorito de beneficiário de uma conta do parceiro. O favorito é restrito ao escopo da conta. Escopo necessário: transfer:write." }, "response": [ { "name": "200 OK - favorito removido", "originalRequest": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/transfers/favorites/9d4f2c1a-7b3e-4c91-8a52-0f1e2d3c4b5a?account_id=1001", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "transfers", "favorites", "9d4f2c1a-7b3e-4c91-8a52-0f1e2d3c4b5a" ], "query": [ { "key": "account_id", "value": "1001", "description": "Id da conta do parceiro (obrigatório)" } ], "variable": [ { "key": "id", "value": "9d4f2c1a-7b3e-4c91-8a52-0f1e2d3c4b5a", "description": "Id do favorito (UUID)" } ] }, "description": "Remove um favorito de beneficiário de uma conta do parceiro. O favorito é restrito ao escopo da conta. Escopo necessário: transfer:write." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Favorito removido com sucesso\"\n}" }, { "name": "404 Not Found - favorito não encontrado", "originalRequest": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/transfers/favorites/9d4f2c1a-7b3e-4c91-8a52-0f1e2d3c4b5a?account_id=1001", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "transfers", "favorites", "9d4f2c1a-7b3e-4c91-8a52-0f1e2d3c4b5a" ], "query": [ { "key": "account_id", "value": "1001", "description": "Id da conta do parceiro (obrigatório)" } ], "variable": [ { "key": "id", "value": "9d4f2c1a-7b3e-4c91-8a52-0f1e2d3c4b5a", "description": "Id do favorito (UUID)" } ] }, "description": "Remove um favorito de beneficiário de uma conta do parceiro. O favorito é restrito ao escopo da conta. Escopo necessário: transfer:write." }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 404,\n \"message\": \"Favorito não encontrado\"\n }\n}" }, { "name": "403 Forbidden - conta de outro parceiro", "originalRequest": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/transfers/favorites/9d4f2c1a-7b3e-4c91-8a52-0f1e2d3c4b5a?account_id=1001", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "transfers", "favorites", "9d4f2c1a-7b3e-4c91-8a52-0f1e2d3c4b5a" ], "query": [ { "key": "account_id", "value": "1001", "description": "Id da conta do parceiro (obrigatório)" } ], "variable": [ { "key": "id", "value": "9d4f2c1a-7b3e-4c91-8a52-0f1e2d3c4b5a", "description": "Id do favorito (UUID)" } ] }, "description": "Remove um favorito de beneficiário de uma conta do parceiro. O favorito é restrito ao escopo da conta. Escopo necessário: transfer:write." }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 403,\n \"message\": \"account does not belong to this partner\"\n }\n}" }, { "name": "401 Unauthorized - token ausente ou expirado", "originalRequest": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/transfers/favorites/9d4f2c1a-7b3e-4c91-8a52-0f1e2d3c4b5a?account_id=1001", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "transfers", "favorites", "9d4f2c1a-7b3e-4c91-8a52-0f1e2d3c4b5a" ], "query": [ { "key": "account_id", "value": "1001", "description": "Id da conta do parceiro (obrigatório)" } ], "variable": [ { "key": "id", "value": "9d4f2c1a-7b3e-4c91-8a52-0f1e2d3c4b5a", "description": "Id do favorito (UUID)" } ] }, "description": "Remove um favorito de beneficiário de uma conta do parceiro. O favorito é restrito ao escopo da conta. Escopo necessário: transfer:write." }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"message\": \"Invalid or expired partner access token\",\n \"status\": 401\n }\n}" } ] }, { "name": "Listar TED recebidas", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/ted/credits?account_id=1001&status=", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "ted", "credits" ], "query": [ { "key": "account_id", "value": "1001", "description": "Conta do parceiro" }, { "key": "status", "value": "", "description": "Filtro opcional por status do crédito" } ] }, "description": "Lista as TED recebidas (créditos SPB) da conta informada, mais recentes primeiro (até 50). Valores em centavos. refundable fica true enquanto o crédito pode ser devolvido pelo cliente. Filtro opcional status. Resposta 200 com data.credits (id, numCtrlStr, amount, senderName, senderDocument, senderIspb, status, refundable, settlementDate, receivedAt) e data.total. Escopo transfer:read." } }, { "name": "Devolver TED recebida", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/ted/credits/CREDIT_ID/refund", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "ted", "credits", "CREDIT_ID", "refund" ] }, "body": { "mode": "raw", "raw": "{\n \"account_id\": 1001,\n \"reason\": \"70\"\n}" }, "description": "Comanda a devolução INTEGRAL de uma TED recebida ao remetente (STR0010); não há devolução parcial. reason é opcional (padrão 70) e restrito aos códigos 1, 2, 3, 4, 5, 9, 31, 70, 72 e 84. O valor fica reservado na conta até o desfecho, que chega pelos webhooks ted.refund.completed e ted.refund.failed. Resposta 202 com data (refundId, numCtrlStr, amount em centavos, status processing). Crédito de outra conta ou inexistente responde 404; devolução já em andamento, crédito já devolvido, motivo inválido ou saldo insuficiente respondem 422. Escopo transfer:write." } } ] }, { "name": "Tarifas", "description": "Catálogo de tarifas ativas e tarifas cobradas das contas do parceiro. Somente leitura: a gestão da tabela (valores e ativação) é feita pela Monetarie. Valores monetários em centavos. Escopo fee:read.", "item": [ { "name": "Catálogo de tarifas", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/fees", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "fees" ] }, "description": "Lista o catálogo de tarifas ativas. scope indica a abrangência da regra: global, customer ou account. Valores em centavos. Escopo fee:read." }, "response": [ { "name": "200 OK - catálogo de tarifas ativas", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/fees", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "fees" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"feeType\": \"ted_out\",\n \"clientType\": \"pf\",\n \"subType\": null,\n \"fixedAmount\": 500,\n \"percent\": \"0\",\n \"minAmount\": 100,\n \"maxAmount\": 900,\n \"chargingModel\": \"immediate\",\n \"freeTransactionsPerMonth\": 0,\n \"effectiveFrom\": \"2026-07-14\",\n \"effectiveUntil\": null,\n \"scope\": \"global\"\n }\n ]\n}" } ] }, { "name": "Tarifas cobradas", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/fees/charges?account_id=1001&from=2026-07-01&to=2026-07-14&page=1&per_page=50", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "fees", "charges" ], "query": [ { "key": "account_id", "value": "1001", "description": "Filtra por conta do parceiro" }, { "key": "origin_transaction_id", "value": "E4602656220260714210000aabbccdd0", "description": "Filtra pela transação que originou a tarifa", "disabled": true }, { "key": "from", "value": "2026-07-01", "description": "Data inicial opcional (ISO 8601)" }, { "key": "to", "value": "2026-07-14", "description": "Data final opcional (ISO 8601)" }, { "key": "page", "value": "1", "description": "Página (>= 1, padrão 1)" }, { "key": "per_page", "value": "50", "description": "Itens por página (máximo 200)" } ] }, "description": "Lista as tarifas cobradas das contas do parceiro, com correlação para a transação de origem. status é posted ou reversed. Valores em centavos. Escopo fee:read." }, "response": [ { "name": "200 OK - tarifas cobradas", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/fees/charges?account_id=1001&from=2026-07-01&to=2026-07-14&page=1&per_page=50", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "fees", "charges" ], "query": [ { "key": "account_id", "value": "1001" }, { "key": "from", "value": "2026-07-01" }, { "key": "to", "value": "2026-07-14" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "50" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"5f6a7b8c-9d0e-4f1a-8b2c-3d4e5f6a7b8c\",\n \"feeType\": \"pix_out_transfer\",\n \"amount\": 350,\n \"originTransactionId\": \"E4602656220260714210000aabbccdd0\",\n \"originTransactionType\": \"pix\",\n \"originAmount\": 10000,\n \"status\": \"posted\",\n \"accountId\": 1001,\n \"chargedAt\": \"2026-07-14T21:00:00Z\"\n }\n ]\n}" } ] } ] }, { "name": "Webhooks", "description": "Cadastro, listagem, atualização, rotação de segredo, teste, reenvio e catálogo de eventos de webhooks. Escopados às chaves do parceiro.", "item": [ { "name": "Catálogo de eventos", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test(\"status 2xx\", function () {", " pm.expect(pm.response.code).to.be.within(200, 299);", "});" ] } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/webhooks/events", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "webhooks", "events" ] }, "description": "Retorna o catálogo de nomes de eventos assináveis. Somente leitura, não vaza dado de parceiro. Escopo necessário: webhook:read." }, "response": [ { "name": "200 OK - catálogo de eventos", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/webhooks/events", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "webhooks", "events" ] }, "description": "Retorna o catálogo de nomes de eventos assináveis. Somente leitura, não vaza dado de parceiro. Escopo necessário: webhook:read." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"events\": [\n \"pix.charge.created\",\n \"pix.charge.paid\",\n \"pix.payout.queued\",\n \"pix.payout.processing\",\n \"pix.payout.confirmed\",\n \"pix.payout.failed\",\n \"pix.payout.returned\",\n \"pix.refund.requested\",\n \"pix.refund.completed\",\n \"pix.return.received\",\n \"pix.received\",\n \"pix.key.registered\",\n \"pix.key.deleted\",\n \"pix.key.blocked\",\n \"pix.key.unblocked\",\n \"pix.claim.created\",\n \"pix.claim.acknowledged\",\n \"pix.claim.confirmed\",\n \"pix.claim.cancelled\",\n \"pix.claim.completed\",\n \"pix.infraction.created\",\n \"pix.infraction.resolved\",\n \"ted.confirmed\",\n \"ted.failed\",\n \"ted.received\",\n \"transfer.confirmed\",\n \"transfer.failed\",\n \"transfer.received\",\n \"fee.charged\",\n \"account.created\",\n \"account.blocked\",\n \"account.unblocked\",\n \"account.closed\",\n \"webhook.test\"\n ]\n}" }, { "name": "401 Unauthorized - token ausente ou expirado", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/webhooks/events", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "webhooks", "events" ] }, "description": "Retorna o catálogo de nomes de eventos assináveis. Somente leitura, não vaza dado de parceiro. Escopo necessário: webhook:read." }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"message\": \"Invalid or expired partner access token\",\n \"status\": 401\n }\n}" }, { "name": "403 Forbidden - token sem escopo webhook:read", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/webhooks/events", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "webhooks", "events" ] }, "description": "Retorna o catálogo de nomes de eventos assináveis. Somente leitura, não vaza dado de parceiro. Escopo necessário: webhook:read." }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 403,\n \"message\": \"this endpoint requires a partner-scoped API key\"\n }\n}" } ] }, { "name": "Registrar webhook", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test(\"status 2xx\", function () {", " pm.expect(pm.response.code).to.be.within(200, 299);", "});" ] } } ], "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"https://sua-aplicacao.com.br/webhooks/monetarie\",\n \"events\": [\n \"pix.payout.confirmed\",\n \"pix.payout.failed\",\n \"pix.charge.paid\"\n ],\n \"description\": \"Integracao principal\",\n \"is_active\": true\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "webhooks" ] }, "description": "Registra um webhook vinculado à chave do parceiro. O segredo de assinatura é gerado pelo servidor, nunca enviado na requisição. A URL deve ser pública (HTTP ou HTTPS) e não pode apontar para endereços privados ou internos. Obrigatórios: url e events. Escopo necessário: webhook:write." }, "response": [ { "name": "201 Created - webhook registrado", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"https://webhooks.exemplo.com.br/monetarie\",\n \"events\": [\"pix.payout.confirmed\", \"pix.charge.paid\", \"transfer.completed\"],\n \"description\": \"Webhook de eventos de pagamento\",\n \"is_active\": true\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "webhooks" ] }, "description": "Registra um webhook vinculado à chave do parceiro. O segredo de assinatura é gerado pelo servidor, nunca enviado na requisição. A URL deve ser pública (HTTP ou HTTPS) e não pode apontar para endereços privados ou internos. Obrigatórios: url e events. Escopo necessário: webhook:write." }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f\",\n \"url\": \"https://webhooks.exemplo.com.br/monetarie\",\n \"events\": [\n \"pix.payout.confirmed\",\n \"pix.charge.paid\",\n \"transfer.completed\"\n ],\n \"description\": \"Webhook de eventos de pagamento\",\n \"is_active\": true,\n \"created_at\": \"2026-06-27T12:00:00Z\",\n \"updated_at\": \"2026-06-27T12:00:00Z\"\n }\n}" }, { "name": "422 Unprocessable Entity - atributos inválidos", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"https://webhooks.exemplo.com.br/monetarie\",\n \"events\": [\"pix.payout.confirmed\", \"pix.charge.paid\", \"transfer.completed\"],\n \"description\": \"Webhook de eventos de pagamento\",\n \"is_active\": true\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "webhooks" ] }, "description": "Registra um webhook vinculado à chave do parceiro. O segredo de assinatura é gerado pelo servidor, nunca enviado na requisição. A URL deve ser pública (HTTP ou HTTPS) e não pode apontar para endereços privados ou internos. Obrigatórios: url e events. Escopo necessário: webhook:write." }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"url\": [\n \"must not point to private/internal addresses\"\n ]\n }\n}" }, { "name": "403 Forbidden - chave não é de parceiro", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"https://webhooks.exemplo.com.br/monetarie\",\n \"events\": [\"pix.payout.confirmed\", \"pix.charge.paid\", \"transfer.completed\"],\n \"description\": \"Webhook de eventos de pagamento\",\n \"is_active\": true\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "webhooks" ] }, "description": "Registra um webhook vinculado à chave do parceiro. O segredo de assinatura é gerado pelo servidor, nunca enviado na requisição. A URL deve ser pública (HTTP ou HTTPS) e não pode apontar para endereços privados ou internos. Obrigatórios: url e events. Escopo necessário: webhook:write." }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 403,\n \"message\": \"this endpoint requires a partner-scoped API key\"\n }\n}" }, { "name": "401 Unauthorized - token ausente ou expirado", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"https://webhooks.exemplo.com.br/monetarie\",\n \"events\": [\"pix.payout.confirmed\", \"pix.charge.paid\", \"transfer.completed\"],\n \"description\": \"Webhook de eventos de pagamento\",\n \"is_active\": true\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "webhooks" ] }, "description": "Registra um webhook vinculado à chave do parceiro. O segredo de assinatura é gerado pelo servidor, nunca enviado na requisição. A URL deve ser pública (HTTP ou HTTPS) e não pode apontar para endereços privados ou internos. Obrigatórios: url e events. Escopo necessário: webhook:write." }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"message\": \"Invalid or expired partner access token\",\n \"status\": 401\n }\n}" } ] }, { "name": "Listar webhooks", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test(\"status 2xx\", function () {", " pm.expect(pm.response.code).to.be.within(200, 299);", "});" ] } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "webhooks" ] }, "description": "Lista os webhooks vinculados às chaves do parceiro. Escopo necessário: webhook:read." }, "response": [ { "name": "200 OK - webhooks do parceiro", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "webhooks" ] }, "description": "Lista os webhooks vinculados às chaves do parceiro. Escopo necessário: webhook:read." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f\",\n \"url\": \"https://webhooks.exemplo.com.br/monetarie\",\n \"events\": [\n \"pix.payout.confirmed\",\n \"pix.charge.paid\",\n \"transfer.completed\"\n ],\n \"description\": \"Webhook de eventos de pagamento\",\n \"is_active\": true,\n \"created_at\": \"2026-06-27T12:00:00Z\",\n \"updated_at\": \"2026-06-27T12:00:00Z\"\n }\n ]\n}" }, { "name": "401 Unauthorized - token ausente ou expirado", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "webhooks" ] }, "description": "Lista os webhooks vinculados às chaves do parceiro. Escopo necessário: webhook:read." }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"message\": \"Invalid or expired partner access token\",\n \"status\": 401\n }\n}" }, { "name": "403 Forbidden - chave não é de parceiro", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "webhooks" ] }, "description": "Lista os webhooks vinculados às chaves do parceiro. Escopo necessário: webhook:read." }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 403,\n \"message\": \"this endpoint requires a partner-scoped API key\"\n }\n}" } ] }, { "name": "Detalhar webhook", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test(\"status 2xx\", function () {", " pm.expect(pm.response.code).to.be.within(200, 299);", "});" ] } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/webhooks/7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "webhooks", "7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f" ], "variable": [ { "key": "id", "value": "7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f", "description": "Id do webhook (UUID)" } ] }, "description": "Retorna um webhook, escopado ao parceiro. Id de outro parceiro retorna 403, id desconhecido retorna 404. Escopo necessário: webhook:read." }, "response": [ { "name": "200 OK - webhook", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/webhooks/7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "webhooks", "7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f" ], "variable": [ { "key": "id", "value": "7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f", "description": "Id do webhook (UUID)" } ] }, "description": "Retorna um webhook, escopado ao parceiro. Id de outro parceiro retorna 403, id desconhecido retorna 404. Escopo necessário: webhook:read." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f\",\n \"url\": \"https://webhooks.exemplo.com.br/monetarie\",\n \"events\": [\n \"pix.payout.confirmed\",\n \"pix.charge.paid\",\n \"transfer.completed\"\n ],\n \"description\": \"Webhook de eventos de pagamento\",\n \"is_active\": true,\n \"created_at\": \"2026-06-27T12:00:00Z\",\n \"updated_at\": \"2026-06-27T12:00:00Z\"\n }\n}" }, { "name": "403 Forbidden - webhook de outro parceiro", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/webhooks/7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "webhooks", "7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f" ], "variable": [ { "key": "id", "value": "7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f", "description": "Id do webhook (UUID)" } ] }, "description": "Retorna um webhook, escopado ao parceiro. Id de outro parceiro retorna 403, id desconhecido retorna 404. Escopo necessário: webhook:read." }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 403,\n \"message\": \"webhook não pertence a este parceiro\"\n }\n}" }, { "name": "404 Not Found - webhook não encontrado", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/webhooks/7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "webhooks", "7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f" ], "variable": [ { "key": "id", "value": "7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f", "description": "Id do webhook (UUID)" } ] }, "description": "Retorna um webhook, escopado ao parceiro. Id de outro parceiro retorna 403, id desconhecido retorna 404. Escopo necessário: webhook:read." }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 404,\n \"message\": \"webhook não encontrado\"\n }\n}" }, { "name": "401 Unauthorized - token ausente ou expirado", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/webhooks/7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "webhooks", "7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f" ], "variable": [ { "key": "id", "value": "7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f", "description": "Id do webhook (UUID)" } ] }, "description": "Retorna um webhook, escopado ao parceiro. Id de outro parceiro retorna 403, id desconhecido retorna 404. Escopo necessário: webhook:read." }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"message\": \"Invalid or expired partner access token\",\n \"status\": 401\n }\n}" } ] }, { "name": "Atualizar webhook", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test(\"status 2xx\", function () {", " pm.expect(pm.response.code).to.be.within(200, 299);", "});" ] } } ], "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"https://webhooks.exemplo.com.br/monetarie-v2\",\n \"events\": [\"pix.payout.confirmed\", \"pix.payout.failed\"],\n \"description\": \"Webhook atualizado\",\n \"is_active\": true\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/webhooks/7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "webhooks", "7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f" ], "variable": [ { "key": "id", "value": "7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f", "description": "Id do webhook (UUID)" } ] }, "description": "Atualiza um webhook escopado ao parceiro. Apenas url, events, description e is_active são aceitos. Aceita PUT ou PATCH. Escopo necessário: webhook:write." }, "response": [ { "name": "200 OK - webhook atualizado", "originalRequest": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"https://webhooks.exemplo.com.br/monetarie-v2\",\n \"events\": [\"pix.payout.confirmed\", \"pix.payout.failed\"],\n \"description\": \"Webhook atualizado\",\n \"is_active\": true\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/webhooks/7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "webhooks", "7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f" ], "variable": [ { "key": "id", "value": "7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f", "description": "Id do webhook (UUID)" } ] }, "description": "Atualiza um webhook escopado ao parceiro. Apenas url, events, description e is_active são aceitos. Aceita PUT ou PATCH. Escopo necessário: webhook:write." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f\",\n \"url\": \"https://webhooks.exemplo.com.br/monetarie-v2\",\n \"events\": [\n \"pix.payout.confirmed\",\n \"pix.payout.failed\"\n ],\n \"description\": \"Webhook atualizado\",\n \"is_active\": true,\n \"created_at\": \"2026-06-27T12:00:00Z\",\n \"updated_at\": \"2026-06-27T13:00:00Z\"\n }\n}" }, { "name": "422 Unprocessable Entity - atributos inválidos", "originalRequest": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"https://webhooks.exemplo.com.br/monetarie-v2\",\n \"events\": [\"pix.payout.confirmed\", \"pix.payout.failed\"],\n \"description\": \"Webhook atualizado\",\n \"is_active\": true\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/webhooks/7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "webhooks", "7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f" ], "variable": [ { "key": "id", "value": "7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f", "description": "Id do webhook (UUID)" } ] }, "description": "Atualiza um webhook escopado ao parceiro. Apenas url, events, description e is_active são aceitos. Aceita PUT ou PATCH. Escopo necessário: webhook:write." }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"events\": [\n \"unknown event: pix.foo.bar\"\n ]\n }\n}" }, { "name": "403 Forbidden - webhook de outro parceiro", "originalRequest": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"https://webhooks.exemplo.com.br/monetarie-v2\",\n \"events\": [\"pix.payout.confirmed\", \"pix.payout.failed\"],\n \"description\": \"Webhook atualizado\",\n \"is_active\": true\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/webhooks/7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "webhooks", "7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f" ], "variable": [ { "key": "id", "value": "7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f", "description": "Id do webhook (UUID)" } ] }, "description": "Atualiza um webhook escopado ao parceiro. Apenas url, events, description e is_active são aceitos. Aceita PUT ou PATCH. Escopo necessário: webhook:write." }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 403,\n \"message\": \"webhook não pertence a este parceiro\"\n }\n}" }, { "name": "404 Not Found - webhook não encontrado", "originalRequest": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"https://webhooks.exemplo.com.br/monetarie-v2\",\n \"events\": [\"pix.payout.confirmed\", \"pix.payout.failed\"],\n \"description\": \"Webhook atualizado\",\n \"is_active\": true\n}" }, "url": { "raw": "{{baseUrl}}/api/partner/v1/webhooks/7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "webhooks", "7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f" ], "variable": [ { "key": "id", "value": "7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f", "description": "Id do webhook (UUID)" } ] }, "description": "Atualiza um webhook escopado ao parceiro. Apenas url, events, description e is_active são aceitos. Aceita PUT ou PATCH. Escopo necessário: webhook:write." }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 404,\n \"message\": \"webhook não encontrado\"\n }\n}" } ] }, { "name": "Excluir webhook", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test(\"status 2xx\", function () {", " pm.expect(pm.response.code).to.be.within(200, 299);", "});" ] } } ], "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/webhooks/7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "webhooks", "7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f" ], "variable": [ { "key": "id", "value": "7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f", "description": "Id do webhook (UUID)" } ] }, "description": "Revoga um webhook escopado ao parceiro. Retorna 204 sem conteúdo. Escopo necessário: webhook:write." }, "response": [ { "name": "204 No Content - webhook revogado", "originalRequest": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/webhooks/7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "webhooks", "7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f" ], "variable": [ { "key": "id", "value": "7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f", "description": "Id do webhook (UUID)" } ] }, "description": "Revoga um webhook escopado ao parceiro. Retorna 204 sem conteúdo. Escopo necessário: webhook:write." }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "body": "" }, { "name": "403 Forbidden - webhook de outro parceiro", "originalRequest": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/webhooks/7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "webhooks", "7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f" ], "variable": [ { "key": "id", "value": "7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f", "description": "Id do webhook (UUID)" } ] }, "description": "Revoga um webhook escopado ao parceiro. Retorna 204 sem conteúdo. Escopo necessário: webhook:write." }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 403,\n \"message\": \"webhook não pertence a este parceiro\"\n }\n}" }, { "name": "404 Not Found - webhook não encontrado", "originalRequest": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/webhooks/7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "webhooks", "7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f" ], "variable": [ { "key": "id", "value": "7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f", "description": "Id do webhook (UUID)" } ] }, "description": "Revoga um webhook escopado ao parceiro. Retorna 204 sem conteúdo. Escopo necessário: webhook:write." }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 404,\n \"message\": \"webhook não encontrado\"\n }\n}" }, { "name": "401 Unauthorized - token ausente ou expirado", "originalRequest": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/webhooks/7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "webhooks", "7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f" ], "variable": [ { "key": "id", "value": "7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f", "description": "Id do webhook (UUID)" } ] }, "description": "Revoga um webhook escopado ao parceiro. Retorna 204 sem conteúdo. Escopo necessário: webhook:write." }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"message\": \"Invalid or expired partner access token\",\n \"status\": 401\n }\n}" } ] }, { "name": "Rotacionar segredo", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test(\"status 2xx\", function () {", " pm.expect(pm.response.code).to.be.within(200, 299);", "});" ] } } ], "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/webhooks/7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f/rotate-secret", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "webhooks", "7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f", "rotate-secret" ], "variable": [ { "key": "id", "value": "7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f", "description": "Id do webhook (UUID)" } ] }, "description": "Rotaciona o segredo de assinatura e retorna o novo segredo uma única vez. Ele não pode ser recuperado depois. Escopo necessário: webhook:write." }, "response": [ { "name": "200 OK - segredo rotacionado", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/webhooks/7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f/rotate-secret", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "webhooks", "7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f", "rotate-secret" ], "variable": [ { "key": "id", "value": "7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f", "description": "Id do webhook (UUID)" } ] }, "description": "Rotaciona o segredo de assinatura e retorna o novo segredo uma única vez. Ele não pode ser recuperado depois. Escopo necessário: webhook:write." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Secret rotacionado com sucesso\",\n \"new_secret\": \"whsec_9f8e7d6c5b4a3210fedcba9876543210abcdef0123456789\",\n \"webhook_id\": \"7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f\"\n}" }, { "name": "403 Forbidden - webhook de outro parceiro", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/webhooks/7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f/rotate-secret", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "webhooks", "7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f", "rotate-secret" ], "variable": [ { "key": "id", "value": "7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f", "description": "Id do webhook (UUID)" } ] }, "description": "Rotaciona o segredo de assinatura e retorna o novo segredo uma única vez. Ele não pode ser recuperado depois. Escopo necessário: webhook:write." }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 403,\n \"message\": \"webhook não pertence a este parceiro\"\n }\n}" }, { "name": "404 Not Found - webhook não encontrado", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/webhooks/7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f/rotate-secret", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "webhooks", "7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f", "rotate-secret" ], "variable": [ { "key": "id", "value": "7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f", "description": "Id do webhook (UUID)" } ] }, "description": "Rotaciona o segredo de assinatura e retorna o novo segredo uma única vez. Ele não pode ser recuperado depois. Escopo necessário: webhook:write." }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 404,\n \"message\": \"webhook não encontrado\"\n }\n}" }, { "name": "401 Unauthorized - token ausente ou expirado", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/webhooks/7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f/rotate-secret", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "webhooks", "7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f", "rotate-secret" ], "variable": [ { "key": "id", "value": "7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f", "description": "Id do webhook (UUID)" } ] }, "description": "Rotaciona o segredo de assinatura e retorna o novo segredo uma única vez. Ele não pode ser recuperado depois. Escopo necessário: webhook:write." }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"message\": \"Invalid or expired partner access token\",\n \"status\": 401\n }\n}" } ] }, { "name": "Testar webhook", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test(\"status 2xx\", function () {", " pm.expect(pm.response.code).to.be.within(200, 299);", "});" ] } } ], "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/webhooks/7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f/test", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "webhooks", "7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f", "test" ], "variable": [ { "key": "id", "value": "7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f", "description": "Id do webhook (UUID)" } ] }, "description": "Dispara uma entrega de teste (evento webhook.test) para o webhook do parceiro. Escopo necessário: webhook:write." }, "response": [ { "name": "200 OK - evento de teste enviado", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/webhooks/7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f/test", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "webhooks", "7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f", "test" ], "variable": [ { "key": "id", "value": "7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f", "description": "Id do webhook (UUID)" } ] }, "description": "Dispara uma entrega de teste (evento webhook.test) para o webhook do parceiro. Escopo necessário: webhook:write." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Evento de teste enviado\"\n}" }, { "name": "403 Forbidden - webhook de outro parceiro", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/webhooks/7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f/test", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "webhooks", "7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f", "test" ], "variable": [ { "key": "id", "value": "7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f", "description": "Id do webhook (UUID)" } ] }, "description": "Dispara uma entrega de teste (evento webhook.test) para o webhook do parceiro. Escopo necessário: webhook:write." }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 403,\n \"message\": \"webhook não pertence a este parceiro\"\n }\n}" }, { "name": "404 Not Found - webhook não encontrado", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/webhooks/7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f/test", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "webhooks", "7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f", "test" ], "variable": [ { "key": "id", "value": "7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f", "description": "Id do webhook (UUID)" } ] }, "description": "Dispara uma entrega de teste (evento webhook.test) para o webhook do parceiro. Escopo necessário: webhook:write." }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 404,\n \"message\": \"webhook não encontrado\"\n }\n}" }, { "name": "401 Unauthorized - token ausente ou expirado", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/webhooks/7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f/test", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "webhooks", "7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f", "test" ], "variable": [ { "key": "id", "value": "7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f", "description": "Id do webhook (UUID)" } ] }, "description": "Dispara uma entrega de teste (evento webhook.test) para o webhook do parceiro. Escopo necessário: webhook:write." }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"message\": \"Invalid or expired partner access token\",\n \"status\": 401\n }\n}" } ] }, { "name": "Reenviar webhook", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test(\"status 2xx\", function () {", " pm.expect(pm.response.code).to.be.within(200, 299);", "});" ] } } ], "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/webhooks/7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f/replay", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "webhooks", "7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f", "replay" ], "variable": [ { "key": "id", "value": "7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f", "description": "Id do webhook (UUID)" } ] }, "description": "Reenvia a entrega mais recente do webhook do parceiro. Sem entregas para reenviar retorna 404. Escopo necessário: webhook:write." }, "response": [ { "name": "200 OK - delivery reenviado", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/webhooks/7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f/replay", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "webhooks", "7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f", "replay" ], "variable": [ { "key": "id", "value": "7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f", "description": "Id do webhook (UUID)" } ] }, "description": "Reenvia a entrega mais recente do webhook do parceiro. Sem entregas para reenviar retorna 404. Escopo necessário: webhook:write." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Delivery reenviado\"\n}" }, { "name": "404 Not Found - nenhuma entrega para reenviar", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/webhooks/7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f/replay", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "webhooks", "7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f", "replay" ], "variable": [ { "key": "id", "value": "7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f", "description": "Id do webhook (UUID)" } ] }, "description": "Reenvia a entrega mais recente do webhook do parceiro. Sem entregas para reenviar retorna 404. Escopo necessário: webhook:write." }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 404,\n \"message\": \"nenhuma entrega para reenviar\"\n }\n}" }, { "name": "403 Forbidden - webhook de outro parceiro", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/webhooks/7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f/replay", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "webhooks", "7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f", "replay" ], "variable": [ { "key": "id", "value": "7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f", "description": "Id do webhook (UUID)" } ] }, "description": "Reenvia a entrega mais recente do webhook do parceiro. Sem entregas para reenviar retorna 404. Escopo necessário: webhook:write." }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"status\": 403,\n \"message\": \"webhook não pertence a este parceiro\"\n }\n}" }, { "name": "401 Unauthorized - token ausente ou expirado", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/partner/v1/webhooks/7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f/replay", "host": [ "{{baseUrl}}" ], "path": [ "api", "partner", "v1", "webhooks", "7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f", "replay" ], "variable": [ { "key": "id", "value": "7f1e2d3c-4b5a-6c97-8d12-0a1b2c3d4e5f", "description": "Id do webhook (UUID)" } ] }, "description": "Reenvia a entrega mais recente do webhook do parceiro. Sem entregas para reenviar retorna 404. Escopo necessário: webhook:write." }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"message\": \"Invalid or expired partner access token\",\n \"status\": 401\n }\n}" } ] } ] }, { "name": "Webhooks (exemplos de payload)", "description": "Corpos que a plataforma ENTREGA no seu endpoint (nao sao chamadas a API). Chaves em camelCase, valores em centavos. Aponte {{webhook_receiver_url}} para a sua URL. O tipo do evento e o id de entrega vao nos headers X-Monetarie-*.", "item": [ { "name": "PIX de saida (pix.payout.confirmed)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Monetarie-Event-Type", "value": "pix.payout.confirmed" }, { "key": "X-Monetarie-Event-Id", "value": "{{$guid}}" }, { "key": "X-Monetarie-Timestamp", "value": "1783000000" }, { "key": "X-Monetarie-Signature", "value": "sha256=" } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": 1042,\n \"transactionId\": \"PIX20260711a1b2c3d4e5f6\",\n \"endToEndId\": \"E4602656220260711100000abcdef123\",\n \"amount\": 25000,\n \"status\": \"settled\",\n \"errorReason\": null,\n \"recipient\": {\n \"key\": \"destino@exemplo.com.br\",\n \"name\": \"MARIA OLIVEIRA\",\n \"document\": \"12345678901\",\n \"ispb\": \"60746948\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhook_receiver_url}}", "host": [ "{{webhook_receiver_url}}" ] }, "description": "Desfecho de sucesso de um PIX enviado (corpo entregue no seu webhook, camelCase). recipient identifica a contraparte quando disponível. Valores em centavos." }, "response": [] }, { "name": "PIX de saida enfileirado (pix.payout.queued)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Monetarie-Event-Type", "value": "pix.payout.queued" }, { "key": "X-Monetarie-Event-Id", "value": "{{$guid}}" }, { "key": "X-Monetarie-Timestamp", "value": "1783000000" }, { "key": "X-Monetarie-Signature", "value": "sha256=" } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": 1042,\n \"transactionId\": \"PIXOUT20260718a1b2c3d4e5f6a7b8c9d0\",\n \"endToEndId\": \"E4602656220260718100000abcdef123\",\n \"amount\": 25000,\n \"status\": \"queued\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhook_receiver_url}}", "host": [ "{{webhook_receiver_url}}" ] }, "description": "PIX de saída aceito e enfileirado para processamento. Formato mais enxuto que os demais eventos de payout: ainda não há desfecho nem contraparte. Valores em centavos." }, "response": [] }, { "name": "PIX de saida em processamento (pix.payout.processing)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Monetarie-Event-Type", "value": "pix.payout.processing" }, { "key": "X-Monetarie-Event-Id", "value": "{{$guid}}" }, { "key": "X-Monetarie-Timestamp", "value": "1783000000" }, { "key": "X-Monetarie-Signature", "value": "sha256=" } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": 1042,\n \"transactionId\": \"PIXOUT20260718a1b2c3d4e5f6a7b8c9d0\",\n \"endToEndId\": \"E4602656220260718100000abcdef123\",\n \"amount\": 25000,\n \"status\": \"processing\",\n \"errorReason\": null,\n \"recipient\": {\n \"key\": \"destino@exemplo.com.br\",\n \"name\": \"MARIA OLIVEIRA\",\n \"document\": \"12345678901\",\n \"ispb\": \"60746948\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhook_receiver_url}}", "host": [ "{{webhook_receiver_url}}" ] }, "description": "PIX de saída em processamento na liquidação. recipient identifica a contraparte quando disponível; é nulo quando ainda não resolvida. Valores em centavos." }, "response": [] }, { "name": "PIX de saida rejeitado (pix.payout.failed)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Monetarie-Event-Type", "value": "pix.payout.failed" }, { "key": "X-Monetarie-Event-Id", "value": "{{$guid}}" }, { "key": "X-Monetarie-Timestamp", "value": "1783000000" }, { "key": "X-Monetarie-Signature", "value": "sha256=" } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": 1042,\n \"transactionId\": \"PIXOUT20260718a1b2c3d4e5f6a7b8c9d0\",\n \"endToEndId\": \"E4602656220260718100000abcdef123\",\n \"amount\": 25000,\n \"status\": \"rejected\",\n \"errorReason\": \"AB09: transação recusada pela instituição recebedora\",\n \"recipient\": {\n \"key\": \"destino@exemplo.com.br\",\n \"name\": \"MARIA OLIVEIRA\",\n \"document\": \"12345678901\",\n \"ispb\": \"60746948\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhook_receiver_url}}", "host": [ "{{webhook_receiver_url}}" ] }, "description": "Desfecho de falha de um PIX enviado. status é rejected na recusa e timeout quando não há resposta no prazo; errorReason traz o motivo real. Valores em centavos." }, "response": [] }, { "name": "PIX de saida devolvido (pix.payout.returned)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Monetarie-Event-Type", "value": "pix.payout.returned" }, { "key": "X-Monetarie-Event-Id", "value": "{{$guid}}" }, { "key": "X-Monetarie-Timestamp", "value": "1783000000" }, { "key": "X-Monetarie-Signature", "value": "sha256=" } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": 1042,\n \"transactionId\": \"PIXOUT20260718a1b2c3d4e5f6a7b8c9d0\",\n \"endToEndId\": \"E4602656220260718100000abcdef123\",\n \"returnId\": \"D46026562202607181015aabbccddeef\",\n \"amount\": 25000,\n \"reason\": \"Devolução solicitada pelo pagador\",\n \"status\": \"returned\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhook_receiver_url}}", "host": [ "{{webhook_receiver_url}}" ] }, "description": "Um PIX que você ENVIOU foi devolvido pelo recebedor. returnId é o identificador da devolução no arranjo PIX; amount é o valor devolvido, que pode ser parcial. Valores em centavos." }, "response": [] }, { "name": "Devolucao solicitada (pix.refund.requested)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Monetarie-Event-Type", "value": "pix.refund.requested" }, { "key": "X-Monetarie-Event-Id", "value": "{{$guid}}" }, { "key": "X-Monetarie-Timestamp", "value": "1783000000" }, { "key": "X-Monetarie-Signature", "value": "sha256=" } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": 1042,\n \"transactionId\": \"PIXRET20260718b1c2d3e4f5a6\",\n \"endToEndId\": \"PIXIN20260718abc123\",\n \"amount\": 5000,\n \"status\": \"requested\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhook_receiver_url}}", "host": [ "{{webhook_receiver_url}}" ] }, "description": "Aceite da devolução de um PIX recebido que você solicitou. transactionId identifica a devolução (o refundId da resposta 202); endToEndId carrega o identificador da transação original devolvida. Valores em centavos." }, "response": [] }, { "name": "Devolucao concluida (pix.refund.completed)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Monetarie-Event-Type", "value": "pix.refund.completed" }, { "key": "X-Monetarie-Event-Id", "value": "{{$guid}}" }, { "key": "X-Monetarie-Timestamp", "value": "1783000000" }, { "key": "X-Monetarie-Signature", "value": "sha256=" } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": 1042,\n \"transactionId\": \"PIXRET20260718b1c2d3e4f5a6\",\n \"endToEndId\": null,\n \"amount\": 5000,\n \"status\": \"settled\",\n \"errorReason\": null,\n \"recipient\": null\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhook_receiver_url}}", "host": [ "{{webhook_receiver_url}}" ] }, "description": "A devolução de um PIX recebido liquidou. Correlacione pela chave transactionId, que é o refundId da resposta 202; endToEndId pode vir nulo. recipient identifica a contraparte quando disponível. Valores em centavos." }, "response": [] }, { "name": "Devolucao rejeitada (pix.refund.failed)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Monetarie-Event-Type", "value": "pix.refund.failed" }, { "key": "X-Monetarie-Event-Id", "value": "{{$guid}}" }, { "key": "X-Monetarie-Timestamp", "value": "1783000000" }, { "key": "X-Monetarie-Signature", "value": "sha256=" } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": 1042,\n \"transactionId\": \"PIXRET20260718b1c2d3e4f5a6\",\n \"endToEndId\": null,\n \"amount\": 5000,\n \"status\": \"rejected\",\n \"errorReason\": \"Devolução rejeitada pela instituição do pagador original\",\n \"recipient\": null\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhook_receiver_url}}", "host": [ "{{webhook_receiver_url}}" ] }, "description": "A devolução de um PIX recebido foi rejeitada; o valor permanece na conta e volta a compor o restante devolvível. Correlacione pela chave transactionId, que é o refundId da resposta 202; endToEndId pode vir nulo. errorReason traz o motivo real. Valores em centavos." }, "response": [] }, { "name": "PIX recebido (pix.charge.paid)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Monetarie-Event-Type", "value": "pix.charge.paid" }, { "key": "X-Monetarie-Event-Id", "value": "{{$guid}}" }, { "key": "X-Monetarie-Timestamp", "value": "1783000000" }, { "key": "X-Monetarie-Signature", "value": "sha256=" } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": 1042,\n \"entityId\": 987,\n \"txId\": \"monetarie-7f3a1c9e4b\",\n \"externalId\": \"pedido-4210\",\n \"endToEndId\": \"E4602656220260711100500aa00bb11c\",\n \"amount\": 15000,\n \"description\": \"Pedido 4210\",\n \"paidAt\": \"2026-07-11T10:05:00Z\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhook_receiver_url}}", "host": [ "{{webhook_receiver_url}}" ] }, "description": "Confirmação do pagamento de uma cobrança sua. Correlacione pelo txId da cobrança e pelo externalId, quando informado na criação. Valores em centavos." }, "response": [] }, { "name": "Cobranca criada (pix.charge.created)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Monetarie-Event-Type", "value": "pix.charge.created" }, { "key": "X-Monetarie-Event-Id", "value": "{{$guid}}" }, { "key": "X-Monetarie-Timestamp", "value": "1783000000" }, { "key": "X-Monetarie-Signature", "value": "sha256=" } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": 1042,\n \"txId\": \"monetarie-7f3a1c9e4b\",\n \"amount\": 15000,\n \"status\": \"active\",\n \"brcode\": \"00020101021226880014br.gov.bcb.pix...6304AB12\",\n \"expiresAt\": \"2026-07-11T11:00:00Z\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhook_receiver_url}}", "host": [ "{{webhook_receiver_url}}" ] }, "description": "Confirmacao de criacao de cobranca ou QR, com o BR Code pronto em brcode." }, "response": [] }, { "name": "Devolucao recebida (pix.return.received)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Monetarie-Event-Type", "value": "pix.return.received" }, { "key": "X-Monetarie-Event-Id", "value": "{{$guid}}" }, { "key": "X-Monetarie-Timestamp", "value": "1783000000" }, { "key": "X-Monetarie-Signature", "value": "sha256=" } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": 1042,\n \"endToEndId\": \"E4602656220260710090000ffee00112\",\n \"amount\": 12000,\n \"originalAmount\": 25000,\n \"refundedAmount\": 12000,\n \"isPartial\": true,\n \"returnReason\": \"MD06\",\n \"status\": \"settled\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhook_receiver_url}}", "host": [ "{{webhook_receiver_url}}" ] }, "description": "Devolucao caiu na conta. Pode ser parcial (isPartial)." }, "response": [] }, { "name": "TED (ted.confirmed)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Monetarie-Event-Type", "value": "ted.confirmed" }, { "key": "X-Monetarie-Event-Id", "value": "{{$guid}}" }, { "key": "X-Monetarie-Timestamp", "value": "1783000000" }, { "key": "X-Monetarie-Signature", "value": "sha256=" } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": 1042,\n \"transactionId\": \"TED20260711d8a3695bc594e2577c23\",\n \"type\": \"ted\",\n \"amount\": 25000,\n \"status\": \"settled\",\n \"errorReason\": null\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhook_receiver_url}}", "host": [ "{{webhook_receiver_url}}" ] }, "description": "Desfecho de uma TED enviada. status settled no confirmed; rejected ou timeout no ted.failed." }, "response": [] }, { "name": "TED rejeitada (ted.failed)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Monetarie-Event-Type", "value": "ted.failed" }, { "key": "X-Monetarie-Event-Id", "value": "{{$guid}}" }, { "key": "X-Monetarie-Timestamp", "value": "1783000000" }, { "key": "X-Monetarie-Signature", "value": "sha256=" } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": 1042,\n \"transactionId\": \"TED20260711d8a3695bc594e2577c23\",\n \"type\": \"ted\",\n \"amount\": 25000,\n \"status\": \"rejected\",\n \"errorReason\": \"Transferência recusada pela instituição destinatária\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhook_receiver_url}}", "host": [ "{{webhook_receiver_url}}" ] }, "description": "Desfecho de falha de uma TED enviada. status é rejected na recusa e timeout quando não há resposta no prazo. Uma TED agendada rejeitada na abertura da grade traz também scheduledTedId e settlementDate. Valores em centavos." }, "response": [] }, { "name": "Devolucao de TED solicitada (ted.refund.requested)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Monetarie-Event-Type", "value": "ted.refund.requested" }, { "key": "X-Monetarie-Event-Id", "value": "{{$guid}}" }, { "key": "X-Monetarie-Timestamp", "value": "1783000000" }, { "key": "X-Monetarie-Signature", "value": "sha256=" } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": 10024270,\n \"amount\": 150075,\n \"numCtrlStr\": \"STR20260714000000123\",\n \"reasonCode\": \"70\",\n \"status\": \"processing\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhook_receiver_url}}", "host": [ "{{webhook_receiver_url}}" ] }, "description": "Aceite da devolução de uma TED recebida que você comandou. Correlacione pelo numCtrlStr do crédito original. Valores em centavos." }, "response": [] }, { "name": "Devolucao de TED concluida (ted.refund.completed)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Monetarie-Event-Type", "value": "ted.refund.completed" }, { "key": "X-Monetarie-Event-Id", "value": "{{$guid}}" }, { "key": "X-Monetarie-Timestamp", "value": "1783000000" }, { "key": "X-Monetarie-Signature", "value": "sha256=" } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": 10024270,\n \"amount\": 150075,\n \"numCtrlStr\": \"STR20260714000000123\",\n \"reasonCode\": \"70\",\n \"spbNumCtrl\": \"MON20260718000000456\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhook_receiver_url}}", "host": [ "{{webhook_receiver_url}}" ] }, "description": "Devolução da TED liquidada no SPB: o valor saiu da conta e voltou ao remetente. spbNumCtrl é o número de controle da mensagem de devolução (STR0010). Esta entrega não repete o campo status." }, "response": [] }, { "name": "Devolucao de TED rejeitada (ted.refund.failed)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Monetarie-Event-Type", "value": "ted.refund.failed" }, { "key": "X-Monetarie-Event-Id", "value": "{{$guid}}" }, { "key": "X-Monetarie-Timestamp", "value": "1783000000" }, { "key": "X-Monetarie-Signature", "value": "sha256=" } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": 10024270,\n \"amount\": 150075,\n \"numCtrlStr\": \"STR20260714000000123\",\n \"reasonCode\": \"70\",\n \"errorCode\": \"send_failed\",\n \"errorMessage\": \"Falha no envio da devolução ao SPB\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhook_receiver_url}}", "host": [ "{{webhook_receiver_url}}" ] }, "description": "A devolução da TED não foi concluída e o valor reservado voltou a ficar disponível na conta. errorCode e errorMessage trazem o motivo reportado pelo SPB." }, "response": [] }, { "name": "Transferencia interna (transfer.confirmed)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Monetarie-Event-Type", "value": "transfer.confirmed" }, { "key": "X-Monetarie-Event-Id", "value": "{{$guid}}" }, { "key": "X-Monetarie-Timestamp", "value": "1783000000" }, { "key": "X-Monetarie-Signature", "value": "sha256=" } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": 1042,\n \"destinationAccountId\": 1043,\n \"transactionId\": \"TEF20260711aabbccddeeff\",\n \"type\": \"internal\",\n \"amount\": 5000,\n \"status\": \"settled\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhook_receiver_url}}", "host": [ "{{webhook_receiver_url}}" ] }, "description": "Desfecho de transferencia entre duas contas do parceiro." }, "response": [] }, { "name": "Transferencia interna com falha (transfer.failed)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Monetarie-Event-Type", "value": "transfer.failed" }, { "key": "X-Monetarie-Event-Id", "value": "{{$guid}}" }, { "key": "X-Monetarie-Timestamp", "value": "1783000000" }, { "key": "X-Monetarie-Signature", "value": "sha256=" } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": 1042,\n \"destinationAccountId\": 1043,\n \"transactionId\": \"TEF20260718aa11bb22cc33\",\n \"type\": \"internal\",\n \"amount\": 10000,\n \"status\": \"failed\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhook_receiver_url}}", "host": [ "{{webhook_receiver_url}}" ] }, "description": "A transferência interna entre contas do parceiro não foi concluída; nenhum valor foi movimentado. accountId é a conta de origem e destinationAccountId a de destino. Valores em centavos." }, "response": [] }, { "name": "Infracao MED (pix.infraction.created)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Monetarie-Event-Type", "value": "pix.infraction.created" }, { "key": "X-Monetarie-Event-Id", "value": "{{$guid}}" }, { "key": "X-Monetarie-Timestamp", "value": "1783000000" }, { "key": "X-Monetarie-Signature", "value": "sha256=" } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": 1042,\n \"infractionId\": \"b17c9a02-4a2f-4d5e-9b1a-77e0a1c2d3e4\",\n \"blockId\": \"3f21aa8c-1b2c-4d5e-8f90-0a1b2c3d4e5f\",\n \"endToEndId\": \"E4602656220260711100000abcdef123\",\n \"amount\": 25000,\n \"status\": \"created\",\n \"fraudCategory\": \"SCAM\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhook_receiver_url}}", "host": [ "{{webhook_receiver_url}}" ] }, "description": "Abertura de infracao/MED sobre a conta. status created na abertura; founded/unfounded na resolucao." }, "response": [] }, { "name": "Infracao MED resolvida (pix.infraction.resolved)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Monetarie-Event-Type", "value": "pix.infraction.resolved" }, { "key": "X-Monetarie-Event-Id", "value": "{{$guid}}" }, { "key": "X-Monetarie-Timestamp", "value": "1783000000" }, { "key": "X-Monetarie-Signature", "value": "sha256=" } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": 1042,\n \"infractionId\": \"b17c9a02-4a2f-4d5e-9b1a-77e0a1c2d3e4\",\n \"blockId\": \"3f21aa8c-1b2c-4d5e-8f90-0a1b2c3d4e5f\",\n \"endToEndId\": \"E4602656220260711100000abcdef123\",\n \"amount\": 25000,\n \"status\": \"founded\",\n \"fraudCategory\": \"SCAM\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhook_receiver_url}}", "host": [ "{{webhook_receiver_url}}" ] }, "description": "Desfecho de uma infração/MED sobre a conta: status founded (procedente) ou unfounded (improcedente). amount é o valor bloqueado cautelarmente, em centavos." }, "response": [] }, { "name": "Defesa de infracao enviada (pix.infraction.defense_submitted)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Monetarie-Event-Type", "value": "pix.infraction.defense_submitted" }, { "key": "X-Monetarie-Event-Id", "value": "{{$guid}}" }, { "key": "X-Monetarie-Timestamp", "value": "1783000000" }, { "key": "X-Monetarie-Signature", "value": "sha256=" } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": 1042,\n \"infractionId\": \"b17c9a02-4a2f-4d5e-9b1a-77e0a1c2d3e4\",\n \"blockId\": \"3f21aa8c-1b2c-4d5e-8f90-0a1b2c3d4e5f\",\n \"endToEndId\": \"E4602656220260711100000abcdef123\",\n \"status\": \"defense_submitted\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhook_receiver_url}}", "host": [ "{{webhook_receiver_url}}" ] }, "description": "Defesa enviada pelo cliente para uma infração com bloqueio cautelar. blockId identifica o bloqueio; o desfecho da análise chega por pix.infraction.resolved." }, "response": [] }, { "name": "Intervencao MED aberta (pix.med.created)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Monetarie-Event-Type", "value": "pix.med.created" }, { "key": "X-Monetarie-Event-Id", "value": "{{$guid}}" }, { "key": "X-Monetarie-Timestamp", "value": "1783000000" }, { "key": "X-Monetarie-Signature", "value": "sha256=" } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": 1042,\n \"medId\": \"REC-a1b2c3d4\",\n \"endToEndId\": \"E4602656220260711100000abcdef123\",\n \"status\": \"CREATED\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhook_receiver_url}}", "host": [ "{{webhook_receiver_url}}" ] }, "description": "Intervenção MED aberta pela sua solicitação na Partner API. endToEndId carrega a transação raiz. O desfecho chega por pix.med.completed ou pix.med.cancelled." }, "response": [] }, { "name": "Intervencao MED concluida (pix.med.completed)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Monetarie-Event-Type", "value": "pix.med.completed" }, { "key": "X-Monetarie-Event-Id", "value": "{{$guid}}" }, { "key": "X-Monetarie-Timestamp", "value": "1783000000" }, { "key": "X-Monetarie-Signature", "value": "sha256=" } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": 1042,\n \"medId\": \"REC-a1b2c3d4\",\n \"endToEndId\": \"E4602656220260711100000abcdef123\",\n \"amount\": 25000,\n \"status\": \"REFUND_COMPLETED\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhook_receiver_url}}", "host": [ "{{webhook_receiver_url}}" ] }, "description": "Recuperação MED concluída com a devolução dos fundos. amount em centavos é o valor que estava bloqueado cautelarmente." }, "response": [] }, { "name": "Intervencao MED cancelada (pix.med.cancelled)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Monetarie-Event-Type", "value": "pix.med.cancelled" }, { "key": "X-Monetarie-Event-Id", "value": "{{$guid}}" }, { "key": "X-Monetarie-Timestamp", "value": "1783000000" }, { "key": "X-Monetarie-Signature", "value": "sha256=" } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": 1042,\n \"medId\": \"REC-a1b2c3d4\",\n \"endToEndId\": \"E4602656220260711100000abcdef123\",\n \"amount\": 25000,\n \"status\": \"CANCELLED\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhook_receiver_url}}", "host": [ "{{webhook_receiver_url}}" ] }, "description": "Intervenção MED cancelada. Quando o cancelamento é comandado pela própria Partner API, a entrega pode vir sem o campo amount." }, "response": [] }, { "name": "Teste (webhook.test)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Monetarie-Event-Type", "value": "webhook.test" }, { "key": "X-Monetarie-Event-Id", "value": "{{$guid}}" }, { "key": "X-Monetarie-Timestamp", "value": "1783000000" }, { "key": "X-Monetarie-Signature", "value": "sha256=" } ], "body": { "mode": "raw", "raw": "{\n \"message\": \"Test webhook delivery\",\n \"timestamp\": \"2026-07-11T10:00:00Z\",\n \"webhookId\": \"0f7f279c-217b-4ba2-9a96-27d7401dfe2f\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhook_receiver_url}}", "host": [ "{{webhook_receiver_url}}" ] }, "description": "Entrega manual de teste, para validar a URL e a verificacao de assinatura." }, "response": [] }, { "name": "PIX recebido sem cobranca (pix.received)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Monetarie-Event-Type", "value": "pix.received" }, { "key": "X-Monetarie-Event-Id", "value": "{{$guid}}" }, { "key": "X-Monetarie-Timestamp", "value": "1783000000" }, { "key": "X-Monetarie-Signature", "value": "sha256=" } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": 10024270,\n \"amount\": 454,\n \"endToEndId\": \"E4602656220260714210000aabbccdd0\",\n \"payerName\": \"MARIA DA SILVA\",\n \"payerIspb\": \"00416968\",\n \"payerDocument\": \"12345678901\",\n \"receivedAt\": \"2026-07-14T21:00:00Z\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhook_receiver_url}}", "host": [ "{{webhook_receiver_url}}" ] }, "description": "PIX recebido na conta sem cobranca emitida (transferencia direta para uma chave da conta). Quando o credito vem de uma cobranca sua, o evento e pix.charge.paid. Valores em centavos." }, "response": [] }, { "name": "TED recebida (ted.received)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Monetarie-Event-Type", "value": "ted.received" }, { "key": "X-Monetarie-Event-Id", "value": "{{$guid}}" }, { "key": "X-Monetarie-Timestamp", "value": "1783000000" }, { "key": "X-Monetarie-Signature", "value": "sha256=" } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": 10024270,\n \"amount\": 150075,\n \"numCtrlStr\": \"STR20260714000000123\",\n \"messageType\": \"STR0008\",\n \"senderIspb\": \"60746948\",\n \"senderName\": \"JOAO PEREIRA\",\n \"receivedAt\": \"2026-07-14T21:00:00Z\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhook_receiver_url}}", "host": [ "{{webhook_receiver_url}}" ] }, "description": "TED de outra instituicao creditada na conta. Valores em centavos." }, "response": [] }, { "name": "Transferencia interna recebida (transfer.received)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Monetarie-Event-Type", "value": "transfer.received" }, { "key": "X-Monetarie-Event-Id", "value": "{{$guid}}" }, { "key": "X-Monetarie-Timestamp", "value": "1783000000" }, { "key": "X-Monetarie-Signature", "value": "sha256=" } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": 10024271,\n \"sourceAccountId\": 10024270,\n \"transactionId\": \"TEF20260714aabbccddeeff\",\n \"type\": \"internal\",\n \"amount\": 5000,\n \"status\": \"settled\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhook_receiver_url}}", "host": [ "{{webhook_receiver_url}}" ] }, "description": "Perna de credito da transferencia interna, entregue para a conta que recebeu. sourceAccountId identifica a conta de origem." }, "response": [] }, { "name": "Tarifa cobrada (fee.charged)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Monetarie-Event-Type", "value": "fee.charged" }, { "key": "X-Monetarie-Event-Id", "value": "{{$guid}}" }, { "key": "X-Monetarie-Timestamp", "value": "1783000000" }, { "key": "X-Monetarie-Signature", "value": "sha256=" } ], "body": { "mode": "raw", "raw": "{\n \"feeTransactionId\": \"5f6a7b8c-9d0e-4f1a-8b2c-3d4e5f6a7b8c\",\n \"accountId\": 10024270,\n \"feeType\": \"ted_out\",\n \"amount\": 500,\n \"originTransactionId\": \"E4602656220260714210000aabbccdd0\",\n \"originTransactionType\": \"ted\",\n \"originalAmount\": 150075,\n \"status\": \"posted\",\n \"chargedAt\": \"2026-07-14T21:00:00Z\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhook_receiver_url}}", "host": [ "{{webhook_receiver_url}}" ] }, "description": "Tarifa cobrada de uma conta. originTransactionId e originalAmount apontam para a transacao que originou a cobranca. Valores em centavos." }, "response": [] }, { "name": "Conta criada (account.created)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Monetarie-Event-Type", "value": "account.created" }, { "key": "X-Monetarie-Event-Id", "value": "{{$guid}}" }, { "key": "X-Monetarie-Timestamp", "value": "1783000000" }, { "key": "X-Monetarie-Signature", "value": "sha256=" } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": 10024272,\n \"customerId\": 4711,\n \"accountNumber\": \"100123-4\",\n \"agency\": \"0001\",\n \"iban\": \"BR9146026562000010010012345P1\",\n \"accountType\": \"payment\",\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhook_receiver_url}}", "host": [ "{{webhook_receiver_url}}" ] }, "description": "Abertura de conta. status pode ser active ou blocked, conforme a verificacao cadastral." }, "response": [] }, { "name": "Ciclo de vida da conta (account.blocked)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Monetarie-Event-Type", "value": "account.blocked" }, { "key": "X-Monetarie-Event-Id", "value": "{{$guid}}" }, { "key": "X-Monetarie-Timestamp", "value": "1783000000" }, { "key": "X-Monetarie-Signature", "value": "sha256=" } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": 10024272,\n \"status\": \"blocked\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhook_receiver_url}}", "host": [ "{{webhook_receiver_url}}" ] }, "description": "Mesmo formato para account.blocked, account.unblocked e account.closed. status e blocked no bloqueio, active no desbloqueio e closed no encerramento." }, "response": [] }, { "name": "Conta desbloqueada (account.unblocked)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Monetarie-Event-Type", "value": "account.unblocked" }, { "key": "X-Monetarie-Event-Id", "value": "{{$guid}}" }, { "key": "X-Monetarie-Timestamp", "value": "1783000000" }, { "key": "X-Monetarie-Signature", "value": "sha256=" } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": 10024272,\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhook_receiver_url}}", "host": [ "{{webhook_receiver_url}}" ] }, "description": "A conta voltou ao status active após um desbloqueio, seja pela API do parceiro, seja por operação interna." }, "response": [] }, { "name": "Conta encerrada (account.closed)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Monetarie-Event-Type", "value": "account.closed" }, { "key": "X-Monetarie-Event-Id", "value": "{{$guid}}" }, { "key": "X-Monetarie-Timestamp", "value": "1783000000" }, { "key": "X-Monetarie-Signature", "value": "sha256=" } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": 10024272,\n \"status\": \"closed\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhook_receiver_url}}", "host": [ "{{webhook_receiver_url}}" ] }, "description": "A conta foi encerrada. O encerramento é terminal: a conta não volta a transacionar." }, "response": [] }, { "name": "Chave PIX registrada (pix.key.registered)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Monetarie-Event-Type", "value": "pix.key.registered" }, { "key": "X-Monetarie-Event-Id", "value": "{{$guid}}" }, { "key": "X-Monetarie-Timestamp", "value": "1783000000" }, { "key": "X-Monetarie-Signature", "value": "sha256=" } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": 10024270,\n \"keyType\": \"CPF\",\n \"keyValue\": \"12345678901\",\n \"occurredAt\": \"2026-07-14T22:00:00Z\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhook_receiver_url}}", "host": [ "{{webhook_receiver_url}}" ] }, "description": "Mesmo formato para pix.key.deleted, pix.key.blocked e pix.key.unblocked; o pix.key.blocked inclui tambem o campo reason." }, "response": [] }, { "name": "Chave PIX excluida (pix.key.deleted)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Monetarie-Event-Type", "value": "pix.key.deleted" }, { "key": "X-Monetarie-Event-Id", "value": "{{$guid}}" }, { "key": "X-Monetarie-Timestamp", "value": "1783000000" }, { "key": "X-Monetarie-Signature", "value": "sha256=" } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": 10024270,\n \"keyType\": \"EMAIL\",\n \"keyValue\": \"maria@exemplo.com.br\",\n \"reason\": null,\n \"occurredAt\": \"2026-07-18T12:00:00Z\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhook_receiver_url}}", "host": [ "{{webhook_receiver_url}}" ] }, "description": "A chave PIX foi excluída do diretório." }, "response": [] }, { "name": "Chave PIX bloqueada (pix.key.blocked)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Monetarie-Event-Type", "value": "pix.key.blocked" }, { "key": "X-Monetarie-Event-Id", "value": "{{$guid}}" }, { "key": "X-Monetarie-Timestamp", "value": "1783000000" }, { "key": "X-Monetarie-Signature", "value": "sha256=" } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": 10024270,\n \"keyType\": \"EMAIL\",\n \"keyValue\": \"maria@exemplo.com.br\",\n \"reason\": \"FRAUD\",\n \"occurredAt\": \"2026-07-18T12:00:00Z\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhook_receiver_url}}", "host": [ "{{webhook_receiver_url}}" ] }, "description": "A chave PIX foi bloqueada no diretório; reason traz o motivo informado." }, "response": [] }, { "name": "Chave PIX desbloqueada (pix.key.unblocked)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Monetarie-Event-Type", "value": "pix.key.unblocked" }, { "key": "X-Monetarie-Event-Id", "value": "{{$guid}}" }, { "key": "X-Monetarie-Timestamp", "value": "1783000000" }, { "key": "X-Monetarie-Signature", "value": "sha256=" } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": 10024270,\n \"keyType\": \"EMAIL\",\n \"keyValue\": \"maria@exemplo.com.br\",\n \"reason\": null,\n \"occurredAt\": \"2026-07-18T12:00:00Z\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhook_receiver_url}}", "host": [ "{{webhook_receiver_url}}" ] }, "description": "A chave PIX foi desbloqueada e voltou a operar." }, "response": [] }, { "name": "Reivindicacao de portabilidade (pix.claim.created)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Monetarie-Event-Type", "value": "pix.claim.created" }, { "key": "X-Monetarie-Event-Id", "value": "{{$guid}}" }, { "key": "X-Monetarie-Timestamp", "value": "1783000000" }, { "key": "X-Monetarie-Signature", "value": "sha256=" } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": 10024270,\n \"claimId\": \"CLAIM-...\",\n \"claimType\": \"PORTABILITY\",\n \"keyType\": \"CPF\",\n \"keyValue\": \"12345678901\",\n \"donorIspb\": \"46026562\",\n \"claimerIspb\": \"60746948\",\n \"donorDeadline\": \"2026-07-21T22:00:00Z\",\n \"claimerDeadline\": \"2026-08-13T22:00:00Z\",\n \"occurredAt\": \"2026-07-14T22:00:00Z\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhook_receiver_url}}", "host": [ "{{webhook_receiver_url}}" ] }, "description": "Mesmo formato para pix.claim.acknowledged, pix.claim.confirmed, pix.claim.cancelled e pix.claim.completed." }, "response": [] }, { "name": "Reivindicacao reconhecida (pix.claim.acknowledged)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Monetarie-Event-Type", "value": "pix.claim.acknowledged" }, { "key": "X-Monetarie-Event-Id", "value": "{{$guid}}" }, { "key": "X-Monetarie-Timestamp", "value": "1783000000" }, { "key": "X-Monetarie-Signature", "value": "sha256=" } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": 10024270,\n \"claimId\": \"CLAIM-...\",\n \"claimType\": \"PORTABILITY\",\n \"keyType\": \"CPF\",\n \"keyValue\": \"12345678901\",\n \"donorIspb\": \"46026562\",\n \"claimerIspb\": \"60746948\",\n \"donorDeadline\": \"2026-07-21T22:00:00Z\",\n \"claimerDeadline\": \"2026-08-13T22:00:00Z\",\n \"occurredAt\": \"2026-07-18T12:00:00Z\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhook_receiver_url}}", "host": [ "{{webhook_receiver_url}}" ] }, "description": "A instituição doadora reconheceu a reivindicação de portabilidade." }, "response": [] }, { "name": "Reivindicacao confirmada (pix.claim.confirmed)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Monetarie-Event-Type", "value": "pix.claim.confirmed" }, { "key": "X-Monetarie-Event-Id", "value": "{{$guid}}" }, { "key": "X-Monetarie-Timestamp", "value": "1783000000" }, { "key": "X-Monetarie-Signature", "value": "sha256=" } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": 10024270,\n \"claimId\": \"CLAIM-...\",\n \"claimType\": \"PORTABILITY\",\n \"keyType\": \"CPF\",\n \"keyValue\": \"12345678901\",\n \"donorIspb\": \"46026562\",\n \"claimerIspb\": \"60746948\",\n \"donorDeadline\": \"2026-07-21T22:00:00Z\",\n \"claimerDeadline\": \"2026-08-13T22:00:00Z\",\n \"occurredAt\": \"2026-07-18T12:00:00Z\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhook_receiver_url}}", "host": [ "{{webhook_receiver_url}}" ] }, "description": "A reivindicação foi confirmada pela instituição doadora ou automaticamente no fim do prazo." }, "response": [] }, { "name": "Reivindicacao cancelada (pix.claim.cancelled)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Monetarie-Event-Type", "value": "pix.claim.cancelled" }, { "key": "X-Monetarie-Event-Id", "value": "{{$guid}}" }, { "key": "X-Monetarie-Timestamp", "value": "1783000000" }, { "key": "X-Monetarie-Signature", "value": "sha256=" } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": 10024270,\n \"claimId\": \"CLAIM-...\",\n \"claimType\": \"PORTABILITY\",\n \"keyType\": \"CPF\",\n \"keyValue\": \"12345678901\",\n \"donorIspb\": \"46026562\",\n \"claimerIspb\": \"60746948\",\n \"donorDeadline\": \"2026-07-21T22:00:00Z\",\n \"claimerDeadline\": \"2026-08-13T22:00:00Z\",\n \"occurredAt\": \"2026-07-18T12:00:00Z\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhook_receiver_url}}", "host": [ "{{webhook_receiver_url}}" ] }, "description": "A reivindicação foi cancelada, por solicitação ou automaticamente no fim do prazo." }, "response": [] }, { "name": "Reivindicacao concluida (pix.claim.completed)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Monetarie-Event-Type", "value": "pix.claim.completed" }, { "key": "X-Monetarie-Event-Id", "value": "{{$guid}}" }, { "key": "X-Monetarie-Timestamp", "value": "1783000000" }, { "key": "X-Monetarie-Signature", "value": "sha256=" } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": 10024270,\n \"claimId\": \"CLAIM-...\",\n \"claimType\": \"PORTABILITY\",\n \"keyType\": \"CPF\",\n \"keyValue\": \"12345678901\",\n \"donorIspb\": \"46026562\",\n \"claimerIspb\": \"60746948\",\n \"donorDeadline\": \"2026-07-21T22:00:00Z\",\n \"claimerDeadline\": \"2026-08-13T22:00:00Z\",\n \"occurredAt\": \"2026-07-18T12:00:00Z\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhook_receiver_url}}", "host": [ "{{webhook_receiver_url}}" ] }, "description": "A portabilidade concluiu e a chave passou a apontar para a conta reivindicadora." }, "response": [] } ] } ] }