NOWPayments · Example Payload

Create Invoice

Example request and response for creating a NOWPayments hosted payment invoice

Crypto PaymentsCryptocurrencyPayment GatewayInvoicingSubscriptionsMass PayoutsBitcoinEthereum

Create Invoice is an example object payload from NOWPayments, with 4 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

titledescriptionrequestresponse

Example Payload

{
  "title": "Create Invoice Example",
  "description": "Example request and response for creating a NOWPayments hosted payment invoice",
  "request": {
    "method": "POST",
    "url": "https://api.nowpayments.io/v1/invoice",
    "headers": {
      "x-api-key": "YOUR_API_KEY",
      "Content-Type": "application/json"
    },
    "body": {
      "price_amount": 100,
      "price_currency": "usd",
      "pay_currency": "btc",
      "order_id": "ORDER-12345",
      "order_description": "Payment for order #12345",
      "ipn_callback_url": "https://example.com/ipn",
      "success_url": "https://example.com/success",
      "cancel_url": "https://example.com/cancel"
    }
  },
  "response": {
    "status": 201,
    "body": {
      "id": 1234567,
      "order_id": "ORDER-12345",
      "order_description": "Payment for order #12345",
      "price_amount": 100,
      "price_currency": "usd",
      "pay_currency": "btc",
      "ipn_callback_url": "https://example.com/ipn",
      "invoice_url": "https://nowpayments.io/payment/?iid=1234567",
      "success_url": "https://example.com/success",
      "cancel_url": "https://example.com/cancel",
      "created_at": "2021-01-15T12:00:00.000Z",
      "updated_at": "2021-01-15T12:00:00.000Z"
    }
  }
}