For the complete documentation index, see llms.txt. This page is also available as Markdown.

Invoice callbacks

Refer to this section to get more information on what callbacks are and how to validate them before acting on it inside your system.

Event
status
status_context
Description

transaction_created

new

null

A customer has just broadcast the transaction on the bitcoin network

transaction_confirmed

new

null

The transaction has just been confirmed on the network

status_changed

completed

null

The invoice status has been changed

unresolved

illicit_resource

unresolved

overpaid

unresolved

underpaid

unresolved

paid_late

refunded

null

cancelled

null

{
    "data": {
        "id": "1bbc11e1-1f91-11c1-11ec-cea1ad12345e",
        "fee": "2.55",
        "uri": "TSKh8uZnkt12345teYPNNNdRbspqW12345",
        "name": null,
        "status": "new",
        "address": "TSKh8uZnkt12345teYPNNNdRbspqW12345",
        "network": "tron",
        "exchange": {
            "fee": "0.0",
            "pair": "USDTUSD",
            "rate": "0.9982",
            "fee_currency": "USD"
        },
        "metadata": null,
        "custom_id": "123412345",
        "created_at": "2025-08-01T10:16:55+00:00",
        "expires_at": "2025-08-01T10:26:55+00:00",
        "pay_amount": "300.55",
        "customer_id": null,
        "description": null,
        "paid_amount": "301.0",
        "fee_currency": "USD",
        "pay_currency": "USDT",
        "price_amount": "300.0",
        "transactions": [
            {
                "risk": null,
                "txid": "cc5806d7498aa123451b1ea16709a8de12345232af08c9df104d626271212345",
                "source_addresses": [
                    "TK4ykR48c12345cZ5N12345sBaHcg12345"
                ]
            }
        ],
        "price_currency": "USD",
        "status_context": null,
        "hosted_page_url": "https://business-hosted.cryptopay.me/invoices/1bbc11e1-1f91-11c1-11ec-cea1ad12345e",
        "subscription_id": null,
        "success_redirect_url": null,
        "unsuccess_redirect_url": null
    },
    "type": "Invoice",
    "event": "transaction_created"
}

Navigate to the Invoice statuses section to get more information about invoice statuses and exceptions.

Last updated