NOWPayments is a non-custodial cryptocurrency payment processing platform. Accept payments in a wide range of cryptos and get them instantly converted into a coin of your choice and sent to your wallet. Keeping it simple – no excess.
\nTo use the NOWPayments API you should do the following:
\nIPN (Instant payment notifications, or callbacks) are used to notify you when transaction status is changed.\nTo use them, you should complete the following steps:
\nGenerate and save the IPN Secret key in Store Settings tab at the Dashboard.
\nInsert the link where you want to get callbacks in create_payout request.\nThe parameter name is ipn_callback_url
\nYou will receive all the parameters at this URL by POST request.
\nSort all the parameters in alphabetical order.
\nConvert them to string using JSON.stringify(params, Object.keys(params).sort()) or the same function.
\nSign a string with an IPN-secret key with HMAC and sha-512 key
\nCompare the signed string from the previous step with the x-nowpayments-sig , which is stored in the header of the callback request.\nIf these strings are similar it is a success.\nOtherwise, contact us on support@nowpayments.io to solve the problem.
\nExample of creating a signed string at Node.JS
\nconst hmac = crypto.createHmac('sha512', notificationsKey);\nhmac.update(JSON.stringify(params, Object.keys(params).sort()));\nconst signature = hmac.digest('hex');\nExample of comparing signed strings in PHP
\nfunction check_ipn_request_is_valid()\n {\n $error_msg = \"Unknown error\";\n $auth_ok = false;\n $request_data = null;\n \n\n if (isset($_SERVER['HTTP_X_NOWPAYMENTS_SIG']) && !empty($_SERVER['HTTP_X_NOWPAYMENTS_SIG'])) {\n $recived_hmac = $_SERVER['HTTP_X_NOWPAYMENTS_SIG'];\n\n $request_json = file_get_contents('php://input');\n $request_data = json_decode($request_json, true);\n ksort($request_data);\n $sorted_request_json = json_encode($request_data);\n\n if ($request_json !== false && !empty($request_json)) {\n $hmac = hash_hmac(\"sha512\", $sorted_request_json, trim($this->ipn_secret));\n\n if ($hmac == $recived_hmac) {\n $auth_ok = true;\n } else {\n $error_msg = 'HMAC signature does not match';\n }\n } else {\n $error_msg = 'Error reading POST data';\n }\n } else {\n $error_msg = 'No HMAC signature sent.';\n }\n\n }\nTo add funds to your balance , create a payment using \"create payment\" method.\nYou will see a deposit address to which you need to send the funds. When the request has been processed, the funds will be added to your balance
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Authentication","slug":"authentication"},{"content":"API Documentation","slug":"api-documentation"}],"owner":"7907941","collectionId":"f99d5382-2615-4ab8-ab33-35ffe2ecf94a","publishedId":"T1DtdF9a","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-07-29T16:03:20.000Z"},"item":[{"name":"1. Authentication","id":"8b4d1e82-1a0c-4135-8e41-a388aec01cfa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"email\": \"your_email\",\n \"password\": \"your_password\" \n}","options":{"raw":{"language":"json"}}},"url":"https://api.nowpayments.io/v1/auth","description":"Authentication method for obtaining a JWT token. You should specify your email and password which you are using for signing in into dashboard.\nJWT token will be required for creating a payout request. For security reasons, JWT tokens expire after 5 minutes.
\n","urlObject":{"protocol":"https","path":["v1","auth"],"host":["api","nowpayments","io"],"query":[],"variable":[]}},"response":[{"id":"4f78580b-6928-4cff-a4b6-0c00ea43f25e","name":"1. Authentication","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"email\": \"your_email\",\n \"password\": \"your_password\" \n}","options":{"raw":{"language":"json"}}},"url":"https://api.nowpayments.io/v1/auth"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 13 Nov 2020 17:26:24 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"__cfduid=d100179a7e095065cf498b0371b423b7d1605288381; expires=Sun, 13-Dec-20 17:26:21 GMT; path=/; domain=.nowpayments.io; HttpOnly; SameSite=Lax"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"Strict-Transport-Security","value":"max-age=15768000"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Vary","value":"Origin"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"cf-request-id","value":"06643de5b900000022542c9000000001"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report?s=%2BQThCuj3D5DwqKzV%2FPRt15xNxPJ2KeOa0YwY8JeNLCpOzK7WTa%2FAv1csNcLl2Q2ZUnQEt4ITZdXfizJUafHl1f9G3F%2BENJmd%2FOe3NKxoFmN5Cjo%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"5f1a3282cac70022-DME"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjU4MjYyNTkxMTUiLCJpYXQiOjE2MDUyODgzODQsImV4cCI6MTYwNTI4ODY4NH0.bk8B5AjoTt8Qfm1zHJxutAtgaTGW-2j67waGQ2DUHUI\"\n}"}],"_postman_id":"8b4d1e82-1a0c-4135-8e41-a388aec01cfa"},{"name":"2. Create payout","id":"f58d2206-a1ed-4476-9e9a-13cf60d8905a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","type":"text","value":"This is the method to create a payout. You need to provide your data as a JSON-object payload.
\nPlease note that once the payout is created you need to add your “id” in the 3. Verify payout method along with your 2fa code.
2fa is obligatory for creating payouts.
Next is a description of the required request fields:
\nHere the list of the available payout statuses:
\nThis method is required to verify payouts by using your 2fa code.
You’ll have 10 attempts to verify the payout. If it is not verified after 10 attempts, the payout will remain in ‘creating’ status.
Payout will be processed only when it is verified.
Make sure to have your 2fa authentication enabled in your NOWPayments Account (in Account Settings).
When 2fa is disabled, the code automatically goes to your registration email.
The code sent by email is valid for one hour.
Next is a description of the required request fields:
\n2. Create payout methodGet the actual information about the payout. You need to provide the ID of the payout in the request.
\nNOTE! You should make the get payout status request with the same API key that you used in the creat_payout request.
\nHere is the list of available statuses:
\nThis method returns your balance in different currencies.
\nThe response contains a list of currencies with two parameters:
\nThis is the method to create a payment. You need to provide your data as a JSON-object payload. Next is a description of the required request fields:
\nHere the list of avalable statuses of payment:
\n