Sample Payload - Tax Payment Events

Postback Event & Response

Following is the list of currently available postback events

EventsDescription
virtual_bank.tax_payment.successfulThe tax payment was successful
virtual_bank.tax_payment.processingSandbox has started processing your tax payment
virtual_bank.tax_payment.failedThe tax payment has failed. The reason would be mentioned in the response.

Event - virtual_bank.tax_payment.sucessful

{
        "@entity": "event",
        "name": "virtual_bank.tax_payment.successful",
        "group": "virtual_bank",
        "email": "[email protected]",
        "subscription_id": "sub_XXXXXXXXXXXXXX",
        "api_key": "key_live_AzsNcevVFkYELG6Ce7qKTBXXXXXXXXXX",
        "payload": {
            "@entity": "self_assessment_tax",
            "payer": {
                "address": {
                    "area": "SURAT",
                    "country": "India",
                    "city": "XXXX",
                    "street": "X-XXXXXXXX,XXXXXXXXXXX,XXXXXXXX,",
                    "state": "Gujarat",
                    "postal_code": "XXXXXX",
                    "@entity": "address"
                },
                "name": "John Doe",
                "contact_details": {
                    "email": "[email protected]"
                },
                "pan": "EAQXXXXXXX",
                "@entity": "tax_payer"
            },
            "amount": 10,
            "payment_details": {
                "@entity": "payment_details",
                "description": "tax payment for John Doe",
                "status": "Successful",
                "notes": {
                    "key1": "value",
                    "key2": "value"
                }
            },
            "created_at": 1655219648206,
            "updated_at": 1655219729562,
            "assessment_year": "2022-23",
            "tax_breakup": {
                "surcharge": 0,
                "equlization_levy": 0,
                "basic_tax": 10,
                "other_amount": 0,
                "education_cess": 0,
                "other_fee": 0,
                "@entity": "tax_breakup",
                "interest_amount": 0
            },
            "challan": {
                "@entity": "challan",
                "serial_number": "XXXXX",
                "bsr_code": "XXXXXXX",
                "download_url": "URL"
            },
            "id": "0699eb4c-c639-4315-814f-XXXXXXXXXXXX"
        },
        "timestamp": 1655219731060
    }

Event - virtual_bank.tax_payment.processing

{
        "@entity": "event",
        "name": "virtual_bank.tax_payment.processing",
        "group": "virtual_bank",
        "email": "[email protected]",
        "subscription_id": "sub_XXXXXXXXXXXXXX",
        "api_key": "key_live_AzsNcevVFkYELG6Ce7qKTBXXXXXXXXXX",
        "payload": {
            "@entity": "self_assessment_tax",
            "payer": {
                "address": {
                    "area": "SURAT",
                    "country": "India",
                    "city": "XXXX",
                    "street": "X-XXXXXXXX,XXXXXXXXXXX,XXXXXXXX,",
                    "state": "Gujarat",
                    "postal_code": "XXXXXX",
                    "@entity": "address"
                },
                "name": "John Doe",
                "contact_details": {
                    "email": "[email protected]"
                },
                "pan": "EAQXXXXXXX",
                "@entity": "tax_payer"
            },
            "amount": 10,
            "payment_details": {
                "@entity": "payment_details",
                "description": "tax payment for John Doe",
                "status": "Processing",
                "transaction_id": "",
                "notes": {
                    "key1": "value",
                    "key2": "value"
                }
            },
            "created_at": 1655219648206,
            "updated_at": 1655219709245,
            "assessment_year": "2022-23",
            "tax_breakup": {
                "surcharge": 0,
                "equlization_levy": 0,
                "basic_tax": 10,
                "other_amount": 0,
                "education_cess": 0,
                "other_fee": 0,
                "@entity": "tax_breakup",
                "interest_amount": 0
            },
            "id": "0699eb4c-c639-4315-814f-XXXXXXXXXXX"
        },
        "timestamp": 1655219715997
    }

Event - virtual_bank.tax_payment.failed

{
        "@entity": "event",
        "name": "virtual_bank.tax_payment.failed",
        "group": "virtual_bank",
        "email": "[email protected]",
        "subscription_id": "sub_XXXXXXXXXXXXXX",
        "api_key": "key_live_AzsNcevVFkYELG6Ce7qKTBXXXXXXXXXX",
        "payload": {
            "@entity": "self_assessment_tax",
            "payer": {
                "address": {
                    "area": "SURAT",
                    "country": "India",
                    "city": "XXXX",
                    "street": "X-XXXXXXXX,XXXXXXXXXXX,XXXXXXXX,",
                    "state": "Gujarat",
                    "postal_code": "XXXXXX",
                    "@entity": "address"
                },
                "name": "John Doe",
                "contact_details": {
                    "email": "[email protected]"
                },
                "pan": "EAQXXXXXXX",
                "@entity": "tax_payer"
            },
            "amount": 10,
            "payment_details": {
                "@entity": "payment_details",
                "description": "Tax payment for John Doe",
                "status": "Failed",
                "transaction_id": "",
                "notes": {
                    "key1": "value",
                    "key2": "value"
                }
            },
            "created_at": 1655290564119,
            "updated_at": 1655290577753,
            "failure_reason": "CANCELED",
            "financial_year": "2022-23",
            "tax_breakup": {
                "surcharge": 0,
                "equlization_levy": 0,
                "basic_tax": 1,
                "other_amount": 0,
                "education_cess": 0,
                "other_fee": 0,
                "@entity": "tax_breakup",
                "interest_amount": 0
            },
            "id": "1185b8f5-c22d-4ade-ba20-XXXXXXXXXXX"
        },
        "timestamp": 1655290582900
    }

❗️

Avoid Malicious Callbacks

We recommend that you set your secret when configuring Postbacks to avoid such dangers and to encrypt your payload. Click here to learn more