{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"261c9b21-e7bc-4475-93d8-32e8bdcde4d3","name":"Noox Pay","description":"Overview\n\nA **NooxPay** oferece uma API moderna, segura e eficiente para integração de soluções financeiras diretamente ao seu sistema.Esta documentação foi desenvolvida para auxiliar desenvolvedores na implementação dos serviços da NooxPay, apresentando de forma organizada os **endpoints disponíveis, métodos de autenticação, parâmetros, exemplos de requisições e respostas, códigos de status e tratamento de erros**.\n\nAtravés desta collection do Postman, você poderá testar e integrar os principais recursos da plataforma de maneira prática, utilizando ambientes configuráveis e exemplos prontos para acelerar o desenvolvimento.Integração simplificadaA API NooxPay segue padrões REST e utiliza comunicação através de **JSON**, permitindo integração com diferentes linguagens, frameworks e arquiteturas.\n\nNesta documentação você encontrará recursos relacionados a:SegurançaAs credenciais utilizadas para autenticação são **confidenciais** e devem ser armazenadas exclusivamente em ambientes seguros no backend da aplicação.Nunca exponha tokens, chaves de API ou outras credenciais em aplicações frontend, repositórios públicos ou códigos acessíveis ao usuário final.\n\nAmbientesDurante o desenvolvimento, utilize o ambiente de **homologação (Sandbox)** para realizar testes e validar sua integração.Após a conclusão dos testes e aprovação da integração, utilize as credenciais e endpoints correspondentes ao ambiente de **Produção**.\n\nWebhooksPara operações assíncronas, a NooxPay poderá enviar notificações através de **webhooks**, permitindo que sua aplicação receba atualizações sobre mudanças de status das operações em tempo real.O endpoint configurado para recebimento dos webhooks deverá estar disponível publicamente através de **HTTPS** e preparado para validar, processar e responder corretamente às notificações recebidas.\n\n**NooxPay API** Integração financeira simples, segura e preparada para aplicações modernas.\n\n**Importante:** os endpoints, parâmetros, limites e funcionalidades apresentados nesta documentação devem ser utilizados de acordo com as credenciais e permissões disponibilizadas para cada integração.\n\n- Autenticação e credenciais da API\n    \n- Gestão de clientes e contas\n    \n- Operações financeiras\n    \n- PIX e pagamentos\n    \n- Consultas de transações\n    \n- Saldos e movimentações\n    \n- Webhooks e notificações\n    \n- Status das operações\n    \n- Tratamento de erros\n    \n- Ambientes de homologação e produção\n    \n\n**Segurança**\n\nAs credenciais utilizadas para autenticação são confidenciais e devem ser armazenadas exclusivamente em ambientes seguros no backend da aplicação.\n\nNunca exponha tokens, chaves de API ou outras credenciais em aplicações frontend, repositórios públicos ou códigos acessíveis ao usuário final.\n\n**Ambientes**\n\nDurante o desenvolvimento, utilize o ambiente de homologação (Sandbox) para realizar testes e validar sua integração.\n\nApós a conclusão dos testes e aprovação da integração, utilize as credenciais e endpoints correspondentes ao ambiente de Produção.\n\n**Webhooks**\n\nPara operações assíncronas, a NooxPay poderá enviar notificações através de webhooks, permitindo que sua aplicação receba atualizações sobre mudanças de status das operações em tempo real.\n\nO endpoint configurado para recebimento dos webhooks deverá estar disponível publicamente através de HTTPS e preparado para validar, processar e responder corretamente às notificações recebidas.\n\nPOST {{baseUrl}}/api/deposit/  \nAccept: application/json  \nUser-Agent: PHP  \nToken: Your-Token Dashboard\n\n---\n\nErrors\n\n---\n\nAs respostas de erro mais comuns da API estão descritas abaixo. Em sua aplicação, a resposta de erro deve ser identificada pelo status HTTP e pelo atributo reason.\n\nObserve que alguns métodos específicos da API, como Create Deposit (Criar Depósito), possuem seus próprios erros. Por exemplo: 422 – Condições Inválidas (Illegal Conditions), retornado quando os parâmetros informados são inválidos.\n\n| HTTP Status | Reason | Message |\n| --- | --- | --- |\n| 401 (Unauthorized) | Bad Credentials | API Credentials is not valid |\n| 401 (Unauthorized) | Illegal Conditions | We were unable to complete your transaction due to your dayli limit of R$ XX,XX . You Still have R$ XX,XX available to deposit today. |\n| 401 (Unauthorized) | Illegal Conditions | user CPF blocked by NooxPay. |\n| 401 (Unauthorized) | Illegal Conditions | user_id blocked by NooxPay. |\n| 404 (Not Found) | PageNotFound | Page, action or record not found |\n| 404 (Not Found) | Results not found | Results not found |\n| 422 (Unauthorized) | Illegal Conditions | Parameters not valid |\n| 429 (Unauthorized) | Rate Limit Exception | API request limit is exceeded |\n| 500 (Internal Server Error) | Internal ServerError | Something wrong in NooxPay |\n\nIssues  \nProblemas comuns que podem fazer com que seu aplicativo ou a integração com a API não funcione corretamente.\n\n---\n\nNão é possível criar um depósito/saque ou enviar uma requisição para a API da NooxPay.\n\n---\n\nPossíveis causas:\n\n<ul><li><div><b>Credenciais da API incorretas</b>: verifique se as credenciais foram inseridas corretamente. Certifique-se de que não existam espaços antes ou depois dos valores informados.</div></li><li><div><b>cURL </b>ou <b>outra biblioteca</b> desatualizada: a biblioteca utilizada para comunicação com a API da NooxPay pode estar desatualizada ou funcionando incorretamente. Verifique a versão instalada e, se necessário, atualize-a.</div></li><li><div><b>Problemas de conectividade</b> com a <b>NooxPay</b>: seu servidor pode não estar conseguindo acessar o domínio da <b>NooxPay</b>. Verifique se o serviço está disponível e se o seu servidor consegue estabelecer conexão com ele.</div></li></ul>\n\n---\n\nO status do pedido não é atualizado após o pagamento ou a NooxPay não envia a notificação de callback.\n\n---\n\nPossíveis causas:\n\n<ul><li><div>Seu servidor está em uma rede privada, como localhost. Certifique-se de que sua aplicação esteja acessível publicamente pela internet.</div></li><li><div>Seu site está indisponível, por exemplo, em modo de manutenção.</div></li><li><div>O firewall do servidor, serviço de segurança de terceiros (como Cloudflare, Incapsula etc.) ou sua própria aplicação pode estar bloqueando o endereço IP da NooxPay.</div></li><li><div>Sua URL de retorno está incorreta: verifique se o endereço configurado em sua conta está correto.</div></li></ul>\n\nCONDIÇÕES PARA SOLICITAÇÃO DE SAQUE  \nSe o seu saldo disponível não for suficiente para solicitar uma transação de saque, a API retornará a seguinte resposta:\n\n---\n\n```\n{\n    \"message\":\"Withdrawal amount greater than your balance available\",\n    \"reason\":\"IllegalConditions\",\n    \"code\":\"0443\"\n}\n\n ```\n\n```\n{\n    \"message\":\"Insufficient balance available due to pending withdrawals\",\n    \"reason\":\"IllegalConditions\",\n    \"code\":\"0442\"\n}\n\n ```\n\n```\n{\n    \"message\":\"Withdrawal not allowed due to insufficient balance available\",\n    \"reason\":\"IllegalConditions\",\n    \"code\":\"0441\"\n}\n\n ```\n\nControle de Requisições da API (Limites de Valores)\n\n---\n\nComo forma de prevenir possíveis fraudes, a NooxPay possui um sistema de classificação de usuários que estabelece limites diários de depósito por método de pagamento.\n\nOs limites diários para usuários padrão ou VIP são configurados de acordo com as necessidades e o perfil de utilização.\n\nO controle é realizado com base no volume de transações, valores dos depósitos e tempo de atividade do usuário, utilizando como referência o user_id e o CPF.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"20304668","team":3284005,"collectionId":"261c9b21-e7bc-4475-93d8-32e8bdcde4d3","publishedId":"2sBXcKBdPR","public":true,"publicUrl":"https://documenter-api.postman.tech/view/20304668/2sBXcKBdPR","privateUrl":"https://go.postman.co/documentation/20304668-261c9b21-e7bc-4475-93d8-32e8bdcde4d3","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"006bfd"},"documentationLayout":"classic-single-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"dark","themes":[{"name":"dark","logo":"https://content.pstmn.io/a07af1ec-3f59-48a8-8ea7-958f38df3c66/bi5wbmc=","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"006bfd"}},{"name":"light","logo":"https://content.pstmn.io/a07af1ec-3f59-48a8-8ea7-958f38df3c66/bi5wbmc=","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"006bfd"}}]}},"version":"8.12.6","publishDate":"2026-08-13T15:54:52.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/a07af1ec-3f59-48a8-8ea7-958f38df3c66/bi5wbmc=","logoDark":"https://content.pstmn.io/a07af1ec-3f59-48a8-8ea7-958f38df3c66/bi5wbmc="}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/e8bb94519b4dc0fd83b701ef2db170716bf974be659c1d9a6cfee6ac914e9994","favicon":"https://postman-image-service.postman.com/api/cloudinary-proxy/postman/image/upload/v1786636331/team/3c6dc31606450e18b971691f2b7a1005"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sBXcKBdPR"}