Create new invoice
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
one of the cryptocurrencies supported by Plisio (ID column from supported https://plisio.net/documentation/appendices/supported-cryptocurrencies). Optional parameter. If the parameter is not set, one of the active cryptocurrencies from the API settings is selected automatically when creating an invoice.
any cryptocurrency float value. !!! Please, skip this field If you want to convert a fiat currency and use source_currency and source_amount fields instead
one of the 167 fiat currencies https://plisio.net/documentation/appendices/supported-fiat-currencies
any float value
comma-separated list of cryptocurrencies that allowed for payment. Customer will be able to select one of them. Example: BTC,ETH,TZEC
merchant internal order name
merchant internal order number. Must be unique number in your store for each new store`s order!!!
merchant invoice description
merchant full URL to get invoice updates. The “POST” request will be sent to this URL (example). If this parameter isn’t set, Plisio will send a callback to URL that can be set under profile API » API settings » ”Status URL” field
an auto-fill invoice email. The customer will be asked to insert their email where a notification will be sent
en_US (we support EN language only)
Plisio’s internal field to determine integration plugin
Plisio’s internal field to determine integration plugin version
Instead of JSON response user will be redirected to the Plisio's invoice page (is not working for a white-label shop)
Interval in minutes when invoice will be expired
merchant full URL to get succeed invoice. When adding json=true to the url, the response will come in the form of JSON
merchant full URL to get failed invoice. When adding json=true to the url, the response will come in the form of JSON
To the site invoice's button link in a case of invoice has been paid
To the site invoice's button link in a case of invoice has not been paid
Return existing invoice instead of error. Default 0
Response
Returns InvoiceResponseDto object or InvoiceWhiteLabelResponseDto object if white-label is enabled
Example response
{
"status": "success"
}Changes
No recorded changes to this operation across all 1 revision of this API.