{"info":{"_postman_id":"261c9b21-e7bc-4475-93d8-32e8bdcde4d3","name":"Noox Pay","description":"

Overview

Call Create Deposit or Create Withdraw API method to send request in the Noox Pay system.
\n
Noox Pay checks if the deposit or withdrawal is valid.
\n
If the request is valid, Noox Pay responds with 200 HTTP status and returns the data. After receiving 200 HTTP status, you will receive the callback notification, and continue the process to update infos in your system.
\n
If the request is not valid, Noox Pay returns 422 (or other) error HTTP status and an error message.
\n
Your callback_url is defined on your dashboard. Noox Pay sends payment callback when order status is changed to pending, confirmed, expired or to any other status. Read more about Noox Pay deposit statuses or withdraw statuses. Please note, that payment notifications are sent using POST method.
\n
In order to avoid multiple erroneous requests, we block equal deposit and withdrawal requests from the same user ID and same requested amount up to few minutes. (example: bug in the frontend when not disabling submit after clicking once).
\n

API Request Limits

500,000 / hour per ip address for all API endpoints.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Environment	Endpoint	Request Limit
Live	POST /deposit	40 / seconds
Live	GET /witddraw	40 / seconds
Live	POST /deposit	40 / seconds
Live	GET /witddraw	40 / seconds

API returns 429 HTTP error if limit is exceeded.

API Requests

API Request is used to query Noox Pay API (examples: Create Deposit, Get Deposit).
API Request attributes:

Action - Which API method was queried.
Response - HTTP status returned by Noox Pay.
Parameters - Parameters used to query Noox Pay API.
Response - Parameters returned by Noox Pay.

\n\n

API Authentication

All Noox Pay API calls require authentication. You can authenticate your api by providing header: Token.

API Key - You can generate your API Token key in account area. From dashboard navigation go to api page and create new API Token key.

POST {{baseUrl}}/deposit/
Accept: application/json
User-Agent: PHP
Token: Your-Token Dashboard

Errors

Most common API error responses described below. Error response must be identified by HTTP status and reason attribute in your application.

Please note, that specific API methods, for example Create Deposit has their own errors (422 Illegal Conditions - when parameters are invalid).

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

HTTP Status	Reason	Message
401(Unauthorized)	Bad Credentials	API Credentials is not valid
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.
401(Unauthorized)	Illegal Conditions	user CPF blocked by Fast Payments.
401(Unauthorized)	Illegal Conditions	user_id blocked by Fast Payments.
404(Not Found)	PageNotFound	Page, action or record not found
404 (Not Found)	Results not found	Results not found
422 (Unauthorized)	Illegal Conditions	Parameters not valid
429 (Unauthorized)	Rate Limit Exception	API request limit is exceeded
500 (Internal Server Error)	Internal ServerError	Something wrong in Fast Payments

Issues
The common issues why your app or API integration possible not working.

Unable to create deposit / withdraw or unable to send a request to Noox Pay API

Possible reasons:

Wrong API credentials. Please check if you have entered them correctly. Make sure that there are no spaces before or after the text.
Wrong API credentials Token. Check your account if the operation option is enabled for the key you are using.
cURL or other library used to communicate with Noox Pay API is outdated or is working incorrectly. Please check library version.
Your server can not reach nooxpay.com. Please check if nooxpay.com is available and if your server can reach it.

\n\n

The order status is not updated after payment in your system or Noox Pay does not send transaction callback (Callback Notification)

Possible reasons:

Your server is on a private network, for example localhost. Please make sure that your application is publicly accessible.
Your website is disabled (in maintenance mode).
Your server firewall, third-party security service (cloudflare, incapsula, etc.) or your application is blocking Noox Pay IP address.
Yout return url is incorrect, make sure address entered in your account is correct.

\n\n

CONDITION TO SOLICITATION WITHDRAW
If your balance available is not sufficient to request a withdrawal transaction, we will respond with:

{\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\n

API Request Control(amount limits)

As a way of avoiding possible fraud, Noox Pay has a user rating that imposes a daily deposit limit per method. Daily limits for default or VIP users are configured according to your needs. We carry out the control based on the volume, amount of deposits and user activity time, based on your user_id and 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":"https://nooxpay.com/public/api/deposit","description":"

Deposit Statuses

Statuses by priority:

pending
\n
confirmed
\n
canceled
\n
refund
\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

STATUS	DESCRIPTION
Pending	Awaiting payment from the user.
Confirmed	Payment confirmed by Fastpayments.
Canceled	Cancel deposit.
Refund	The user receive the amount refund in your origin account.

TRANSACTION TEMPORARILY BLOCKED

If your user clicks on the purchase button several times, we will prevent multiple transactions from being created so that there is no inconvenience.

Below is the message returned in this case:

{\n message: \"X minute action interval per user reached, please wait to make a new deposit\",\n reason: \"Illegal Conditions\"\n}\n\n

Deposit Callback

Deposit callback (notification) will be sent to client callback_url when deposit statuses is changed to pending, confirmed, expired, refund, refund_pending or refund_confirmed.

Callback example:

{\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\n

","urlObject":{"protocol":"https","path":["public","api","deposit"],"host":["nooxpay","com"],"query":[],"variable":[]}},"response":[{"id":"0d71ca6a-0504-4a99-aa0c-42819bb4d427","name":"CREATE DEPOSIT PIX","originalRequest":{"method":"POST","header":[{"key":"Token","value":"Your-Token","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"method\" : \"pix\",\r\n \"order_id\" : \"Your order id\",\r\n \"user_id\" : \"123456\",\r\n \"user_name\" : \"Your Name\",\r\n \"user_document\" : \"99999999999\",\r\n \"user_address\" : \"Your address\",\r\n \"user_district\" : \"Your district\",\r\n \"user_city\" : \"Your city\",\r\n \"user_uf\" : \"UF\",\r\n \"user_cep\" : \"99999999\",\r\n \"amount\" : \"1.80\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/deposit"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"425"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 31 Aug 2021 15:30:03 GMT"},{"key":"x-amzn-RequestId","value":"d5e6d8a6-7650-4844-a5e3-eb30dbe26184"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"E8CmFEtnCYcFgLA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-612e4af3-73bbe87d07c463ca2b04057e"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 819fb1f29c3038ca3cec04e041a0aa1f.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"GRU1-C1"},{"key":"X-Amz-Cf-Id","value":"YZ-IIL-CNS4tstQyBJOnbl_Tx82_qxJdYdErkv4lgDYVGutvPe2QEw=="}],"cookie":[],"responseTime":null,"body":"{\n \"order_id\": \"665151251281952\",\n \"solicitation_date\": \"2022-03-31 12:30:02\",\n \"due_date\": \"2022-04-04\",\n \"code_identify\": \"01388887\",\n \"amount\": \"180.20\",\n \"status\": \"pending\",\n \"link_qr\": \"https://image-charts.com/chart?chs=350x350&cht=00020101021226510014BR.GOV.BCB.PIX0114381737280001980211A4P0138888753040000530398654041.805802BR5906FastPayments6014Belo Horizonte61083038040362150511A4P013888876304AE68\",\n \"content_qr\": \"00020101021226510014BR.GOV.BCB.PIX0114381737280001980211A4P0138888753040000530398654041.805802BR5906FastPayments6014Belo Horizonte61083038040362150511A4P013888876304AE68\"\n}"}],"_postman_id":"66cd7eee-e778-4e4b-8938-8baa7f590539"},{"name":"GET DEPOSIT","id":"ed371a81-6132-4ad3-962f-4ea2abf91068","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Token","value":"Your-Token","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"{{baseUrl}}/deposit?order_id=Corepay166155681120","urlObject":{"path":["deposit"],"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"},{"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}}/deposit?first_date=2021-07-30&last_date=2021-08-01&status=confirmed&method=pix&order_id","host":["{{baseUrl}}"],"path":["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}}/balance","urlObject":{"path":["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}}/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":"https://nooxpay.com/public/api/withdraw","description":"

type_pixkey format (cpf,cnpj,evp,email,phone)

\n","urlObject":{"protocol":"https","path":["public","api","withdraw"],"host":["nooxpay","com"],"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":"https://fui-bet.com/public/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":"{{baseUrlNew}}/withdraw?order_id=ord-1","urlObject":{"path":["withdraw"],"host":["{{baseUrlNew}}"],"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}}/withdraw?order_id=TESTE15153561","host":["{{baseUrl}}"],"path":["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"}]}