Webhook Events

These are the list of events we currently create. This list would be updated as we create more features in the future.

Charges

Event	Description
charge.created	A charge is created successfully
charge.confirmed	A successful charge was made
charge.cancelled	A charge is cancelled
charge.pending	A charge has a pending payment on the blockchain.
charge.resolved	A pending charge has been resolved
charge.unresolved	A charge is marked as unresolved
charge.expired	A charge is expired

{
    "event": "charge.confirmed",
    "data": {
        "id": "a3da566b-4c26-4b4d-b979-def331d925a5",
        "business_id": "6d91a156-0139-4cc4-9fbf-28172b1a2d7f",
        "reference": "RCO9IHD0A8",
        "hosted_url": "https://pay.busha.co/checkouts/3f4ca313-7830-4836-b2f5",
        "price_fixed": true,
        "callback_url": "https://pay.busha.co/checkouts/3f4ca313-7830-4836-b2f5/response",
        "local_currency": "NGN",
        "meta": {
            "name": "Sarah Shaw",
            "email": "[email protected]"
        },
        "expires_at": "2023-04-17T16:01:39.851966Z",
        "timeline": [
            {
                "status": "NEW",
                "created_at": "2023-04-17T15:01:39.853453Z"
            },
            {
                "status": "COMPLETED",
                "created_at": "2023-04-17T15:06:40.353299Z"
            }
        ],
        "addresses": [
            {
                "currency_id": "BTC",
                "chain": "BTC",
                "address": "2N2t9wFX3Vs834hF7WGobjiFSMXuphw7sra",
                "label": "Bitcoin",
                "memo": ""
            }
        ],
        "payments": [
            {
                "chain": "BTC",
                "local_amount": "10000",
                "local_currency": "NGN",
                "amount": "0.00045439",
                "currency": "BTC",
                "transaction_id": "011762bb-d9e8-4c4c-b261-5d58c7cb6473",
                "transaction_hash": "busha_8e6fe13bc44c04b4d4070ae62237c803532d31b68135ccce8bdd46d5b81917b8",
                "reference": "PYOT_I0BvEzoECX",
                "status": "COMPLETED",
                "traded": false,
                "address": "2N2t9wFX3Vs834hF7WGobjiFSMXuphw7sra",
                "confirmation": 5,
                "payment_threshold": {
                    "overpayment_absolute_threshold": "0",
                    "overpayment_relative_threshold": "0",
                    "underpayment_absolute_threshold": "0",
                    "underpayment_relative_threshold": "0"
                },
                "block_url": "",
                "internal": true
            }
        ],
        "pricing": [
            {
                "currency_id": "NGN",
                "amount": "10000",
                "rate": "1",
                "is_local": true
            },
            {
                "currency_id": "BTC",
                "amount": "0.00045439",
                "rate": "22007042",
                "is_local": false
            }
        ]
    }
}

{
    "event": "charge.expired",
    "data": {
        "id": "ef387166-9fb4-4220-8b31-d8b833aead7b",
        "business_id": "b1583d58-be07-4e75-85c9-3493fa4026c7",
        "reference": "RJSTYMMA9",
        "hosted_url": "https://pay.busha.co/charges/RJSTYMMA9",
        "price_fixed": true,
        "local_currency": "NGN",
        "meta": {
            "name": "Sarah Shaw",
            "email": "[email protected]"
        },
        "expires_at": "2023-04-11T14:52:31.86338+01:00",
        "timeline": [
            {
                "status": "NEW",
                "created_at": "2023-04-11T13:52:31.865592+01:00"
            },
            {
                "status": "EXPIRED",
                "created_at": "2023-04-11T14:52:32.017647+01:00"
            }
        ],
        "addresses": [],
        "payments": [],
        "pricing": [
            {
                "currency_id": "NGN",
                "amount": "100",
                "rate": "1",
                "is_local": true
            }
        ]
    }
}

{
    "event": "charge.created",
    "data": {
        "id": "4ea04bc4-29ef-445f-8cf4",
        "business_id": "6d91a156-0139-4cc4-9fbf-28172b1a2d7f",
        "reference": "R60DQGD9C",
        "hosted_url": "https://staging.pay.busha.co/charges/4ea04bc4-29ef-445f-8cf4",
        "price_fixed": true,
        "local_currency": "NGN",
        "meta": {
            "name": "Sarah Shaw",
            "email": "[email protected]"
        },
        "expires_at": "2023-04-17T17:12:56.779675Z",
        "timeline": [
            {
                "status": "NEW",
                "created_at": "2023-04-17T16:12:56.78114Z"
            }
        ],
        "addresses": [
            {
                "currency_id": "BTC",
                "chain": "BTC",
                "address": "2MwHGd2tHc6gT5mWC2vWSGeZfmqpoCtTDJH",
                "label": "",
                "memo": ""
            },
            {
                "currency_id": "ETH",
                "chain": "ETH",
                "address": "0x13a7106A9c1cf52087ac2a10b24ed79906185A31",
                "label": "",
                "memo": ""
            },
            {
                "currency_id": "TRX",
                "chain": "TRX",
                "address": "THyJtQG9b4RZ3EUCPX45sNwYDX3UN7E5QH",
                "label": "",
                "memo": ""
            },
            {
                "currency_id": "USDT",
                "chain": "TRX",
                "address": "TTTpkytdJHSqqa2TKMkTLAVijB5WzccbH3",
                "label": "",
                "memo": ""
            },
            {
                "currency_id": "USDT",
                "chain": "BSC",
                "address": "0x76682530d5323D009203e79782cF6f4CfDe5F861",
                "label": "",
                "memo": ""
            },
            {
                "currency_id": "USDT",
                "chain": "ETH",
                "address": "0xb0C1bF3f08ACa6457800c36b896AcBF5Ea9b37C5",
                "label": "",
                "memo": ""
            }
        ],
        "payments": [],
        "pricing": [
            {
                "currency_id": "NGN",
                "amount": "50000",
                "rate": "1",
                "is_local": true
            },
            {
                "currency_id": "BTC",
                "amount": "0.00227647",
                "rate": "21963770",
                "is_local": false
            },
            {
                "currency_id": "ETH",
                "amount": "0.03206986",
                "rate": "1559095.9",
                "is_local": false
            },
            {
                "currency_id": "TRX",
                "amount": "1018.7",
                "rate": "49.08",
                "is_local": false
            },
            {
                "currency_id": "USDT",
                "amount": "67.131214",
                "rate": "744.81",
                "is_local": false
            }
        ]
    }
}

Wallet

Event	Description
deposit.confirmed	A deposit was successfully received on a wallet address
deposit.pending	There is a pending deposit to the wallet address on the blockchain.
deposit.failed	A deposit failed

{
    "event": "deposit.confirmed",
    "data": {
        "chain": "TRX",
        "local_amount": "3687.05",
        "local_currency": "NGN",
        "amount": "5",
        "currency": "USDT",
        "transaction_id": "0d909e73-460f-4e64-a1fe-a34b824b63f5",
        "transaction_hash": "busha_c83a12b7a998c087ca319d14599da8a888bf6fc766094e60a929ccb6bd9fd929",
        "reference": "PYOT_fLL6wMGC6C",
        "status": "COMPLETED",
        "traded": false,
        "address": "TJmZ7N5S9TNNWHSQBbZemqMDEjkid8M4NZ",
        "confirmation": 5,
        "payment_threshold": {},
        "block_url": "",
        "internal": true
    }
}