---
title: "Invoice details"
method: GET
path: "/invoices/{id}"
tags: ["invoice"]
---

# Invoice details

`GET /invoices/{id}`

## Request

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

## Path parameters

- `id` string, required

## Response `200`

Returns InvoiceDetailsApiResponseDto object

- InvoiceDetailsApiResponseDto
  - `status` string: success or error
  - `data` InvoiceDetailsResponseDto
    - `invoice` 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
    - `active_invoice_id` string: Current active invoice ID. Invoice ID with the last selected cryptocurrency
    - `shop` ShopInfoDto
      - `name` string: Shop name
      - `link` string: Shop URL
      - `logo` unknown
      - `successUrl` string: Success callback URL
      - `failedUrl` string: Fail callback URL
      - `allow_renew` boolean: Show renew button after invoice expored
    - `paysys` InvoicePaysysDto
      - `name` string: Cryptocurrency name
      - `cid` string: Cryptocurrency Plisio Abbr
      - `currency` string: Cryptocurrency Abbr
      - `icon` string, uri: Cryptocurrency icon
      - `rate_usd` string: Cryptocurrency USD rate
      - `price_usd` string: Cryptocurrency USD price
      - `precision` string: Cryptocurrency precision
      - `output_precision` string: Cryptocurrency output precision
      - `fiat` unknown
      - `fiat_rate` unknown
      - `min_sum_in` unknown
      - `invoice_commission_percentage` string: Plisio commission percentage
      - `hidden` integer: Is cryptocurrency enabled (1 - disable, 0 - enabled)
      - `maintenance` boolean: Cryptocurrency node temporary on maintenance
      - `contractOf` unknown
      - `contractStandard` unknown
      - `amount` string: Invoice amount in this crypto
    - `allowed_psys_cids` InvoicePaysysDto[]: Allowed cryptocurrencies for select
      - `name` string: Cryptocurrency name
      - `cid` string: Cryptocurrency Plisio Abbr
      - `currency` string: Cryptocurrency Abbr
      - `icon` string, uri: Cryptocurrency icon
      - `rate_usd` string: Cryptocurrency USD rate
      - `price_usd` string: Cryptocurrency USD price
      - `precision` string: Cryptocurrency precision
      - `output_precision` string: Cryptocurrency output precision
      - `fiat` unknown
      - `fiat_rate` unknown
      - `min_sum_in` unknown
      - `invoice_commission_percentage` string: Plisio commission percentage
      - `hidden` integer: Is cryptocurrency enabled (1 - disable, 0 - enabled)
      - `maintenance` boolean: Cryptocurrency node temporary on maintenance
      - `contractOf` unknown
      - `contractStandard` unknown
      - `amount` string: Invoice amount in this crypto

## 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)