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.
This is a sandbox API , where you can test everything without sending real money, simply specify the case which you want to test and we will emulate a real-like flow of payment processing.
To use the NOWPayments API you should do the following:
\nIn the sandbox you don't need to send any funds to test our API.
Just specify the ‘case’ parameter in the create payment request and get notifications for each of the presented cases.
Testing flow:
\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:
1.Generate and save the IPN Secret key in Store Settings tab at the Dashboard.
\n2.Insert the link where you want to get callbacks in create_payment request.
The parameter name is ipn_callback_url
3.You will receive all the parameters at this URL by POST request.
\n4.Sort all the parameters in alphabetical order.
\n5.Convert them to string using JSON.stringify(params, Object.keys(params).sort()) or the same function.
\n6.Sign a string with an IPN-secret key with HMAC and sha-512 key
\n7.Compare the signed string from the previous step with the x-nowpayments-sig , which is stored in the header of the callback request.
If these strings are similar it is a success.
Otherwise, contact us on support@nowpayments.io to solve the problem.
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\nIf you want to create several payments for one Order you should do the following:
\nIt may be useful if you want to give your customers opportunity to pay a full order with several payments, for example, one part in BTC and one part in ETH. Also, if your customer accidentally paid you only part of a full amount, you can automatically ask them to make another payment.
\nThis is a method to get information about the current state of the API. If everything is OK, you will receive an \"OK\" message. Otherwise, you'll see some error.
\n","urlObject":{"protocol":"https","path":["v1","status"],"host":["api-sandbox","nowpayments","io"],"query":[],"variable":[]}},"response":[{"id":"0b368807-ee1c-454d-980c-41ce37aa6f4d","name":"1. Get API status","originalRequest":{"method":"GET","header":[],"url":"https://api-sandbox.nowpayments.io/v1/status"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 18 Apr 2019 13:37:08 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"16"},{"key":"Connection","value":"keep-alive"},{"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":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"4c97081ce9509700-FRA"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"OK\"\n}"}],"_postman_id":"5c2b8f84-73dc-41ff-aa4b-8d08a4556102"},{"name":"2. Get available currencies","id":"76140c5e-75ae-4a11-96f8-5ecc96c1e3cb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"This is a method for obtaining information about the cryptocurrencies available for payments. This depends on the cryptocurrency you choose for your particular store.
\n","urlObject":{"protocol":"https","path":["v1","currencies"],"host":["api-sandbox","nowpayments","io"],"query":[],"variable":[]}},"response":[{"id":"38a0f7a9-8e44-4cc2-9a13-6a865d575b5d","name":"2. Get available currencies","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"This is a method for calculating the approximate price in cryptocurrency for a given value in Fiat currency. You will need to provide the initial cost in the Fiat currency (amount, currency_from) and the necessary cryptocurrency (currency_to)\nCurrently following fiat currencies are available: usd, eur, nzd, brl.
\n","urlObject":{"protocol":"https","path":["v1","estimate"],"host":["api-sandbox","nowpayments","io"],"query":[{"key":"amount","value":"3999.5000"},{"key":"currency_from","value":"usd"},{"key":"currency_to","value":"btc"}],"variable":[]}},"response":[{"id":"1ba0bdc9-45c6-49c8-8a43-e25559dd2251","name":"3. Get estimate price","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"This 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:
\nList of available cases:
\nHere is the list of existing payment statuses:
\nCreates payment by invoice. With this method, your customer will be able to complete the payment without leaving your website.
Data must be sent as a JSON-object payload.
Required request fields:
List of available cases:
\nHere the list of available 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-sandbox","nowpayments","io"],"query":[{"key":"currency_from","value":"eth"},{"key":"currency_to","value":"btc"}],"variable":[]}},"response":[{"id":"7ce7dfd5-2cbe-42a3-84ec-ea99907270e2","name":"7. Get minimum payment amount","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"Creates a payment link. With this method, the customer is required to follow the generated url to complete the payment. Data must be sent as a JSON-object payload.
\nRequest fields:
\n(Required) Your NOWPayments API key
\n","type":"text"}],"url":"https://api-sandbox.nowpayments.io/v1/currencies?fixed_rate=true","description":"This is a method for obtaining information about all cryptocurrencies available for payments for your current setup of payout wallets.
\n","urlObject":{"path":["v1","currencies"],"host":["https://api-sandbox.nowpayments.io"],"query":[{"description":{"content":"(Optional) Returns avaliable currencies with minimum and maximum amount of the exchange.
\n","type":"text/plain"},"key":"fixed_rate","value":"true"}],"variable":[]}},"response":[{"id":"92e68a53-08f1-4f4b-8deb-8493cb011a76","name":"200","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{api-key}}","description":"(Required) Your NOWPayments API key","type":"text"}],"url":{"raw":"https://api.nowpayments.io/v1/currencies?fixed_rate=true","protocol":"https","host":["api","nowpayments","io"],"path":["v1","currencies"],"query":[{"key":"fixed_rate","value":"true","type":"text","description":"(Optional) Returns avaliable currencies with minimum and maximum amount of the exchange."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 22 Dec 2020 15:04:03 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"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":"072c9386e7000016693802b000000001"},{"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=njJG9MjxLKmoJsxN0xqpdp0MNZJmkCFhw4c9sIQz%2B97S%2FqQTBHWVp28uW4Hx3i1fWSQdR6w48evOdfYoN6u4o6MrXcV%2FZ5sLPQOQJ9ONwKuu4us%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":"605abb84abee1669-ARN"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"currencies\": [\n \"btg\",\n \"eth\",\n \"xmr\",\n \"zec\",\n \"xvg\",\n \"ada\",\n \"ltc\",\n \"bch\",\n \"qtum\",\n \"dash\",\n \"xlm\",\n \"xrp\",\n \"xem\",\n \"dgb\",\n \"lsk\",\n \"doge\",\n \"trx\",\n \"kmd\",\n \"rep\",\n \"bat\",\n \"ark\",\n \"waves\",\n \"bnb\",\n \"xzc\",\n \"nano\",\n \"tusd\",\n \"vet\",\n \"zen\",\n \"grs\",\n \"fun\",\n \"neo\",\n \"gas\",\n \"pax\",\n \"usdc\",\n \"ont\",\n \"xtz\",\n \"link\",\n \"rvn\",\n \"bnbmainnet\",\n \"zil\",\n \"bcd\",\n \"usdt\",\n \"usdterc20\",\n \"cro\",\n \"dai\",\n \"ht\",\n \"wabi\",\n \"busd\",\n \"algo\",\n \"usdttrc20\",\n \"gt\",\n \"stpt\",\n \"ava\",\n \"sxp\",\n \"uni\",\n \"okb\",\n \"btc\"\n ]\n}"}],"_postman_id":"4457b9c9-5886-4001-aaea-f12b86b30b69"},{"name":"Get available currencies (2nd method)","id":"393ba59d-e6d8-4466-95e4-91f39cd344b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{api-key}}","description":"(Required) Your NOWPayments API key
\n","type":"text"}],"url":"https://api-sandbox.nowpayments.io/v1/full-currencies","description":"This is a method to obtain detailed information about all cryptocurrencies available for payments.
\n","urlObject":{"path":["v1","full-currencies"],"host":["https://api-sandbox.nowpayments.io"],"query":[],"variable":[]}},"response":[{"id":"e3eb1b53-2ea4-4073-85d7-b58736b96139","name":"200","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{api-key}}","description":"(Required) Your NOWPayments API key","type":"text"}],"url":"https://api.nowpayments.io/v1/full-currencies"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 22 Dec 2020 15:04:03 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"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":"072c9386e7000016693802b000000001"},{"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=njJG9MjxLKmoJsxN0xqpdp0MNZJmkCFhw4c9sIQz%2B97S%2FqQTBHWVp28uW4Hx3i1fWSQdR6w48evOdfYoN6u4o6MrXcV%2FZ5sLPQOQJ9ONwKuu4us%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":"605abb84abee1669-ARN"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"\"currencies\": [\n {\n \"id\": 121,\n \"code\": \"AAVE\",\n \"name\": \"Aave\",\n \"enable\": true,\n \"wallet_regex\": \"^(0x)[0-9A-Fa-f]{40}$\",\n \"priority\": 127,\n \"extra_id_exists\": false,\n \"extra_id_regex\": null,\n \"logo_url\": \"/images/coins/aave.svg\",\n \"track\": true,\n \"cg_id\": \"aave\",\n \"is_maxlimit\": false,\n \"network\": \"eth\",\n \"smart_contract\": null,\n \"network_precision\": null\n }\n]"}],"_postman_id":"393ba59d-e6d8-4466-95e4-91f39cd344b6"},{"name":"Get available checked currencies","id":"def6c5ff-6931-4726-8ef1-6508b5487118","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{api-key}}","description":"(Required) Your NOWPayments API key
\n","type":"text"}],"url":"https://api-sandbox.nowpayments.io/v1/merchant/coins","description":"This is a method for obtaining information about the cryptocurrencies available for payments. Shows the coins you set as available for payments in the \"coins settings\" tab on your personal account.
\n","urlObject":{"path":["v1","merchant","coins"],"host":["https://api-sandbox.nowpayments.io"],"query":[],"variable":[]}},"response":[{"id":"5249623c-1768-402b-8000-70bbb00b1f29","name":"200","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{api-key}}","description":"(Required) Your NOWPayments API key","type":"text"}],"url":"https://api.nowpayments.io/v1/merchant/coins"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 22 Dec 2020 15:04:03 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"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":"072c9386e7000016693802b000000001"},{"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=njJG9MjxLKmoJsxN0xqpdp0MNZJmkCFhw4c9sIQz%2B97S%2FqQTBHWVp28uW4Hx3i1fWSQdR6w48evOdfYoN6u4o6MrXcV%2FZ5sLPQOQJ9ONwKuu4us%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":"605abb84abee1669-ARN"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"currencies\": [\n \"btg\",\n \"eth\",\n \"xmr\",\n \"zec\",\n \"xvg\",\n \"ada\",\n \"ltc\",\n \"bch\",\n \"qtum\",\n \"dash\",\n \"xlm\",\n \"xrp\",\n \"xem\",\n \"dgb\",\n \"lsk\",\n \"doge\",\n \"trx\",\n \"kmd\",\n \"rep\",\n \"bat\",\n \"ark\",\n \"waves\",\n \"bnb\",\n \"xzc\",\n \"nano\",\n \"tusd\",\n \"vet\",\n \"zen\",\n \"grs\",\n \"fun\",\n \"neo\",\n \"gas\",\n \"pax\",\n \"usdc\",\n \"ont\",\n \"xtz\",\n \"link\",\n \"rvn\",\n \"bnbmainnet\",\n \"zil\",\n \"bcd\",\n \"usdt\",\n \"usdterc20\",\n \"cro\",\n \"dai\",\n \"ht\",\n \"wabi\",\n \"busd\",\n \"algo\",\n \"usdttrc20\",\n \"gt\",\n \"stpt\",\n \"ava\",\n \"sxp\",\n \"uni\",\n \"okb\",\n \"btc\"\n ]\n}"}],"_postman_id":"def6c5ff-6931-4726-8ef1-6508b5487118"}],"id":"0c5010d4-b7f0-407f-be0b-cda4e3b071b6","_postman_id":"0c5010d4-b7f0-407f-be0b-cda4e3b071b6","description":""},{"name":"Mass payouts","item":[{"name":"Get balance","id":"69263a49-bff2-424d-ba0e-b1fd137ff767","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{api-key}}","description":"(Required) Your NOWPayments API key
\n","type":"text"}],"url":"https://api-sandbox.nowpayments.io/v1/balance","description":"This method returns your balance in different currencies.
\nThe response contains a list of currencies with two parameters:
\n(Required) Your NOWPayments API key
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"(Required) Your payload has to be JSON object\n
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"address\": \"0g033BbF609Ed876576735a02fa181842319Dd8b8F\", \n \"currency\": \"eth\", \n \"extra_id\":null\n}"},"url":"https://api-sandbox.nowpayments.io/v1/payout/validate-address","description":"This endpoint allows you to check if your payout address is valid and funds can be received there.
\nAvailable parameters:
\n(Required) Your authorization token
\n","type":"text"},{"key":"x-api-key","value":"{{api-key}}","description":"(Required) Your NOWPayments API key
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"(Required) Your payload has to be JSON object\n
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"payout_description\": \"description\",\n \"ipn_callback_url\": \"https://nowpayments.io\",\n \"withdrawals\": [\n {\n \"address\": \"TEmGwPeRTPiLFLVfBxXkSP91yc5GMNQhfS\",\n \"currency\": \"trx\",\n \"amount\": 200,\n \"ipn_callback_url\": \"https://nowpayments.io\"\n },\n {\n \"address\": \"0x1EBAeF7Bee7B3a7B2EEfC72e86593Bf15ED37522\",\n \"currency\": \"eth\",\n \"amount\": 0.1,\n \"ipn_callback_url\": \"https://nowpayments.io\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api-sandbox.nowpayments.io/v1/payout","description":"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:
\nwaiting;
\nprocessing;
\nsending;
\nfinished;
\nfailed;
\nrejected;
\nPlease, take note that you may request a single payout, but it still should be formatted as an array with the single element.
\n","urlObject":{"path":["v1","payout"],"host":["https://api-sandbox.nowpayments.io"],"query":[],"variable":[]}},"response":[{"id":"f82553bc-d61c-46ba-857a-d8bf26063067","name":"200","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}","description":"(Required) Your authorization token","type":"text"},{"key":"x-api-key","value":"{{api-key}}","description":"(Required) Your NOWPayments API key","type":"text"},{"key":"Content-Type","value":"application/json","description":"(Required) Your payload has to be JSON object\n ","type":"text"}],"body":{"mode":"raw","raw":"{\n \"ipn_callback_url\": \"https://nowpayments.io\",\n \"withdrawals\": [\n {\n \"address\": \"TEmGwPeRTPiLFLVfBxXkSP91yc5GMNQhfS\",\n \"currency\": \"trx\",\n \"amount\": 200,\n \"ipn_callback_url\": \"https://nowpayments.io\"\n },\n {\n \"address\": \"0x1EBAeF7Bee7B3a7B2EEfC72e86593Bf15ED37522\",\n \"currency\": \"eth\",\n \"amount\": 0.1,\n \"ipn_callback_url\": \"https://nowpayments.io\"\n },\n {\n \"address\": \"0x1EBAeF7Bee7B3a7B2EEfC72e86593Bf15ED37522\",\n \"currency\": \"usdc\",\n \"amount\": 1,\n \"fiat_amount\": 100,\n \"fiat_currency\": \"usd\",\n \"ipn_callback_url\": \"https://nowpayments.io\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.nowpayments.io/v1/payout"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n\t\"id\": \"5000000713\",\n\t\"withdrawals\": [\n {\n \"is_request_payouts\":false,\n \"id\": \"5000000000\",\n \"address\": \"TEmGwPeRTPiLFLVfBxXkSP91yc5GMNQhfS\",\n \"currency\": \"trx\",\n \"amount\": \"200\",\n \"batch_withdrawal_id\": \"5000000000\",\n \"ipn_callback_url\": \"https://nowpayments.io\",\n \"status\": \"WAITING\",\n \"extra_id\": null,\n \"hash\": null,\n \"error\": null,\n \"payout_description\": null,\n \"unique_external_id\": null,\n \"created_at\": \"2020-11-12T17:06:12.791Z\",\n \"requested_at\": null,\n \"updated_at\": null\n\n },\n {\n \"is_request_payouts\":false,\n \"id\": \"5000000001\",\n \"address\": \"0x1EBAeF7Bee7B3a7B2EEfC72e86593Bf15ED37522\",\n \"currency\": \"eth\",\n \"amount\": \"0.1\",\n \"batch_withdrawal_id\": \"5000000000\",\n \"ipn_callback_url\": \"https://nowpayments.io\",\n \"status\": \"WAITING\",\n \"extra_id\": null,\n \"hash\": null,\n \"error\": null,\n \"payout_description\": null,\n \"unique_external_id\": null,\n \"createdAt\": \"2020-11-12T17:06:12.791Z\",\n \"requestedAt\": null,\n \"updatedAt\": null\n },\n {\n \"is_request_payouts\":false,\n \"id\": \"5000000002\",\n \"address\": \"0x1EBAeF7Bee7B3a7B2EEfC72e86593Bf15ED37522\",\n \"currency\": \"usdc\",\n \"amount\": \"99.84449793\",\n \"fiat_amount\": \"100\",\n \"fiat_currency\": \"usd\",\n \"batch_withdrawal_id\": \"5000000000\",\n \"ipn_callback_url\": \"https://nowpayments.io\",\n \"status\": \"WAITING\",\n \"extra_id\": null,\n \"hash\": null,\n \"error\": null,\n \"payout_description\": null,\n \"unique_external_id\": null,\n \"createdAt\": \"2020-11-12T17:06:12.791Z\",\n \"requestedAt\": null,\n \"updatedAt\": null\n }\n ]\n}"}],"_postman_id":"5157142d-e1fd-4afb-a871-4709a73f48b9"},{"name":"Verify payout","id":"2e1aa4f9-bef4-4189-aca5-499ef05d62b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}","description":"(Required) Your authorization token
\n","type":"text"},{"key":"x-api-key","value":"{{api-key}}","description":"(Required) Your NOWPayments API key
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"(Required) Your payload has to be JSON object\n
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"verification_code\": \"123456\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-sandbox.nowpayments.io/v1/payout/:batch-withdrawal-id/verify","description":"This 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\nBatch withdrawal ID of the batch you want to verify
\n","type":"text/plain"},"type":"any","value":null,"key":"batch-withdrawal-id"}]}},"response":[{"id":"e0c2b946-8756-4f01-84d4-841ac48c298c","name":"200","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}","description":"(Required) Your authorization token","type":"text"},{"key":"x-api-key","value":"{{api-key}}","description":"(Required) Your NOWPayments API key","type":"text"},{"key":"Content-Type","value":"application/json","description":"(Required) Your payload has to be JSON object\n ","type":"text"}],"body":{"mode":"raw","raw":"{\n \"verification_code\": \"123456\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.nowpayments.io/v1/payout/:withdrawals-id/verify","protocol":"https","host":["api","nowpayments","io"],"path":["v1","payout",":withdrawals-id","verify"],"variable":[{"key":"withdrawals-id","value":"5000000191","description":"Batch withdrawal ID of the batch you want to verify"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"OK"}],"_postman_id":"2e1aa4f9-bef4-4189-aca5-499ef05d62b0"},{"name":"Get payout status","id":"4775ac65-44b9-4a08-bf2d-f471e91a9f8f","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"host":true,"user-agent":true,"accept":true,"accept-encoding":true,"connection":true}},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{api-key}}","description":"(Required) Your NOWPayments API key
\n","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://api-sandbox.nowpayments.io/v1/payout/:payout_id","description":"Get 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:
\nId of payout you want to request details for.
\n","type":"text/plain"},"type":"any","value":null,"key":"payout_id"}]}},"response":[{"id":"b4c1a56c-5d47-4aff-a1f3-bf0144347d55","name":"200","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{api-key}}","description":"(Required) Your NOWPayments API key","type":"text"}],"url":{"raw":"https://api.nowpayments.io/v1/payout/:payout_id","protocol":"https","host":["api","nowpayments","io"],"path":["v1","payout",":payout_id"],"variable":[{"key":"payout_id","value":"","description":"Id of payout you want to request details for."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"(Required) Your NOWPayments API key
\n","type":"text"}],"url":"https://api-sandbox.nowpayments.io/v1/payout?batch_id=123456789&status=sending&order_by=id&order=asc&date_from&date_to&limit=20&page=0","description":"This endpoint allows you to get a list of your payouts.
\nThe list of available parameters:
\n(Required) Your NOWPayments API key
\n","type":"text"}],"url":"https://api.nowpayments.io/v1/payout-withdrawal/min-amount/:coin","description":"This endpoint shows you current minimal amount for withdrawals.
\nParameters:
\n:coin - ticker of the coin.
\n","urlObject":{"protocol":"https","path":["v1","payout-withdrawal","min-amount",":coin"],"host":["api","nowpayments","io"],"query":[],"variable":[{"id":"fe601568-a96a-4bde-9483-1498d8094645","type":"any","value":null,"key":"coin"}]}},"response":[{"id":"1207ee26-8b0a-4f10-bb3b-ca52f78eaee7","name":"Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{api-key}}","description":"(Required) Your NOWPayments API key","type":"text"}],"url":"https://api.nowpayments.io/v1/payout-withdrawal/min-amount/btc"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": 0.00002496\n}"}],"_postman_id":"dd0d13be-e64e-430e-ad15-64ab59ee0fd9"},{"name":"Get withdrawal fee estimate","id":"c4e87f79-63a1-4a06-a9b1-1524ab069898","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{api-key}}","description":"(Required) Your NOWPayments API key
\n","type":"text"}],"url":"https://api-sandbox.nowpayments.io/v1/payout/fee?currency=USDTTRC20&amount=500","description":"This endpoint will show you the estimated amount of network fee for payout.
\nPlease note that:
\nThis endpoint will show you the fee estimate for the moment of the request is done. Fee itself is dynamic and may change over a brief moment of time.
\nThe fee depends on the blockchain itself and its congestion. We cannot affect it in any way nor control or hold it.
\nThe actual fee will be calcualated at the moment of payout processing. Please be aware that it can differ from estimate.
\nThe coin ticker of your payout
\n","type":"text/plain"},"key":"currency","value":"USDTTRC20"},{"description":{"content":"The desired amount of your payout
\n","type":"text/plain"},"key":"amount","value":"500"}],"variable":[]}},"response":[{"id":"a44c30fb-d7fc-4c0d-8823-5031b1f6a62b","name":"200","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{api-key}}","description":"(Required) Your NOWPayments API key","type":"text"}],"url":{"raw":"https://api-sandbox.nowpayments.io/v1/payout/fee?currency=USDTTRC20&amount=500","host":["https://api-sandbox.nowpayments.io"],"path":["v1","payout","fee"],"query":[{"key":"currency","value":"USDTTRC20","description":"The coin ticker of your payout"},{"key":"amount","value":"500","description":"The desired amount of your payout"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"currency\": \"USDTTRC20\",\n \"fee\": 1.32765969\n}"}],"_postman_id":"c4e87f79-63a1-4a06-a9b1-1524ab069898"}],"id":"23dece3a-8d3d-405f-8305-26f1223d1103","description":"This 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","_postman_id":"23dece3a-8d3d-405f-8305-26f1223d1103"},{"name":"Conversions","item":[{"name":"Create conversion","id":"101a1657-fb13-4064-9194-f89d74f59f2e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}","description":"(Required) Your authorization token
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"(Required) Your payload has to be JSON object\n
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": 50,\n \"from_currency\": \"usdttrc20\",\n \"to_currency\": \"USDTERC20\"\n}"},"url":"https://api-sandbox.nowpayments.io/v1/conversion","description":"This endpoint allows you to create conversions within your custody account.
\nParameters:
\nThe list of available statuses:
\n(Required) Your authorization token
\n","type":"text"}],"url":"https://api-sandbox.nowpayments.io/v1/conversion/:conversion_id","urlObject":{"path":["v1","conversion",":conversion_id"],"host":["https://api-sandbox.nowpayments.io"],"query":[],"variable":[{"id":"30d42282-1cab-4020-9d3f-fb3f6f951b8c","type":"any","value":null,"key":"conversion_id"}]}},"response":[{"id":"4cf4377e-1fb1-4af7-a3dc-0ecab078ffca","name":"200","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}","description":"(Required) Your authorization token","type":"text"}],"url":{"raw":"https://api-sandbox.nowpayments.io/v1/conversion/:conversion_id","host":["https://api-sandbox.nowpayments.io"],"path":["v1","conversion",":conversion_id"],"variable":[{"key":"conversion_id","value":null}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"result\": {\n \"id\": \"1327866232\",\n \"status\": \"WAITING\",\n \"from_currency\": \"USDTTRC20\",\n \"to_currency\": \"USDTERC20\",\n \"from_amount\": 50,\n \"to_amount\": 50,\n \"created_at\": \"2023-03-05T08:18:30.384Z\",\n \"updated_at\": \"2023-03-05T08:41:30.201Z\"\n }\n}"}],"_postman_id":"73945d36-7d67-4b3b-baf9-4d5d4df09cbc"},{"name":"Get list of conversions","id":"7313571a-ec20-48dc-b705-8ca0a0ef18c6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}","description":"(Required) Your authorization token
\n","type":"text"}],"url":"https://api-sandbox.nowpayments.io/v1/conversion","description":"This endpoint returns you the list of your conversions with the essential info for each one.
\nYou can query only for certain conversions using the following parameters to filter the result:
\nConversions API allows you to exchange coins within your custody user account.
\n","_postman_id":"473b666a-8bd0-482f-b5a1-261ca4c81fb2"},{"name":"Custody","item":[{"name":"Create new user account","id":"a46d6496-5120-4b0d-ba13-2e9887429924","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}","description":"(Required) Your authorization token
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"(Required) Your payload has to be JSON object\n
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"test1\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-sandbox.nowpayments.io/v1/sub-partner/balance","description":"This is a method to create an account for your user. After this you'll be able to generate a payment(/v1/sub-partner/payment) or deposit(/v1/sub-partner/deposit) for topping up its balance as well as withdraw funds from it.
\nBody:
\nName : a unique user identifier; you can use any string which doesn’t exceed 30 characters (but NOT an email)
\n","urlObject":{"path":["v1","sub-partner","balance"],"host":["https://api-sandbox.nowpayments.io"],"query":[],"variable":[]}},"response":[{"id":"685c5c84-8764-473c-ba2b-43f8d240af50","name":"200","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}","description":"(Required) Your authorization token","type":"text"},{"key":"Content-Type","value":"application/json","description":"(Required) Your payload has to be JSON object\n ","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"test1\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-sandbox.nowpayments.io/v1/sub-partner/balance"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"result\": {\n \"id\": \"1515573197\",\n \"name\": \"test1\",\n \"created_at\": \"2022-10-09T21:56:33.754Z\",\n \"updated_at\": \"2022-10-09T21:56:33.754Z\"\n }\n}"},{"id":"9c4af028-c252-4633-9eae-98eba34aea67","name":"400","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}","description":"(Required) Your authorization token","type":"text"},{"key":"Content-Type","value":"application/json","description":"(Required) Your payload has to be JSON object\n ","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"test1\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-sandbox.nowpayments.io/v1/sub-partner/balance"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": false,\n \"statusCode\": 400,\n \"code\": \"BAD_REQUEST\",\n \"message\": \"sub partner already exist\"\n}"}],"_postman_id":"a46d6496-5120-4b0d-ba13-2e9887429924"},{"name":"Create recurring payments","id":"0e4cb9b5-f814-41b5-b9e3-cce1fec098fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}","description":"(Required) Your authorization token
\n","type":"text"},{"key":"x-api-key","value":"{{api-key}}","description":"(Required) Your NOWPayments API key
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"(Required) Your payload has to be JSON object\n
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"subscription_plan_id\": 76215585,\n \"sub_partner_id\": 111111,\n \"email\": \"your email\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-sandbox.nowpayments.io/v1/subscriptions","description":"This method creates a recurring charge from a user account.
\nThe funds are transferred from a user account to your account when a new payment is generated or a paid period is coming to an end. The amount depends on the plan a customer chooses.
If you specify a particular currency your customer should pay in, and their account have enough funds stored in it, the amount will be charged automatically. In case a customer has other currency on their account, the equivalent sum will be charged.
Here is the list of available statuses:
\nPlease note:
\nSubscribtion amount will be deducted from your sub-user balance in any currency available; i.e. if your subscribtion plan is set up for 100USDTTRC20/month, and your customer has 100USDCMATIC on balance, USDCMATIC will be deducted and transferred to your custody.
\nYou can convert it manually using our conversions endpoints through api or in your Custody dashboard.
\n","urlObject":{"path":["v1","subscriptions"],"host":["https://api-sandbox.nowpayments.io"],"query":[],"variable":[]}},"response":[{"id":"abc0d8aa-2288-4995-b806-415834dd2c3d","name":"200","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}","description":"(Required) Your authorization token","type":"text"},{"key":"x-api-key","value":"{{api-key}}","description":"(Required) Your NOWPayments API key","type":"text"},{"key":"Content-Type","value":"application/json","description":"(Required) Your payload has to be JSON object\n ","type":"text"}],"body":{"mode":"raw","raw":"{\n \"subscription_plan_id\": 76215585,\n \"sub_partner_id\": 111111\n}","options":{"raw":{"language":"json"}}},"url":"https://api-sandbox.nowpayments.io/v1/subscriptions"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"result\": {\n \"id\": \"1515573197\",\n \"subscription_plan_id\": \"76215585\",\n \"is_active\": false,\n \"status\": \"WAITING_PAY\",\n \"expire_date\": \"2022-10-09T22:15:50.808Z\",\n \"subscriber\": {\n \"sub_partner_id\": \"111111\"\n },\n \"created_at\": \"2022-10-09T22:15:50.808Z\",\n \"updated_at\": \"2022-10-09T22:15:50.808Z\"\n }\n}"}],"_postman_id":"0e4cb9b5-f814-41b5-b9e3-cce1fec098fd"},{"name":"Get user balance","id":"4bf44fa2-44d8-4de1-9387-ddbfecd08903","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"{{api-key}}","description":"(Required) Your NOWPayments API key
\n","type":"text"}],"url":"https://api-sandbox.nowpayments.io/v1/sub-partner/balance/:id","description":"This request can be made only from a whitelisted IP.
If IP whitelisting is disabled, this request can be made by any user that has an API key.
ID of sub-user for balance request
\n","type":"text/plain"},"type":"any","value":null,"key":"id"}]}},"response":[{"id":"f954d45a-f4ce-44c4-bac8-2cce20567fae","name":"200","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{api-key}}","description":"(Required) Your NOWPayments API key","type":"text"}],"url":"https://api-sandbox.nowpayments.io/v1/sub-partner/balance/111394288"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"result\": {\n \"subPartnerId\": \"111394288\",\n \"balances\": {\n \"usddtrc20\": {\n \"amount\": 0.7,\n \"pendingAmount\": 0\n },\n \"usdtbsc\": {\n \"amount\": 1.0001341847350678,\n \"pendingAmount\": 0\n }\n }\n }\n}"}],"_postman_id":"4bf44fa2-44d8-4de1-9387-ddbfecd08903"},{"name":"Get users","id":"b0ed1f65-7b7f-4067-b943-55428a546aa3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{token}}","description":"(Required) Your authorization token
\n","type":"text"}],"url":"https://api-sandbox.nowpayments.io/v1/sub-partner?id=111&offset=1&limit=10&order=DESC","description":"This method returns the entire list of your users.
\n","urlObject":{"path":["v1","sub-partner"],"host":["https://api-sandbox.nowpayments.io"],"query":[{"description":{"content":"int or array of int (optional)
\n","type":"text/plain"},"key":"id","value":"111"},{"description":{"content":"(optional) default 0
\n","type":"text/plain"},"key":"offset","value":"1"},{"description":{"content":"(optional) default 10
\n","type":"text/plain"},"key":"limit","value":"10"},{"description":{"content":"ASC / DESC (optional) default ASC
\n","type":"text/plain"},"key":"order","value":"DESC"}],"variable":[]}},"response":[{"id":"ca790f3c-ff73-49d8-8834-8bb5aa6e9bee","name":"200","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}","description":"(Required) Your authorization token","type":"text"}],"url":{"raw":"https://api-sandbox.nowpayments.io/v1/sub-partner?id=111&offset=0&limit=10&order=DESC","host":["https://api-sandbox.nowpayments.io"],"path":["v1","sub-partner"],"query":[{"key":"id","value":"111","description":"int or array of int (optional)"},{"key":"offset","value":"0","description":"(optional) default 0"},{"key":"limit","value":"10","description":"(optional) default 10"},{"key":"order","value":"DESC","description":"ASC / DESC (optional) default ASC"}]}},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"result\": [\n {\n \"id\": \"111394288\",\n \"name\": \"test\",\n \"created_at\": \"2022-10-06T16:42:47.352Z\",\n \"updated_at\": \"2022-10-06T16:42:47.352Z\"\n },\n {\n \"id\": \"1515573197\",\n \"name\": \"test1\",\n \"created_at\": \"2022-10-09T21:56:33.754Z\",\n \"updated_at\": \"2022-10-09T21:56:33.754Z\"\n }\n ],\n \"count\": 2\n}"}],"_postman_id":"b0ed1f65-7b7f-4067-b943-55428a546aa3"},{"name":"Get all transfers","id":"1e675237-7d81-4182-88f2-c89b042603b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}","description":"(Required) Your authorization token
\n","type":"text"}],"url":"https://api-sandbox.nowpayments.io/v1/sub-partner/transfers?id=111&status=CREATED&limit=10&offset=1&order=ASC","description":"Returns the entire list of transfers created by your users.
\nThe list of available statuses:
\nint or array of int (optional)
\n","type":"text/plain"},"key":"id","value":"111"},{"description":{"content":"string or array of string \n\"WAITING\"/\"CREATED\"/\"FINISHED\"/\"REJECTED\"\n(optional)
\n","type":"text/plain"},"key":"status","value":"CREATED"},{"description":{"content":"(optional) default 10
\n","type":"text/plain"},"key":"limit","value":"10"},{"description":{"content":"(optional) default 0
\n","type":"text/plain"},"key":"offset","value":"1"},{"description":{"content":"ASC / DESC (optional) default ASC
\n","type":"text/plain"},"key":"order","value":"ASC"}],"variable":[]}},"response":[{"id":"4e71e752-4cb7-4b2b-be06-bd769cec4c11","name":"200","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}","description":"(Required) Your authorization token","type":"text"}],"url":{"raw":"https://api-sandbox.nowpayments.io{/v1/sub-partner/transfers?status=FINISHED&limit=10&offset=0&order=ASC","host":["https://api-sandbox.nowpayments.io{"],"path":["v1","sub-partner","transfers"],"query":[{"key":"id","value":"111","description":"int or array of int (optional)","disabled":true},{"key":"status","value":"FINISHED","description":"string or array of string \n\"WAITING\"/\"CREATED\"/\"FINISHED\"/\"REJECTED\"\n(optional)"},{"key":"limit","value":"10","description":"(optional) default 10"},{"key":"offset","value":"0","description":"(optional) default 0"},{"key":"order","value":"ASC"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"result\": [\n {\n \"id\": \"111394288\",\n \"from_sub_id\": \"5209391548\",\n \"to_sub_id\": \"111394288\",\n \"status\": \"FINISHED\",\n \"created_at\": \"2022-10-09T18:53:21.975Z\",\n \"updated_at\": \"2022-10-09T18:55:00.696Z\",\n \"amount\": \"1\",\n \"currency\": \"usdtbsc\"\n },\n {\n \"id\": \"148427051\",\n \"from_sub_id\": \"111394288\",\n \"to_sub_id\": \"5209391548\",\n \"status\": \"FINISHED\",\n \"created_at\": \"2022-10-09T19:08:32.440Z\",\n \"updated_at\": \"2022-10-09T19:10:01.209Z\",\n \"amount\": \"1\",\n \"currency\": \"usdtbsc\"\n },\n {\n \"id\": \"1631380403\",\n \"from_sub_id\": \"5209391548\",\n \"to_sub_id\": \"111394288\",\n \"status\": \"FINISHED\",\n \"created_at\": \"2022-10-09T21:19:51.936Z\",\n \"updated_at\": \"2022-10-09T21:21:00.671Z\",\n \"amount\": \"2\",\n \"currency\": \"usdtbsc\"\n },\n {\n \"id\": \"1167886259\",\n \"from_sub_id\": \"5209391548\",\n \"to_sub_id\": \"111394288\",\n \"status\": \"FINISHED\",\n \"created_at\": \"2022-10-09T21:22:17.125Z\",\n \"updated_at\": \"2022-10-09T21:24:00.662Z\",\n \"amount\": \"2\",\n \"currency\": \"usdtbsc\"\n },\n {\n \"id\": \"48471014\",\n \"from_sub_id\": \"111394288\",\n \"to_sub_id\": \"5209391548\",\n \"status\": \"FINISHED\",\n \"created_at\": \"2022-10-09T21:25:29.231Z\",\n \"updated_at\": \"2022-10-09T21:27:00.676Z\",\n \"amount\": \"1\",\n \"currency\": \"usdtbsc\"\n },\n {\n \"id\": \"1304149238\",\n \"from_sub_id\": \"111394288\",\n \"to_sub_id\": \"5209391548\",\n \"status\": \"FINISHED\",\n \"created_at\": \"2022-10-09T21:54:57.713Z\",\n \"updated_at\": \"2022-10-09T21:56:01.056Z\",\n \"amount\": \"1\",\n \"currency\": \"usdtbsc\"\n },\n {\n \"id\": \"327209161\",\n \"from_sub_id\": \"111394288\",\n \"to_sub_id\": \"1515573197\",\n \"status\": \"FINISHED\",\n \"created_at\": \"2022-10-09T22:09:02.181Z\",\n \"updated_at\": \"2022-10-09T22:10:01.853Z\",\n \"amount\": \"1\",\n \"currency\": \"usdtbsc\"\n }\n ],\n \"count\": 7\n}"}],"_postman_id":"1e675237-7d81-4182-88f2-c89b042603b8"},{"name":"Get transfer","id":"39136edc-294f-4d86-af9a-8969f90d242f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}","description":"(Required) Your authorization token
\n","type":"text"}],"url":"https://api-sandbox.nowpayments.io/v1/sub-partner/transfer/:id","description":"Get the actual information about the transfer. You need to provide the transfer ID in the request.
\nThe list of available statuses:
\n(Required) Your authorization token
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"(Required) Your payload has to be JSON object\n
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"currency\": \"trx\",\n \"amount\": 0.3,\n \"from_id\": \"1111111\",\n \"to_id\": \"1111111\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-sandbox.nowpayments.io/v1/sub-partner/transfer","description":"This method allows creating transfers between users' accounts.
You can check the transfer's status using Get transfer method.
The list of available statuses:
\n(Required) Your authorization token
\n","type":"text"},{"key":"x-api-key","value":"{{api-key}}","description":"(Required) Your NOWPayments API key
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"(Required) Your payload has to be JSON object\n
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"currency\": \"trx\",\n \"amount\": 0.3,\n \"sub_partner_id\": \"1631380403\",\n \"is_fixed_rate\": false,\n \"is_fee_paid_by_user\":false,\n \"ipn_callback_url\": \"https://...url\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-sandbox.nowpayments.io/v1/sub-partner/payment","description":"This method allows you to top up a user account with a general payment.
You can check the actual payment status by using GET 9 Get payment status request.
(Required) Your authorization token
\n","type":"text"}],"url":"https://api-sandbox.nowpayments.io/v1/sub-partner/payments","description":"limit - amount of listed results
page - set the offset for listed results
id - filter by payment ID
pay_currency - filter by deposit currency
status - filter by status
sub_partner_id - filter by sub-partner ID;
date_from - filter by date (from);
date_to - filter by date (to);
orderBy - set the order for listed results (asc, desc);
sortBy - sort results by 'id', 'status', 'pay_currency', 'created_at', 'updated_at';
(Required) Your authorization token
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"(Required) Your payload has to be JSON object\n
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"currency\": \"trx\",\n \"amount\": 0.3,\n \"sub_partner_id\": \"1631380403\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-sandbox.nowpayments.io/v1/sub-partner/deposit","description":"This is a method for transferring funds from your master account to a user's one.
The actual information about the transfer's status can be obtained via Get transfer method.
The list of available statuses:
\n(Required) Your authorization token
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"(Required) Your payload has to be JSON object\n
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"currency\": \"trx\",\n \"amount\": 0.3,\n \"sub_partner_id\": \"1631380403\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-sandbox.nowpayments.io/v1/sub-partner/write-off","description":"With this method you can withdraw funds from a user's account and transfer them to your master account.
\nThe actual status of the transaction can be checked with Get transfer method.
The list of available statuses:
\nNOWPayments allows you to create deposit accounts for your users, enabling full-fledged crypto billing solution.
\n","_postman_id":"e49ff270-f097-49aa-bdb3-917d86da9625"},{"name":"Recurring Payments API (Email Subscriptions)","item":[{"name":"Create plan","id":"ba0313ed-a668-496c-96f9-e55bdccf0c8c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{token}}","description":"(Required) Your authorization token
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"(Required) Your payload has to be JSON object\n
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"second sub plan\",\n \"interval_day\": 3,\n \"amount\": 1,\n \"currency\" : \"usd\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-sandbox.nowpayments.io/v1/subscriptions/plans","description":"This is the method to create a Recurring Payments plan. Every plan has its unique ID which is required for generating separate payments.
\nAvailable parameters:
\"title\": the name of your recurring payments plan;
\"interval_day\": recurring payments duration in days;
\"amount\" : amount of funds paid in fiat;
\"currency\" : fiat currency ticker used for price;
\"ipn_callback_url\" : your IPN_callback url;
\"success_url\" : url user got redirected in case payment was successful;
\"cancel_url\" : url user got redirected in case payment was cancelled;
\"partially_paid_url\" : url user got redirected in case payment was paid not in full amount;
(Required) Your authorization token
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"(Required) Your payload has to be JSON object\n
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"test plan\",\n \"interval_day\": 1,\n \"amount\": 2,\n \"currency\": \"usd\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-sandbox.nowpayments.io/v1/subscriptions/plans/:plan-id","description":"This method allows you to add necessary changes to a created plan. They won’t affect users who have already paid; however, the changes will take effect when a new payment is to be made.
\n","urlObject":{"path":["v1","subscriptions","plans",":plan-id"],"host":["https://api-sandbox.nowpayments.io"],"query":[],"variable":[{"id":"1691eb9d-6039-4c4d-9579-0c6d8cfe0768","type":"any","value":null,"key":"plan-id"}]}},"response":[{"id":"9c3d672c-0470-414c-8f0a-4b1df733be00","name":"200","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{token}}","description":"(Required) Your authorization token","type":"text"},{"key":"Content-Type","value":"application/json","description":"(Required) Your payload has to be JSON object\n ","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"test plan\",\n \"interval_day\": 1,\n \"amount\": 2,\n \"currency\": \"usd\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api-sandbox.nowpayments.io/v1/subscriptions/plans/:plan-id","host":["https://api-sandbox.nowpayments.io"],"path":["v1","subscriptions","plans",":plan-id"],"variable":[{"key":"plan-id","value":"76215585"}]}},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"result\": {\n \"id\": \"76215585\",\n \"title\": \"test plan\",\n \"interval_day\": \"1\",\n \"ipn_callback_url\": null,\n \"success_url\": null,\n \"cancel_url\": null,\n \"partially_paid_url\": null,\n \"amount\": 2,\n \"currency\": \"USD\",\n \"created_at\": \"2022-10-04T16:10:06.214Z\",\n \"updated_at\": \"2022-10-04T16:10:06.214Z\"\n }\n}"}],"_postman_id":"568742be-344e-41fd-8e2b-2167cda206c7"},{"name":"Get one plan","id":"3e8ca98d-b1a7-41c4-9ba7-e21459c6fc30","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{api-key}}","description":"(Required) Your NOWPayments API key
\n","type":"text"}],"url":"https://api-sandbox.nowpayments.io/v1/subscriptions/plans/:plan-id","description":"This method allows you to obtain information about your payment plan (you need to specify your payment plan id in the request).
\n","urlObject":{"path":["v1","subscriptions","plans",":plan-id"],"host":["https://api-sandbox.nowpayments.io"],"query":[],"variable":[{"id":"2875d50d-3107-4500-9d04-022b092dfdfa","type":"any","value":null,"key":"plan-id"}]}},"response":[{"id":"a2fd91cb-8b74-428e-84d2-e238e180aabd","name":"200","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{api-key}}","description":"(Required) Your NOWPayments API key","type":"text"}],"url":{"raw":"https://api-sandbox.nowpayments.io/v1/subscriptions/plans/:plan-id","host":["https://api-sandbox.nowpayments.io"],"path":["v1","subscriptions","plans",":plan-id"],"variable":[{"key":"plan-id","value":"76215585"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"result\": {\n \"id\": \"76215585\",\n \"title\": \"test plan\",\n \"interval_day\": \"1\",\n \"ipn_callback_url\": null,\n \"success_url\": null,\n \"cancel_url\": null,\n \"partially_paid_url\": null,\n \"amount\": 2,\n \"currency\": \"USD\",\n \"created_at\": \"2022-10-04T16:10:06.214Z\",\n \"updated_at\": \"2022-10-04T16:10:06.214Z\"\n }\n}"},{"id":"c7f88122-12a4-4b34-a3d7-a3c3387e2a7a","name":"404","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{api-key}}","description":"(Required) Your NOWPayments API key","type":"text"}],"url":{"raw":"https://api-sandbox.nowpayments.io/v1/subscriptions/plans/:plan-id","host":["https://api-sandbox.nowpayments.io"],"path":["v1","subscriptions","plans",":plan-id"],"variable":[{"key":"plan-id","value":"11111"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": false,\n \"statusCode\": 404,\n \"code\": \"NOT_FOUND\",\n \"message\": \"subscription plan not found\"\n}"}],"_postman_id":"3e8ca98d-b1a7-41c4-9ba7-e21459c6fc30"},{"name":"Get all plans","id":"ce6108f5-e5fd-476c-b7f4-ba4d5cca2ebc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"{{api-key}}","description":"(Required) Your NOWPayments API key
\n","type":"text"}],"url":"https://api-sandbox.nowpayments.io/v1/subscriptions/plans?limit=10&offset=3","description":"This method allows you to obtain information about all the payment plans you’ve created.
\n","urlObject":{"path":["v1","subscriptions","plans"],"host":["https://api-sandbox.nowpayments.io"],"query":[{"description":{"content":"Number
\n","type":"text/plain"},"key":"limit","value":"10"},{"description":{"content":"Number
\n","type":"text/plain"},"key":"offset","value":"3"}],"variable":[]}},"response":[{"id":"9a633105-9e9a-4978-9841-c1419a94b2e5","name":"200","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{api-key}}","description":"(Required) Your NOWPayments API key","type":"text"}],"url":{"raw":"https://api-sandbox.nowpayments.io/v1/subscriptions/plans?limit=10&offset=3","host":["https://api-sandbox.nowpayments.io"],"path":["v1","subscriptions","plans"],"query":[{"key":"limit","value":"10"},{"key":"offset","value":"3"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"result\": [\n {\n \"id\": \"76215585\",\n \"title\": \"second sub plan\",\n \"interval_day\": \"3\",\n \"ipn_callback_url\": null,\n \"success_url\": null,\n \"cancel_url\": null,\n \"partially_paid_url\": null,\n \"amount\": 0.1,\n \"currency\": \"USD\",\n \"created_at\": \"2022-10-04T16:10:06.214Z\",\n \"updated_at\": \"2022-10-04T16:10:06.214Z\"\n },\n {\n \"id\": \"1062307590\",\n \"title\": \"second sub plan\",\n \"interval_day\": \"1\",\n \"ipn_callback_url\": null,\n \"success_url\": null,\n \"cancel_url\": null,\n \"partially_paid_url\": null,\n \"amount\": 0.5,\n \"currency\": \"USD\",\n \"created_at\": \"2022-10-04T16:28:55.423Z\",\n \"updated_at\": \"2022-10-04T16:28:55.423Z\"\n }\n ],\n \"count\": 2\n}"}],"_postman_id":"ce6108f5-e5fd-476c-b7f4-ba4d5cca2ebc"},{"name":"Create an email subscription","id":"2a54a9fb-7900-40a1-ad49-03c22dc08249","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}","description":"(Required) Your authorization token
\n","type":"text"},{"key":"x-api-key","value":"{{api-key}}","description":"(Required) Your NOWPayments API key
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"(Required) Your payload has to be JSON object\n
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"subscription_plan_id\": 76215585,\n \"email\": \"test@example.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-sandbox.nowpayments.io/v1/subscriptions","description":"This method allows you to send payment links to your customers via email. A day before the paid period ends, the customer receives a new letter with a new payment link.
\nsubscription_plan_id - the ID of the payment plan your customer chooses; such params as the duration and amount will be defined by this ID;email - your customer’s email to which the payment links will be sent;
(Required) Your NOWPayments API key
\n","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api-sandbox.nowpayments.io/v1/subscriptions?status=PAID&subscription_plan_id=111394288&is_active=false&limit=10&offset=0","description":"The method allows you to view the entire list of recurring payments filtered by payment status and/or payment plan id
\nAvailable parameters:
\nHere is the list of available statuses:
\n\"WAITING_PAY\" / \"PAID\" / \"PARTIALLY_PAID\" / \"EXPIRED\"
\n","type":"text/plain"},"key":"status","value":"PAID"},{"key":"subscription_plan_id","value":"111394288"},{"description":{"content":"true / false
\n","type":"text/plain"},"key":"is_active","value":"false"},{"key":"limit","value":"10"},{"key":"offset","value":"0"}],"variable":[]}},"response":[{"id":"2ab14410-8efe-45fa-b1e4-fa0fcc99aaeb","name":"200","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{api-key}}","description":"(Required) Your NOWPayments API key","type":"text"}],"url":{"raw":"https://api-sandbox.nowpayments.io/v1/subscriptions?status=PAID&subscription_plan_id=111394288&is_active=false&limit=10&offset=0","host":["https://api-sandbox.nowpayments.io"],"path":["v1","subscriptions"],"query":[{"key":"status","value":"PAID","description":"\"WAITING_PAY\" / \"PAID\" / \"PARTIALLY_PAID\" / \"EXPIRED\""},{"key":"subscription_plan_id","value":"111394288"},{"key":"is_active","value":"false","description":"true / false"},{"key":"limit","value":"10"},{"key":"offset","value":"0"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"result\": [\n {\n \"id\": \"1515573197\",\n \"subscription_plan_id\": \"111394288\",\n \"is_active\": true,\n \"status\": \"PAID\",\n \"expire_date\": \"2022-10-11T00:02:00.025Z\",\n \"subscriber\": {\n \"sub_partner_id\": \"111394288\"\n },\n \"created_at\": \"2022-10-09T22:15:50.808Z\",\n \"updated_at\": \"2022-10-09T22:15:50.808Z\"\n },\n {\n \"id\": \"111394288\",\n \"subscription_plan_id\": \"111394288\",\n \"is_active\": false,\n \"status\": \"WAITING_PAY\",\n \"expire_date\": \"2022-10-07T16:46:00.910Z\",\n \"subscriber\": {\n \"email\": \"test@example.com\"\n },\n \"created_at\": \"2022-10-06T16:40:28.880Z\",\n \"updated_at\": \"2022-10-06T16:40:28.880Z\"\n }\n ],\n \"count\": 2\n}"}],"_postman_id":"0c22663a-84ea-4a41-a5e5-c3783feea89e"},{"name":"Get one recurring payment","id":"cacaef13-16ed-4587-a1c3-7907b4b03aba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{api-key}}","description":"(Required) Your NOWPayments API key
\n","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api-sandbox.nowpayments.io/v1/subscriptions/:sub_id","description":"Get information about a particular recurring payment via its ID.
\nHere is the list of available statuses:
\n(Required) Your authorization token
\n","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api-sandbox.nowpayments.io/v1/subscriptions/:sub_id","description":"Completely removes a particular payment from the recurring payment plan.
You need to specify the payment plan id in the request.
Streamline your workflows by assigning payments to your customers on a regular basis with NOWPayments.
This feature involves creating a plan for payments and individual recurring payments for each user.
First you need to create a Recurring Payment plan: