NOWPayments API

https://nowpayments.io/api
Admin
NOWPayments provides an API for businesses to accept and manage crypto and fiat payments, offering...
Tokens:11,907
Snippets:235
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Create Payment API Request

Source: https://nowpayments.io/api/mass-payments

Example of a cURL request to create a payment using the Payment API. Ensure you replace '{{api-key}}' with your actual API key.

```curl
curl --location 'https://api.nowpayments.io/v1/payment' \
--header 'x-api-key: {{api-key}}' \
--header 'Content-Type: application/json' \
--data '{ \
  "price_amount": 3999.5, \
  "price_currency": "usd", \
  "pay_currency": "btc", \
  "ipn_callback_url": "https://nowpayments.io", \
  "order_id": "RGDBP-21314", \
  "order_description": "Apple Macbook Pro 2019 x 1" \
}'
```

--------------------------------

### Create Payment

Source: https://nowpayments.io/api

Initiates a crypto payment transaction. This endpoint allows you to set the price, currency, and callback URL for the payment.

```APIDOC
## POST /v1/payment

### Description
Create a crypto payment.

### Method
POST

### Endpoint
https://api.nowpayments.io/v1/payment

### Parameters
#### Request Body
- **price_amount** (number) - Required - The amount to be paid.
- **price_currency** (string) - Required - The currency of the amount to be paid (e.g., 'usd').
- **pay_currency** (string) - Required - The cryptocurrency to be paid (e.g., 'btc').
- **ipn_callback_url** (string) - Required - The URL to receive IPN notifications.
- **order_id** (string) - Required - Your internal order ID.
- **order_description** (string) - Optional - A description for the order.

### Request Example
```json
{
  "price_amount": 3999.5,
  "price_currency": "usd",
  "pay_currency": "btc",
  "ipn_callback_url": "https://nowpayments.io",
  "order_id": "RGDBP-21314",
  "order_description": "Apple Macbook Pro 2019 x 1"
}
```

### Headers
- **x-api-key**: {{api-key}} (Required)
- **Content-Type**: application/json (Required)
```

--------------------------------

### Create Payment

Source: https://nowpayments.io/api/opencart

Initiates a cryptocurrency payment. This endpoint allows you to create a new payment request with specified details such as amount, currency, and callback URL.

```APIDOC
## POST /v1/payment

### Description
Initiates a cryptocurrency payment. This endpoint allows you to create a new payment request with specified details such as amount, currency, and callback URL.

### Method
POST

### Endpoint
https://api.nowpayments.io/v1/payment

### Parameters
#### Request Body
- **price_amount** (number) - Required - The amount to be paid.
- **price_currency** (string) - Required - The currency of the amount (e.g., "usd").
- **pay_currency** (string) - Required - The cryptocurrency to be paid with (e.g., "btc").
- **ipn_callback_url** (string) - Required - The URL to receive IPN (Instant Payment Notification) callbacks.
- **order_id** (string) - Optional - Your internal order ID.
- **order_description** (string) - Optional - A description for the order.

### Request Example
{
  "example": "{\n  \"price_amount\": 3999.5,\n  \"price_currency\": \"usd\",\n  \"pay_currency\": \"btc\",\n  \"ipn_callback_url\": \"https://nowpayments.io\",\n  \"order_id\": \"RGDBP-21314\",\n  \"order_description\": \"Apple Macbook Pro 2019 x 1\"\n}"
}

### Response
#### Success Response (200)
- **payment_id** (string) - The unique identifier for the created payment.
- **payment_status** (string) - The initial status of the payment.
- **pay_address** (string) - The cryptocurrency address to which the payment should be sent.
- **price_amount** (number) - The amount to be paid.
- **price_currency** (string) - The currency of the amount.
- **pay_currency** (string) - The cryptocurrency to be paid with.
- **order_id** (string) - Your internal order ID, if provided.
- **order_description** (string) - Description for the order, if provided.
- **created_at** (string) - Timestamp of when the payment was created.
- **updated_at** (string) - Timestamp of when the payment was last updated.
- **ipn_callback_url** (string) - The IPN callback URL.
- **estimated_exchange_rate** (number) - The estimated exchange rate at the time of creation.
- **purchase_id** (string) - A unique identifier for the purchase.

#### Response Example
{
  "example": "{\n  \"payment_id\": \"P123456789\",\n  \"payment_status\": \"waiting_for_deposit\",\n  \"pay_address\": \"1A1oP...\",\n  \"price_amount\": 3999.5,\n  \"price_currency\": \"usd\",\n  \"pay_currency\": \"btc\",\n  \"order_id\": \"RGDBP-21314\",\n  \"order_description\": \"Apple Macbook Pro 2019 x 1\",\n  \"created_at\": \"2023-10-27T10:00:00Z\",\n  \"updated_at\": \"2023-10-27T10:00:00Z\",\n  \"ipn_callback_url\": \"https://nowpayments.io\",\n  \"estimated_exchange_rate\": 0.00005,\n  \"purchase_id\": \"PURCHASE-XYZ\"\n}"
}
```

--------------------------------

### Create payment

Source: https://nowpayments.io/api/igaming

Initiates a crypto payment transaction. This endpoint is useful for accepting cryptocurrency payments for goods or services.

```APIDOC
## POST /v1/payment

### Description
Creates a new payment transaction.

### Method
POST

### Endpoint
/v1/payment

### Parameters
#### Request Body
- **price_amount** (number) - Required - The amount to be paid.
- **price_currency** (string) - Required - The currency of the amount to be paid (e.g., "usd").
- **pay_currency** (string) - Required - The cryptocurrency to be paid (e.g., "btc").
- **ipn_callback_url** (string) - Required - The URL to send IPN (Instant Payment Notification) to.
- **order_id** (string) - Optional - Your internal order ID.
- **order_description** (string) - Optional - Description of the order.

### Request Example
```json
{
  "price_amount": 3999.5,
  "price_currency": "usd",
  "pay_currency": "btc",
  "ipn_callback_url": "https://nowpayments.io",
  "order_id": "RGDBP-21314",
  "order_description": "Apple Macbook Pro 2019 x 1"
}
```

### Response
#### Success Response (200)
- **payment_id** (string) - Description of the payment.
- **price_amount** (number) - The amount to be paid.
- **price_currency** (string) - The currency of the amount to be paid.
- **pay_currency** (string) - The cryptocurrency to be paid.
- **order_id** (string) - Your internal order ID.
- **order_description** (string) - Description of the order.
- **purchase_id** (string) - Unique identifier for the purchase.
- **created_at** (string) - Timestamp of when the payment was created.
- **updated_at** (string) - Timestamp of when the payment was last updated.
- **invoice_url** (string) - URL to the invoice for the payment.
- **is_final** (boolean) - Indicates if the payment is final.
- **status_url** (string) - URL to check the status of the payment.

#### Response Example
```json
{
  "payment_id": 123456789,
  "price_amount": 3999.5,
  "price_currency": "usd",
  "pay_currency": "btc",
  "order_id": "RGDBP-21314",
  "order_description": "Apple Macbook Pro 2019 x 1",
  "purchase_id": "PURCHASE_ID_123",
  "created_at": "2023-10-27T10:00:00Z",
  "updated_at": "2023-10-27T10:05:00Z",
  "invoice_url": "https://nowpayments.io/invoice/12345",
  "is_final": false,
  "status_url": "https://api.nowpayments.io/v1/payment/status/123456789"
}
```
```

--------------------------------

### Create Payment

Source: https://nowpayments.io/api/shopware

Initiates a crypto payment transaction. This endpoint allows you to create a new payment request with specified details such as amount, currency, and callback URLs.

```APIDOC
## POST /v1/payment

### Description
Initiates a crypto payment transaction. This endpoint allows you to create a new payment request with specified details such as amount, currency, and callback URLs.

### Method
POST

### Endpoint
https://api.nowpayments.io/v1/payment

### Parameters
#### Request Body
- **price_amount** (number) - Required - The amount to be paid.
- **price_currency** (string) - Required - The currency of the amount to be paid (e.g., "usd").
- **pay_currency** (string) - Required - The cryptocurrency to be paid with (e.g., "btc").
- **ipn_callback_url** (string) - Required - The URL to receive IPN (Instant Payment Notification) callbacks.
- **order_id** (string) - Required - Your internal order ID.
- **order_description** (string) - Optional - A description for the order.

### Request Example
```json
{
  "price_amount": 3999.5,
  "price_currency": "usd",
  "pay_currency": "btc",
  "ipn_callback_url": "https://nowpayments.io",
  "order_id": "RGDBP-21314",
  "order_description": "Apple Macbook Pro 2019 x 1"
}
```

### Response
#### Success Response (200)
- **payment_id** (string) - The unique identifier for the created payment.
- **payment_status** (string) - The status of the payment.
- **pay_address** (string) - The address to which the payment should be sent.
- **price_amount** (number) - The amount to be paid.
- **price_currency** (string) - The currency of the amount to be paid.
- **pay_currency** (string) - The cryptocurrency to be paid with.
- **order_id** (string) - Your internal order ID.
- **order_description** (string) - A description for the order.
- **created_at** (string) - The timestamp when the payment was created.
- **updated_at** (string) - The timestamp when the payment was last updated.

#### Response Example
```json
{
  "payment_id": 123456789,
  "payment_status": "waiting",
  "pay_address": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
  "price_amount": 3999.5,
  "price_currency": "usd",
  "pay_currency": "btc",
  "order_id": "RGDBP-21314",
  "order_description": "Apple Macbook Pro 2019 x 1",
  "created_at": "2023-10-27T10:00:00Z",
  "updated_at": "2023-10-27T10:00:00Z"
}
```
```

--------------------------------

### Create Payment

Source: https://nowpayments.io/api/influencer

Initiates a crypto payment transaction. This endpoint is useful for integrating crypto payment capabilities into your service, allowing you to accept payments in various cryptocurrencies.

```APIDOC
## POST /v1/payment

### Description
Creates a new payment transaction. This endpoint allows you to initiate a crypto payment, specifying the amount, currencies, and callback URL for notifications.

### Method
POST

### Endpoint
/v1/payment

### Parameters
#### Request Body
- **price_amount** (number) - Required - The amount to be paid.
- **price_currency** (string) - Required - The currency of the amount to be paid (e.g., "usd").
- **pay_currency** (string) - Required - The cryptocurrency to be paid with (e.g., "btc").
- **ipn_callback_url** (string) - Required - The URL to receive IPN (Instant Payment Notification) callbacks.
- **order_id** (string) - Optional - Your internal order ID.
- **order_description** (string) - Optional - A description for the order.

### Request Example
```json
{
  "price_amount": 3999.5,
  "price_currency": "usd",
  "pay_currency": "btc",
  "ipn_callback_url": "https://nowpayments.io",
  "order_id": "RGDBP-21314",
  "order_description": "Apple Macbook Pro 2019 x 1"
}
```

### Response
#### Success Response (200)
(Response structure not provided in source)

#### Response Example
(Response example not provided in source)
```

--------------------------------

### Create Payment

Source: https://nowpayments.io/api/dating

This endpoint allows you to create a new crypto payment. You can specify the amount, currencies, callback URL, and order details.

```APIDOC
## POST /v1/payment

### Description
Creates a new crypto payment transaction.

### Method
POST

### Endpoint
https://api.nowpayments.io/v1/payment

### Parameters
#### Request Body
- **price_amount** (number) - Required - The amount to be paid.
- **price_currency** (string) - Required - The currency of the amount (e.g., "usd").
- **pay_currency** (string) - Required - The cryptocurrency to be paid with (e.g., "btc").
- **ipn_callback_url** (string) - Required - The URL to receive IPN notifications.
- **order_id** (string) - Required - Your internal order ID.
- **order_description** (string) - Optional - A description for the order.

### Request Example
{
  "price_amount": 3999.5,
  "price_currency": "usd",
  "pay_currency": "btc",
  "ipn_callback_url": "https://nowpayments.io",
  "order_id": "RGDBP-21314",
  "order_description": "Apple Macbook Pro 2019 x 1"
}

### Response
#### Success Response (200)
(Response details not provided in source text)

#### Response Example
(Response example not provided in source text)
```

--------------------------------

### Create Payment

Source: https://nowpayments.io/api/ecwid

Initiates a payment transaction. This endpoint allows you to create a new payment request with specified details such as amount, currency, and callback URLs.

```APIDOC
## POST /v1/payment

### Description
Creates a new payment transaction.

### Method
POST

### Endpoint
https://api.nowpayments.io/v1/payment

### Parameters
#### Request Body
- **price_amount** (number) - Required - The amount to be paid.
- **price_currency** (string) - Required - The currency of the amount to be paid (e.g., "usd").
- **pay_currency** (string) - Required - The cryptocurrency to be paid (e.g., "btc").
- **ipn_callback_url** (string) - Required - The URL to receive IPN (Instant Payment Notification) callbacks.
- **order_id** (string) - Optional - Your internal order ID.
- **order_description** (string) - Optional - A description for the order.

### Request Example
```json
{
  "price_amount": 3999.5,
  "price_currency": "usd",
  "pay_currency": "btc",
  "ipn_callback_url": "https://nowpayments.io",
  "order_id": "RGDBP-21314",
  "order_description": "Apple Macbook Pro 2019 x 1"
}
```

### Headers
- **x-api-key**: {{api-key}} (Required)
- **Content-Type**: application/json (Required)
```

--------------------------------

### Create Payment API Request

Source: https://nowpayments.io/api/dating

Use this cURL request to create a new payment. Ensure you replace '{{api-key}}' with your actual API key and provide the necessary payment details.

```curl
curl --location 'https://api.nowpayments.io/v1/payment' \
--header 'x-api-key: {{api-key}}' \
--header 'Content-Type: application/json' \
--data '{
  "price_amount": 3999.5,
  "price_currency": "usd",
  "pay_currency": "btc",
  "ipn_callback_url": "https://nowpayments.io",
  "order_id": "RGDBP-21314",
  "order_description": "Apple Macbook Pro 2019 x 1"
}'
```

--------------------------------

### Create Payment API Request

Source: https://nowpayments.io/api/magento

Use this cURL request to create a new payment. Ensure you replace '{{api-key}}' with your actual API key.

```curl
curl --location 'https://api.nowpayments.io/v1/payment' \
--header 'x-api-key: {{api-key}}' \
--header 'Content-Type: application/json' \
--data '{ 
  "price_amount": 3999.5, 
  "price_currency": "usd", 
  "pay_currency": "btc", 
  "ipn_callback_url": "https://nowpayments.io", 
  "order_id": "RGDBP-21314", 
  "order_description": "Apple Macbook Pro 2019 x 1" 
}'
```
Tokens:
Raw