Create New AnyAmount Invoice

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

POST/api/invoices/v1/unlimitedAuth: Required

Request Body

itemsarrayRequired

Item or service provided by invoice. Can contain multiple items, but best practice for AnyAmount is one item/service/purpose.

More attributes

POST/api/invoices/v1/unlimited

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

BODY

{
    "items": [
        {
            "name": "Product 1"
        }
    ],
    "isMerchantPaysFee": null,
    "paymentCurrency": null,
    "redirectURL": "https://google.com"
}

Response

idstring

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

statusstring

Current invoice state: created, pending, processing, done, failed, expired. Note: wrong and refunded are not applicable for AnyAmount invoices.

createdAtstring

Invoice creation date and time.

typestring

Invoice type: regular, unlimited, or business.

companyobject

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

invoiceContentobject

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

redirectURLstring | null

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

EXAMPLE RESPONSE

{
    "id": "invoice_id",
    "status": "created",
    "createdAt": "YYYY-MM-DDTHH:MM:SS.000Z",
    "type": "unlimited",
    "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": "Product 1" }
        ],
        "paymentCurrency": "usdc",
        "isMerchantPaysFee": false,
        "redirectURL": "%url_for_DONE_statused_invoices_redirection%"
    }
}

Request Body​

Response​

Request Body

Response