---
title: "Create new invoice"
method: GET
path: "/invoices/new"
tags: ["invoice"]
---

# Create new invoice

`GET /invoices/new`

## Request

- Base URL: `https://plisio.loc/api/v1`
- URL: `https://plisio.loc/api/v1/invoices/new`
- Auth: API key in query parameter `api_key`

## Query parameters

- `currency` string, required
- `amount` string
- `source_currency` string
- `source_amount` string
- `allowed_psys_cids` string
- `order_name` string, required
- `order_number` string, required
- `description` string
- `callback_url` string
- `email` string
- `language` string
- `plugin` string
- `version` string
- `redirect_to_invoice` boolean
- `expire_min` string
- `success_callback_url` string
- `fail_callback_url` string
- `success_invoice_url` string
- `fail_invoice_url` string
- `return_existing` integer

## Response `200`

Returns InvoiceResponseDto object or InvoiceWhiteLabelResponseDto object if white-label is enabled

- InvoiceWhiteLabelResponseDto
  - `status` string: success or error
  - `data` InvoiceExtendedResponseDto
    - `txn_id` string: Plisio’s intertnal ID
    - `invoice_url` string, uri: Invoice URL
    - `invoice_total_sum` string: shop pays commission: invoice amount client pays commission: invoice_commission + invoice_sum
    - `id` string: Plisio’s intertnal ID (copy of txn_id)
    - `amount` string: Invoice amount in the selected cryptocurrency
    - `received_amount` string: Received and approved amount in the selected cryptocurrency
    - `pending_amount` string: Pending (not approve) amount in the selected cryptocurrency
    - `remaining_amount` string: Remaining amount in the selected cryptocurrency
    - `wallet_hash` string: Invoice hash
    - `psys_cid` string: ID column from https://plisio.net/documentation/appendices/supported-cryptocurrencies
    - `currency` string: Code column from https://plisio.net/documentation/appendices/supported-cryptocurrencies
    - `source_currency` string: Fiat currency - only USD available for the moment
    - `source_rate` string: Exchange rate from the “psys_cid” to the “source_currency” at the moment of transfer
    - `expected_confirmations` string: How many confirmations expected to mark invoice completed
    - `invoice_commission` string: Plisio commission
    - `invoice_sum` string: shop pays commission: invoice amount - invoice_commission client pays commission: invoice amount
    - `email_already_set` boolean: If email has been set
    - `tx_url` string: link to the cryptocurrency block explorer
    - `tx_id` string[]: array of transaction ids
    - `switch_id` string, nullable: Initial invoice ID
    - `paid_id` string, nullable: ID of invoice that has money
    - `params` OperationParamsDto
      - `fee` FeeParamsDto
        - `conf_target` string: estimated fee parameter to confirm the transaction in the “conf_target” blocks
        - `plan` string: the Plisio’s fee plan name
        - `value` string: fee value
      - `order_number` string: Invoice order number. Must be unique number in your store for each new store`s order!!!
      - `order_name` string: Order name
      - `description` string: Order description
      - `source_amount` string: Invoice amount in fiat currency
      - `source_currency` string: Invoice fiat currency
      - `value` string: fee value
      - `avatar` string: Custom invoice avatar
      - `store` string: Custom invoice store name
      - `currency` string: Code column from https://plisio.net/documentation/appendices/supported-cryptocurrencies
      - `psys_cid` string: ID column from https://plisio.net/documentation/appendices/supported-cryptocurrencies
      - `amount` string: Invoice amount in selected cryptocurrency
      - `source_rate` string: Cryptocurrency rate
      - `email` string: Email of payer
      - `donate_hash` string: Donation hash
      - `payment_button_hash` string: Payment button hash
      - `memo` unknown
    - `view_key` string: invoice read-only view key

## Other responses

- `401`: Returns error
- `404`: Returns error
- `422`: Returns error
- `500`: Returns error

---

[API](https://skmtc.dev/plisio/apis/plisio-api-plisio-loc.md) · [All operations](https://skmtc.dev/plisio/apis/plisio-api-plisio-loc/llms.txt) · [OpenAPI document](https://skmtc.dev/plisio/apis/plisio-api-plisio-loc/revisions/b54f70a29304?raw)