Create New Regular Invoice

This endpoint creates a new invoice under merchant's account.

POST/api/invoices/v1/regularAuth: Required

Request Body

invoiceCurrencystringRequired

Invoice items price currency. Can be eur, usd, or one of crypto assets (usdt, usdc, btc, eth, ton, sol, bnb, bch, ltc, trx).

itemsarrayRequired

List of invoice items. Each item should contain name and price. Can contain as many items as needed.

More attributes

Price Precision by Currency

Currency	Decimal places
usd, eur, usdt, usdc	2
sol, ton	4
btc, eth	6
bnb, bch, ltc, trx	8

POST/api/invoices/v1/regular

curl --location 'https://my.paidlys.com/api/invoices/v1/regular' \
  --header 'Authorization: Bearer YOUR_PUBLIC_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '<body>'

BODY

{
    "invoiceCurrency": "eur",
    "items": [
        {
            "name": "Coffee",
            "price": 10.99
        },
        {
            "name": "Sugar",
            "price": 1
        },
        {
            "name": "Regular client discount",
            "price": -3
        },
        {
            "name": "Coffee gift (1+1 promo)",
            "price": 0
        }
    ],
    "isMerchantPaysFee": false,
    "paymentCurrency": "usdc",
    "redirectURL": "https://myshop.com/payment-success"
}

Response

idstring

Invoice identifier. Open on frontend: https://pay.my.paidlys.com/%invoice_id%.

statusstring

Current invoice state (see Invoice Statuses).

createdAtstring

Invoice creation date and time.

companyobject

Merchant's company information: name, logoUrl, assets (list of accepted assets with isAllowed flag).

invoiceContentobject

Primary invoice info: items list, prices, invoiceCurrency, paymentCurrency, isMerchantPaysFee.

redirectURLstring

URL for redirect after "Done" status. null means no redirect.

EXAMPLE RESPONSE

{
    "id": "invoice_id",
    "status": "created",
    "createdAt": "YYYY-MM-DDTHH:MM:SS.000Z",
    "company": {
        "name": "%company_name",
        "logoUrl": "%logo_url%",
        "assets": [
            { "asset": "btc", "isAllowed": false },
            { "asset": "eth", "isAllowed": false },
            { "asset": "usdt", "isAllowed": false },
            { "asset": "sol", "isAllowed": false },
            { "asset": "ton", "isAllowed": false },
            { "asset": "usdc", "isAllowed": false },
            { "asset": "bnb", "isAllowed": false },
            { "asset": "ltc", "isAllowed": false },
            { "asset": "near", "isAllowed": false },
            { "asset": "trx", "isAllowed": false },
            { "asset": "bch", "isAllowed": false }
        ]
    },
    "invoiceContent": {
        "invoiceCurrency": "eur",
        "items": [
            { "name": "Coffee", "price": "10" },
            { "name": "Sugar", "price": "1" },
            { "name": "Regular client discount", "price": "-3" }
        ],
        "paymentCurrency": "usdc",
        "isMerchantPaysFee": false,
        "redirectURL": "https://myshop.com/payment-success"
    }
}

Request Body​

Price Precision by Currency​

Response​

Request Body

Price Precision by Currency

Response