---
name: nowpayments-api
description: "NOWPayments API skill. Use when working with NOWPayments for subscriptions, sub-partner, estimate. Covers 35 endpoints."
version: 1.0.0
generator: lapsh
---

# NOWPayments API

## Auth
ApiKey x-api-key in header

## Base URL
Not specified.

## Setup
1. Set your API key in the appropriate header
2. GET /v1/subscriptions/plans/:plan-id -- this method allows you to obtain information about your payment plan
3. POST /v1/subscriptions/plans -- create first plan

## Endpoints
35 endpoints across 14 groups. See references/api-spec.lap for full details.

### Subscriptions
| Method | Path | Description |
|--------|------|-------------|
| POST | /v1/subscriptions/plans | This is the method to create a Recurring Payments plan |
| PATCH | /v1/subscriptions/plans/:plan-id | This method allows you to add necessary changes to a created plan |
| GET | /v1/subscriptions/plans/:plan-id | This method allows you to obtain information about your payment plan |
| GET | /v1/subscriptions/plans | This method allows you to obtain information about all the payment plans you’ve created |
| POST | /v1/subscriptions | This method allows you to send payment links to your customers via email |
| GET | /v1/subscriptions | The method allows you to view the entire list of recurring payments filtered by payment status and/or payment plan id |
| GET | /v1/subscriptions/:sub_id | Get information about a particular recurring payment via its ID |
| DELETE | /v1/subscriptions/:sub_id | Completely removes a particular payment from the recurring payment plan |
| POST | /v1/subscriptions | This method creates a recurring charge from a sub-account |

### Sub-partner
| Method | Path | Description |
|--------|------|-------------|
| POST | /v1/sub-partner/balance | This is a method to create a sub-partner account for your user |
| GET | /v1/sub-partner/balance/:id | This request can be made only from a whitelisted IP |
| GET | /v1/sub-partner | This method returns the entire list of your sub-partners |
| GET | /v1/sub-partner/transfers | Returns the entire list of transfers created by your sub-partners |
| GET | /v1/sub-partner/transfer/:id | Get the actual information about the transfer |
| POST | /v1/sub-partner/transfer | This method allows creating transfers between sub-partners' accounts |
| POST | /v1/sub-partner/payment | This method allows you to top up a sub-partner account with a general payment |
| POST | /v1/sub-partner/deposit | This is a method for transferring funds from a master account to a sub-partner's one |
| POST | /v1/sub-partner/write-off | With this method you can withdraw funds from a sub-partner's account and transfer them to a master one |

### Estimate
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/estimate | This is a method for calculating the approximate price in cryptocurrency for a given value in Fiat currency |

### Payment
| Method | Path | Description |
|--------|------|-------------|
| POST | /v1/payment | Creates payment |
| POST | /v1/payment/:id/update-merchant-estimate | This endpoint is required to get the current estimate on the payment, and update the current estimate |
| GET | /v1/payment/:payment_id | Get the actual information about the payment |
| GET | /v1/payment/ | Returns the entire list of all transactions, created with certain API key |

### Invoice-payment
| Method | Path | Description |
|--------|------|-------------|
| POST | /v1/invoice-payment | Creates payment by invoice |

### Min-amount
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/min-amount | Get the minimum payment amount for a specific pair |

### Invoice
| Method | Path | Description |
|--------|------|-------------|
| POST | /v1/invoice | Creates an invoice |

### Currencies
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/currencies | This is a method for obtaining information about all cryptocurrencies available for payments |

### Full-currencies
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/full-currencies | This is a method to obtain detailed information about all cryptocurrencies available for payments |

### Merchant
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/merchant/coins | This is a method for obtaining information about the cryptocurrencies available for payments |

### Payout
| Method | Path | Description |
|--------|------|-------------|
| POST | /v1/payout | This is the method to create a payout |
| GET | /v1/payout/<payout_id> | Get the actual information about the payout |
| POST | /v1/payout/:withdrawals-id/verify | This method is required to verify payouts by using your 2fa code |

### Balance
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/balance | This method returns your balance in different currencies |

### Status
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/status | This is a method to get information about the current state of the API |

### Auth
| Method | Path | Description |
|--------|------|-------------|
| POST | /v1/auth | Authentication method for obtaining a JWT token |

## Common Questions
Match user requests to endpoints in references/api-spec.lap. Key patterns:
- "Create a plan?" -> POST /v1/subscriptions/plans
- "List all :plan-id?" -> GET /v1/subscriptions/plans/:plan-id
- "List all plans?" -> GET /v1/subscriptions/plans
- "Create a subscription?" -> POST /v1/subscriptions
- "List all subscriptions?" -> GET /v1/subscriptions
- "List all :sub_id?" -> GET /v1/subscriptions/:sub_id
- "Create a balance?" -> POST /v1/sub-partner/balance
- "List all :id?" -> GET /v1/sub-partner/balance/:id
- "List all sub-partner?" -> GET /v1/sub-partner
- "List all transfers?" -> GET /v1/sub-partner/transfers
- "Create a transfer?" -> POST /v1/sub-partner/transfer
- "Create a payment?" -> POST /v1/sub-partner/payment
- "Create a deposit?" -> POST /v1/sub-partner/deposit
- "Create a write-off?" -> POST /v1/sub-partner/write-off
- "List all estimate?" -> GET /v1/estimate
- "Create a invoice-payment?" -> POST /v1/invoice-payment
- "Create a update-merchant-estimate?" -> POST /v1/payment/:id/update-merchant-estimate
- "List all :payment_id?" -> GET /v1/payment/:payment_id
- "List all min-amount?" -> GET /v1/min-amount
- "List all payment?" -> GET /v1/payment/
- "Create a invoice?" -> POST /v1/invoice
- "List all currencies?" -> GET /v1/currencies
- "List all full-currencies?" -> GET /v1/full-currencies
- "List all coins?" -> GET /v1/merchant/coins
- "Create a payout?" -> POST /v1/payout
- "List all <payout_id>?" -> GET /v1/payout/<payout_id>
- "List all balance?" -> GET /v1/balance
- "Create a verify?" -> POST /v1/payout/:withdrawals-id/verify
- "List all status?" -> GET /v1/status
- "Create a auth?" -> POST /v1/auth
- "How to authenticate?" -> See Auth section above

## Response Tips
- Check response schemas in references/api-spec.lap for field details
- Paginated endpoints accept limit/offset or cursor parameters
- Create/update endpoints return the modified resource on success

## References
- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas

> Generated from the official API spec by [LAP](https://lap.sh)