This webhook request is triggered whenever balance enquiry is performed on a card. The event type is card.balance
This type of webhook is only applicable for Cards using the Gateway Funding Source
When you receive this type of event, you’re expected to respond to the webhook containing the card balance.

​
Request Payload

{
    "business": "xxxxxxxxsxxxxxxx",
    "data": {
        "object": {
            "_id": "61e02652bdf6466e4ff94921",
            "business": "xxxxxxxxsxxxxxxx",
            "customer": {
                "_id": "61deecfb51eac6c9d0a49d54",
                "business": "xxxxxxxxsxxxxxxx",
                "type": "individual",
                "name": "Shamsuddeen Omacy",
                "status": "active",
                "individual": {
                    "firstName": "Shamsuddeen",
                    "lastName": "Omacy",
                    "_id": "61deecfb51eac6c9d0a49d55"
                },
                "billingAddress": {
                    "line1": "4 Barnawa Close",
                    "line2": "Off Challawa Crescent",
                    "city": "Barnawa",
                    "state": "Kaduna",
                    "country": "Nigeria",
                    "postalCode": "800243",
                    "_id": "61deecfb51eac6c9d0a49d56"
                },
                "isDeleted": false,
                "createdAt": "2024-01-12T15:00:11.745Z",
                "updatedAt": "2024-01-12T15:00:11.745Z",
                "__v": 0
            },
            "account": {
                "_id": "61e02652bdf6466e4ff9491f",
                "business": "xxxxxxxxsxxxxxxx",
                "type": "wallet",
                "currency": "NGN",
                "accountName": "BITAKO / SHAMSUDDEEN OMACY",
                "bankCode": "999240",
                "accountType": "Current",
                "accountNumber": "8017418065",
                "currentBalance": 0,
                "availableBalance": 0,
                "provider": "SafeHaven",
                "providerReference": "61e026526c14e4001ec12ea4",
                "referenceCode": "subacc_1642079825141",
                "isDefault": true,
                "isDeleted": false,
                "createdAt": "2024-11-13T13:17:06.606Z",
                "updatedAt": "2024-11-13T13:17:06.606Z",
                "__v": 0
            },
            "fundingSource": {
                "_id": "61deec9a5454549d0a49d04",
                "business": "xxxxxxxxsxxxxxxx",
                "type": "gateway",
                "status": "active",
                "jitGateway": {
                    "url": "",
                    "authorizationHeader": "Bearer ",
                    "authorizeByDefault": false,
                    "_id": "61deec9a51eac6c9d0a49d05"
                },
                "isDefault": false,
                "isDeleted": false,
                "createdAt": "2024-01-12T14:58:34.348Z",
                "updatedAt": "2024-01-12T14:58:34.348Z",
                "__v": 0
            },
            "type": "virtual",
            "brand": "Verve",
            "currency": "NGN",
            "maskedPan": "507874******5244",
            "expiryMonth": "11",
            "expiryYear": "2027",
            "status": "active",
            "spendingControls": {
                "channels": {
                    "atm": true,
                    "pos": true,
                    "web": true,
                    "mobile": true,
                    "_id": "61e02652bdf6466e4ff94923"
                },
                "allowedCategories": [],
                "blockedCategories": [],
                "spendingLimits": [{
                    "amount": 500,
                    "interval": "daily",
                    "categories": [],
                    "_id": "61e02652bdf6466e4ff94924"
                }],
                "_id": "61e02652bdf6466e4ff94922"
            },
            "isDeleted": false,
            "createdAt": "2024-11-13T13:17:06.808Z",
            "updatedAt": "2024-11-13T13:17:06.808Z",
            "__v": 0
        },
        "_id": "61e0282e709508625af2fad6"
    },
    "type": "card.balance",
    "pendingWebhook": false,
    "webhookArchived": false,
    "createdAt": 1742080302,
    "_id": "61e0282e709508625af2fad5"
}
The field data.object._id identifies the Card ID

​
Response Sample

{
    "statusCode": 200,
    "data": {
        "responseCode": "00",
        "balance": 1234
    }
}