Overview
\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.
\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.
\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.
\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.
\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.
\nNooxPay API Integração financeira simples, segura e preparada para aplicações modernas.
\nImportante: 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.
\nAutenticação e credenciais da API
\nGestão de clientes e contas
\nOperações financeiras
\nPIX e pagamentos
\nConsultas de transações
\nSaldos e movimentações
\nWebhooks e notificações
\nStatus das operações
\nTratamento de erros
\nAmbientes de homologação e produção
\nSegurança
\nAs credenciais utilizadas para autenticação são confidenciais e devem ser armazenadas exclusivamente em ambientes seguros no backend da aplicação.
\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.
\nAmbientes
\nDurante o desenvolvimento, utilize o ambiente de homologação (Sandbox) para realizar testes e validar sua integração.
\nApós a conclusão dos testes e aprovação da integração, utilize as credenciais e endpoints correspondentes ao ambiente de Produção.
\nWebhooks
\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.
\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.
\nPOST {{baseUrl}}/api/deposit/
Accept: application/json
User-Agent: PHP
Token: Your-Token Dashboard
Errors
\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.
\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.
\nIssues
Problemas comuns que podem fazer com que seu aplicativo ou a integração com a API não funcione corretamente.
Não é possível criar um depósito/saque ou enviar uma requisição para a API da NooxPay.
\nPossíveis causas:
\nO status do pedido não é atualizado após o pagamento ou a NooxPay não envia a notificação de callback.
\nPossíveis causas:
\nCONDIÇÕES PARA SOLICITAÇÃO DE SAQUE
Se o seu saldo disponível não for suficiente para solicitar uma transação de saque, a API retornará a seguinte resposta:
{\n \"message\":\"Withdrawal amount greater than your balance available\",\n \"reason\":\"IllegalConditions\",\n \"code\":\"0443\"\n}\n\n{\n \"message\":\"Insufficient balance available due to pending withdrawals\",\n \"reason\":\"IllegalConditions\",\n \"code\":\"0442\"\n}\n\n{\n \"message\":\"Withdrawal not allowed due to insufficient balance available\",\n \"reason\":\"IllegalConditions\",\n \"code\":\"0441\"\n}\n\nControle de Requisições da API (Limites de Valores)
\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.
\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.
\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.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"20304668","collectionId":"261c9b21-e7bc-4475-93d8-32e8bdcde4d3","publishedId":"2sBXcKBdPR","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"006bfd"},"publishDate":"2026-08-13T15:54:52.000Z"},"item":[{"name":"CREATE DEPOSIT PIX","id":"66cd7eee-e778-4e4b-8938-8baa7f590539","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Token","value":"Your-Token","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"order_id\": \"93529856923659273\",\r\n \"user_id\": \"1234\",\r\n \"user_document\": \"99999999999\",\r\n \"amount\": 50.00,\r\n \"method\": \"pix\",\r\n \"user_address\": \"---\",\r\n \"user_district\": \"---\",\r\n \"user_city\": \"---\",\r\n \"user_uf\": \"---\",\r\n \"user_cep\": \"---\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/api/deposit","description":"Deposit Statuses
\nSequencia de Status:
\nPENDING
\nCOFIRMED
\nCANCELED
\nREFUND
\nTRANSAÇÃO TEMPORARIAMENTE BLOQUEADA
\nCaso o usuário clique no botão de compra várias vezes, a NooxPay impedirá a criação de múltiplas transações, evitando duplicidades e possíveis inconvenientes.
\nAbaixo está a mensagem retornada pela API nesse caso:
\n{\n message: \"X minute action interval per user reached, please wait to make a new deposit\",\n reason: \"Illegal Conditions\"\n}\n\nDeposit Callback
\nO callback de depósito (notificação) será enviado para a callback_url do cliente sempre que o status do depósito for alterado para um dos seguintes estados:
\nconfirmed, canceled, refund.
\n{\n \"order_id\": \"6236621\",\n \"user_id\": \"34234\",\n \"solicitation_date\": \"12/03/2019 13:15:13\",\n \"paid_date\": \"13/03/2019 02:04:42\",\n \"code_identify\": \"64305077\",\n \"amount_solicitation\": \"580.00\",\n \"amount_confirmed\": \"580.00\",\n \"status\": \"confirmed\",\n \"comission\": \"29.00\",\n \"disponibilization_date\": \"15/03/2019 00:00:00\"\n}\n\nInitial date of search
\n","type":"text/plain"},"key":"first_date","value":"2022-04-01"},{"disabled":true,"description":{"content":"Final date of search
\n","type":"text/plain"},"key":"last_date","value":"2022-04-30"},{"disabled":true,"description":{"content":"Transaction status separated by commas. Ex (confirmed,pending,canceled,refund,chargeback,freeze)
\n","type":"text/plain"},"key":"status","value":"pending"},{"key":"order_id","value":"Corepay166155681120"}],"variable":[]}},"response":[{"id":"186a8f6d-5af1-440e-863a-b58cb9acaca4","name":"GET DEPOSIT","originalRequest":{"method":"GET","header":[{"key":"Token","value":"Your-Token","type":"text"}],"url":{"raw":"{{baseUrl}}/api/deposit?first_date=2021-07-30&last_date=2021-08-01&status=confirmed&method=pix&order_id","host":["{{baseUrl}}"],"path":["api","deposit"],"query":[{"key":"first_date","value":"2021-07-30","description":"Initial date of search"},{"key":"last_date","value":"2021-08-01","description":"Final date of search"},{"key":"status","value":"confirmed","description":"Transaction status separated by commas. Ex (confirmed,pending,canceled,refund,chargeback,freeze)"},{"key":"method","value":"pix","description":"Transaction method separated by commas. Ex (pix,invoice,shop,creditcard)"},{"key":"order_id","value":null,"description":"Transaction Order ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1916"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 31 Aug 2021 16:31:12 GMT"},{"key":"x-amzn-RequestId","value":"e01c0a2f-3ba6-4324-a46c-520a62fbb728"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"E8LkYFPkiYcFz7g="},{"key":"X-Amzn-Trace-Id","value":"Root=1-612e594f-47a3f5c840640d5773c8a3fd"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 b97800dba63a54d15f1e69f88e3a1a3e.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"GRU1-C1"},{"key":"X-Amz-Cf-Id","value":"zGlxCO82D2mRLpde5-bM29h-StH6YIRVli-ndtsZN648SdTNDb_jVQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"orders\": [\n {\n \"id\": 354812,\n \"order_id\": \"9954535455\",\n \"paid_date\": \"2022-03-31 13:50:06\",\n \"due_date\": \"2022-04-04\",\n \"code_identify\": \"FST01388887\",\n \"amount_solicitation\": \"180.20\",\n \"amount_confirmed\": \"180.20\",\n \"code_bank\": \"1531545\",\n \"bank_name\": \"Bank Name\",\n \"holder\": \"Account Bank Name\",\n \"agency\": \"Agency Bank\",\n \"type_account\": \"corrente\",\n \"account\": \"Account Number\",\n \"status\": \"confirmed\",\n \"link_invoice\": \"https://nooxpay.com/public/qr/467492/2143517/200x200\",\n \"receipt\": \"\",\n \"comission\": \"0.9\",\n \"disponibilization_date\": \"12/08/2021 00:00:00\"\n },\n {\n \"id\": 467493,\n \"order_id\": \"Order ID\",\n \"paid_date_clear\": \"2021-08-14 13:50:06\",\n \"paid_date\": \"14/08/2021 13:50:06\",\n \"due_date\": \"15/08/2021\",\n \"code_identify\": \"A4P66551491\",\n \"amount_solicitation\": \"7.30\",\n \"amount_confirmed\": \"7.30\",\n \"code_bank\": \"Code Bank\",\n \"bank_name\": \"Bank Name\",\n \"holder\": \"Account Bank Name\",\n \"agency\": \"Agency Bank\",\n \"type_account\": \"corrente\",\n \"account\": \"Account Number\",\n \"status\": \"confirmed\",\n \"link_invoice\": \"https://nooxpay.com/public/qr/467492/2753517/200x200\",\n \"receipt\": \"\",\n \"comission\": \"0.9\",\n \"disponibilization_date\": \"15/08/2021 00:00:00\"\n }\n ]\n}"}],"_postman_id":"ed371a81-6132-4ad3-962f-4ea2abf91068"},{"name":"GET BALANCE","id":"63910361-17dc-449d-8b94-6ef692187511","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Token","value":"Your-Token","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"{{baseUrl}}/api/balance","urlObject":{"path":["api","balance"],"host":["{{baseUrl}}"],"query":[{"disabled":true,"description":{"content":"Initial date of search
\n","type":"text/plain"},"key":"first_date","value":"2022-04-01"},{"disabled":true,"description":{"content":"Final date of search
\n","type":"text/plain"},"key":"last_date","value":"2022-04-30"},{"disabled":true,"description":{"content":"Transaction status separated by commas. Ex (confirmed,pending,canceled,refund,chargeback,freeze)
\n","type":"text/plain"},"key":"status","value":"pending"}],"variable":[]}},"response":[{"id":"f3616d76-1feb-4cfd-9c5f-41c8096e31ac","name":"GET BALANCE","originalRequest":{"method":"GET","header":[{"key":"Token","value":"Your-Token","type":"text"}],"url":"{{baseUrl}}/api/balance"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1916"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 31 Aug 2021 16:31:12 GMT"},{"key":"x-amzn-RequestId","value":"e01c0a2f-3ba6-4324-a46c-520a62fbb728"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"E8LkYFPkiYcFz7g="},{"key":"X-Amzn-Trace-Id","value":"Root=1-612e594f-47a3f5c840640d5773c8a3fd"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 b97800dba63a54d15f1e69f88e3a1a3e.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"GRU1-C1"},{"key":"X-Amz-Cf-Id","value":"zGlxCO82D2mRLpde5-bM29h-StH6YIRVli-ndtsZN648SdTNDb_jVQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"amount\": 15000.03\n}"}],"_postman_id":"63910361-17dc-449d-8b94-6ef692187511"},{"name":"CREATE WITHDRAW","id":"7f67d50a-3013-49a7-8f12-6a5e34c52eb0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Token","value":"Your-Token","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"method\":\"pix\",\r\n \"order_id\":\"CRP873658652852\",\r\n \"user_id\":\"1234567\",\r\n \"user_name\":\"CorePay\",\r\n \"user_document\":\"91969747021\",\r\n \"pix_key\":\"b0d67bc8-5c7c-4b11-8e5e-8ab580611250\",\r\n \"type_pixkey\":\"evp\",\r\n \"amount\":\"12.53\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/api/withdraw","description":"type_pixkey format (cpf,cnpj,evp,email,phone)
\n","urlObject":{"path":["api","withdraw"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"3bd535bd-c4d8-4880-9cd1-38a5e8c499e6","name":"CREATE WITHDRAW","originalRequest":{"method":"POST","header":[{"key":"Token","value":"Your-Token","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"method\" : \"pix\",\r\n \"order_id\" : \"12345678TTT9\",\r\n \"user_id\" : \"User ID\",\r\n \"user_name\": \"User name\",\r\n \"user_document\": \"User document\",\r\n \"amount\" : \"1.54\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/api/withdraw"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"300"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 31 Aug 2021 17:42:30 GMT"},{"key":"x-amzn-RequestId","value":"770c9b07-e59f-4686-8535-08967948aa34"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"E8WAWFDWiYcFxwA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-612e6a02-05e1011b2586a8bd30b1e74b"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 5737857b517c9071e8cc21326fd104a6.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"GRU3-C2"},{"key":"X-Amz-Cf-Id","value":"kmfd5oeamHPnmsCXKOWDKybx7eJqSXic1dbS9WVAbd3newPLORZMXA=="}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 498566,\n \"order_id\": \"12345678TTT9\",\n \"solicitation_date\": \"2021-08-31 14:42:30\",\n \"user_id\": \"User ID\",\n \"user_name\": \"User name\",\n \"user_document\": \"User document\",\n \"bank_name\": null,\n \"agency\": null,\n \"type_operation\": null,\n \"account\": null,\n \"amount_solicitation\": \"1.54\",\n \"currency\": null,\n \"status\": \"pending\"\n}"}],"_postman_id":"7f67d50a-3013-49a7-8f12-6a5e34c52eb0"},{"name":"GET WITHDRAW","id":"b0ab495b-cfee-43d8-ab8d-974e805c9a34","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Token","value":"Your-Token","type":"text"}],"url":"{{baseUrl}}/api/withdraw?order_id=ord-1","urlObject":{"path":["api","withdraw"],"host":["{{baseUrl}}"],"query":[{"key":"order_id","value":"ord-1"}],"variable":[]}},"response":[{"id":"bc277ff3-0b87-4cb7-9808-2c78a26a2d05","name":"GET WITHDRAW","originalRequest":{"method":"GET","header":[{"key":"Token","value":"Your-Token","type":"text"}],"url":{"raw":"{{baseUrl}}/api/withdraw?order_id=TESTE15153561","host":["{{baseUrl}}"],"path":["api","withdraw"],"query":[{"key":"order_id","value":"TESTE15153561"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"330"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 31 Aug 2021 17:41:24 GMT"},{"key":"x-amzn-RequestId","value":"9523858b-befa-44fa-ab7b-58be0826c7a9"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"E8V2fHTsiYcFUYg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-612e69c2-184f412d6aec985114ca837b"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 5737857b517c9071e8cc21326fd104a6.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"GRU3-C2"},{"key":"X-Amz-Cf-Id","value":"IXjOEzskmMuBNOAgfRbexpYn1X71QAJgMNlUiAMA2E70lHJERrWzYw=="}],"cookie":[],"responseTime":null,"body":"{\n \"order_id\": \"TESTET15153561\",\n \"solicitation_date_clear\": \"2021-08-30 16:02:48\",\n \"solicitation_date\": \"30/08/2021 16:02:48\",\n \"code_identify\": null,\n \"amount_solicitation\": \"1.66\",\n \"code_bank\": \"218\",\n \"bank_name\": \"---\",\n \"holder\": \"User name\",\n \"agency\": \"---\",\n \"type_account\": \"---\",\n \"account\": \"---\",\n \"document\": \"User document\",\n \"status\": \"canceled\"\n}"}],"_postman_id":"b0ab495b-cfee-43d8-ab8d-974e805c9a34"}]}