NOWPayments offers you a unique solution developed and customized specifically for the needs of
casinos and the gambling industry in general. Here you can find the workflow and detailed explanation
of API requests. If you have any questions/ feedback, feel free to reach out to us at
partners@nowpayments.io
To 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.
To use them, you should complete the following steps:
Example 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');\n\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 if (isset($_SERVER['HTTP_X_NOWPAYMENTS_SIG']) && !empty($_SERVER['HTTP_X_NOWPAYMENTS_SIG'])) {\n $recived_hmac = $_SERVER['HTTP_X_NOWPAYMENTS_SIG'];\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 if ($request_json !== false && !empty($request_json)) {\n $hmac = hash_hmac(\"sha512\", $sorted_request_json, trim($this->ipn_secret));\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\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:
\nGet the actual information about the payment. You need to provide the ID of the payment in the request.
\nNOTE! You should make the get payment status request with the same API key that you used in the create payment request.\nHere is the list of avalable statuses:
\nGet the minimum payment amount for a specific pair.
\nYou can provide both currencies in the pair or just currency_from, and we will calculate the minimum payment amount for currency_from and currency which you have specified as the outcome in the Store Settings.
\nIn the case of several outcome wallets we will calculate the minimum amount in the same way we route your payment to a specific wallet.
\n","urlObject":{"protocol":"https","path":["v1","min-amount"],"host":["api","nowpayments","io"],"query":[{"key":"currency_from","value":"eth"},{"key":"currency_to","value":"trx"}],"variable":[]}},"response":[{"id":"637ed3dd-4eab-4a3d-b59f-6adb535d2c48","name":"6. Get the minimum payment amount","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"This section contains all methods for incoming payments. These are designed to accept payments from your customers and check payment status\nAll of the payments you receive first come to the system-generated deposit address, and then to your balance.
\n","_postman_id":"fe241ae9-bf86-44a4-93a7-c2a12f3eb2a3"},{"name":"Withdrawals","item":[{"name":"1. Authentication","id":"578e8dd8-1610-45d3-aab3-1dfb1bc5638e","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":"1d4dcab3-b573-4c57-a366-42ef3905eba7","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":"578e8dd8-1610-45d3-aab3-1dfb1bc5638e"},{"name":"2. Create payout","id":"bce5fd79-6272-4b80-a451-88309fe88730","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. Next is a description of the required request fields:
\nHere the list of the available payout statuses:
\nGet the actual information about the payuot. 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 avalable statuses:
\nThis method returns your balance in different currencies.
\nThe response contains a list of currencies with two parameters:
\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.
If you have 2FA app enabled in your dashboard, payouts will accept 2FA code from your app. Otherwise the code for payouts validation will be sent to your registration email.
\nPlease take a note that unverified payouts will be automatically rejected in an hour after creation.
\nNext is a description of the required request fields:
\n2. Create payout method;In order to establish an automatic verification of payouts, you should switch 2FA through the application.
There are several libraries for different frameworks aimed on generating a 2FA codes based on a secret key from your account settings, for example, Speakeasy for JavaScript.
We do not recommend to change any default settings.
const 2faVerificationCode = speakeasy.totp({\n your_2fa_secret_key,\n encoding: 'base32',\n})\n\nThis section contains all methods for outgoing payments. Using the funds on your balance, you can create payouts for your users, creating multiple instances with a single method. This section also describes how to fetch the status information of the payout and your current balance.
\nThis set of methods will allow you to make payouts from your custody to unlimited number of wallets. Fast and secure.
\nRecommended payouts requesting flow using API:
\n2FA automation:
\nUsing the API you can automate 2fa by implementing the OTP generation library in your code and set it up in your dashboard. \"Dashboard\" - \"Account settings\" - \"Two step authentification\" - \"Use an app\"
\nSave the secret key and set it up in your favorite 2FA application as well, otherwise you won't be able to get access to your dashboard!
\nPlease note:
\nPayouts can be requested only using a whitelisted IP address, and to whitelisted wallet addresses. It's a security measure enabled for each partner account by default.
\nYou can whitelist both of these anytime dropping a formal request using your registration email to partners@nowpayments.io.
\nFor more information about whitelisting you can reach us at partners@nowpayments.io.
\n","event":[{"listen":"prerequest","script":{"id":"52ccb4d0-13c7-4748-abbf-3ff1da0857b6","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"92b06e6f-a811-417e-a9d7-1689b82915ec","type":"text/javascript","exec":[""]}}],"_postman_id":"7d852909-30bf-4111-b9fe-edf111853928"}],"event":[{"listen":"prerequest","script":{"id":"7788cff1-1e21-44ab-8fb8-9b4d5a9bb117","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"eaba9e33-616a-47d4-8847-5a282afec80a","type":"text/javascript","exec":[""]}}]}