NOWPayments

NOWPayments API

NOWPayments is a non-custodial cryptocurrency payment processing platform. Accept payments in a wide range of cryptos and get them instantly converted into a…

Finance & banking#openapi#financial

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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.

Sandbox

Before production usage, you can test our API using the Sandbox. Details can be found here

Authentication

To use the NOWPayments API you should do the following:

  • Sign up at nowpayments.io
  • Specify your outcome wallet
  • Generate an API key

Standard e-commerce flow for NOWPayments API:

  1. API - Check API availability with the "GET API status" method. If required, check the list of available payment currencies with the "GET available currencies" method.
  2. UI - Ask a customer to select item/items for purchase to determine the total sum;
  3. UI - Ask a customer to select payment currency
  4. API - Get the minimum payment amount for the selected currency pair (payment currency to your Outcome Wallet currency) with the "GET Minimum payment amount" method;
  5. API - Get the estimate of the total amount in crypto with "GET Estimated price" and check that it is larger than the minimum payment amount from step 4;
  6. API - Call the "POST Create payment" method to create a payment and get the deposit address (in our example, the generated BTC wallet address is returned from this method);
  7. UI - Ask a customer to send the payment to the generated deposit address (in our example, user has to send BTC coins);
  8. UI - A customer sends coins, NOWPayments processes and exchanges them (if required), and settles the payment to your Outcome Wallet (in our example, to your ETH address);
  9. API - You can get the payment status either via our IPN callbacks or manually, using "GET Payment Status" and display it to a customer so that they know when their payment has been processed.
  10. API - you call the list of payments made to your account via the "GET List of payments" method. Additionally, you can see all of this information in your Account on NOWPayments website.

Alternative flow

  1. API - Check API availability with the "GET API status" method. If required, check the list of available payment currencies with the "GET available currencies" method.
  2. UI - Ask a customer to select item/items for purchase to determine the total sum;
  3. UI - Ask a customer to select payment currency
  4. API - Get the minimum payment amount for the selected currency pair (payment currency to your Outcome Wallet currency) with the "GET Minimum payment amount" method;
  5. API - Get the estimate of the total amount in crypto with "GET Estimated price" and check that it is larger than the minimum payment amount from step 4;
  6. API - Call the "POST Create Invoice method to create an invoice. Set "success_url" - parameter so that the user will be redirected to your website after successful payment.
  7. UI - display the invoice url or redirect the user to the generated link.
  8. NOWPayments - the customer completes the payment and is redirected back to your website (only if "success_url" parameter is configured correctly!).
  9. API - You can get the payment status either via our IPN callbacks or manually, using "GET Payment Status" and display it to a customer so that they know when their payment has been processed.
  10. API - you call the list of payments made to your account via the ["GET List of…

Endpoints 16

Recurring Payments API (Email Subscriptions feature)

  • GETGet many recurring payments/v1/subscriptions?status=PARTIALLY_PAID&subscription_plan_id=111394288&is_active=false&limit=10&offset=0The method allows you to view the entire list of recurring payments filtered by payment status and/or payment plan id
  • GETGet many plans/v1/subscriptions/plans?limit=10&offset=3This method allows you to obtain information about all the payment plans you’ve created.
  • GETGet one plan/v1/subscriptions/plans/:plan-idThis method allows you to obtain information about your payment plan. (you need to specify your payment plan id in the request).
  • PATCHUpdate plan/v1/subscriptions/plans/:plan-idThis 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…
  • GETGet one recurring payment/v1/subscriptions/:sub_idGet information about a particular recurring payment via its ID. Here’s the list of available statuses: \- WAITING_PAY \- PAID \- PARTIALLY_PAID \- EXPIRED
  • DELETEDelete recurring payment/v1/subscriptions/:sub_idCompletely removes a particular payment from the recurring payment plan. You need to specify the payment plan id in the request.

Billing (sub-partner API)

  • GETGet sub-partners/v1/sub-partner?id=111&offset=0&limit=10&order=DESCThis method returns the entire list of your sub-partners.
  • GETGet sub-partner balance/v1/sub-partner/balance/:idThis 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.
  • GETGet transfer/v1/sub-partner/transfer/:idGet the actual information about the transfer. You need to provide the transfer ID in the request.
  • GETGet all transfers/v1/sub-partner/transfers?id=111&status=CREATED&limit=10&offset=0&order=ASCReturns the entire list of transfers created by your sub-partners.

Payments API

  • GETGet estimated price/v1/estimate?amount=3999.5000&currency_from=usd&currency_to=btcThis 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…
  • GETGet the minimum payment amount/v1/min-amount?currency_from=eth&currency_to=trxGet the minimum payment amount for a specific pair. You can provide both currencies in the pair or just currency\_from, and we will calculate the minimum…
  • GETGet list of payments/v1/payment/?limit=10&page=0&sortBy=created_at&orderBy=asc&dateFrom=2020-01-01&dateTo=2021-01-01Returns the entire list of all transactions, created with certain API key. The list of optional parameters: limit - number of records in one page. (possible…
  • POSTGet/Update payment estimate/v1/payment/:id/update-merchant-estimateThis endpoint is required to get the current estimate on the payment, and update the current estimate. Please note! Calling this estimate before…
  • GETGet payment status/v1/payment/:payment_idGet the actual information about the payment. You need to provide the ID of the payment in the request. NOTE! You should make the get payment status request…

Payouts API

  • POSTVerify payout/v1/payout/:withdrawals-id/verifyThis 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…

API details

Base URL
https://api.nowpayments.io
https://api.nowpayments.ioo
Authentication
None declared in the description
Operations
16 operations on 14 pathsGET 12POST 2PATCH 1DELETE 1
Main resources
Recurring Payments API (Email Subscriptions feature) 6Payments API 5Billing (sub-partner API) 4Payouts API 1
Response formats
application/json text/plain
Description format
OpenAPI 3.0.3, API version 1.0.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the NOWPayments API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the NOWPayments API collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “Get many recurring payments” (GET /v1/subscriptions?status=PARTIALLY_PAID&subscription_plan_id=111394288&is_active=false&limit=10&offset=0), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the NOWPayments API?

NOWPayments is a non-custodial cryptocurrency payment processing platform. Accept payments in a wide range of cryptos and get them instantly converted into a… It is listed under Finance & banking and has 16 endpoints.

Who publishes the NOWPayments API?

It is listed from NOWPayments's public API description (an OpenAPI document), not published by NOWPayments on Swastik Codes. Anyone who controls nowpayments.io can claim the profile by adding a DNS TXT record.

What is the base URL of the NOWPayments API?

Its description lists 2 base URLs: https://api.nowpayments.io, https://api.nowpayments.ioo. The first is the usual one; the others are typically sandbox or regional servers.

How do I authenticate with the NOWPayments API?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the NOWPayments API have?

16 operations on 14 paths (12 GET, 2 POST, 1 PATCH, 1 DELETE). The largest groups are Recurring Payments API (Email Subscriptions feature), Payments API, Billing (sub-partner API), Payouts API.

Is forking the NOWPayments API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.