Callback

Upon every successful payout transaction, a callback will be send to the link that you provided earlier through parameter

callback_url

However, LeanX callback mechanism will send an encoded JWT message instead of plain text to provided link, which need to be decoded with a hash key before it can be read. Below are the sample of callback response before and after encoding and decoding process.

Hash Key can be retrieved in your portal dashboard under API page.

Sample callback response before JWT decode

{
    "data": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJvdXRwdXQiOnsiaW52b2ljZV9ubyI6IjE3MjU0NjEzODg2SEdQaXVSdSIsImVycm9yX2Rlc2NyaXB0aW9uIjpbXSwiYmFua19yZXNwb25zZSI6eyJTdWNjZXNzIjp0cnVlLCJSZXN1bHQiOnsiT3JnbkZyb21BY2NvdW50Q3VycmVuY3kiOiJNWVIiLCJPcmduVGhpcmRQYXJ0eUFjY291bnRObyI6IjExNDA4NTgyNjUwOSIsIk9yZ25QYXltZW50RGVzY3JpcHRpb24iOiI2NmQ4NzM4YzJjMjNmIiwiQml6TXNnSUQiOiIyMDI0MDkwNE9DQkNNWUtMMDEwT0NCODk1NTA0OTEiLCJEaXNwbGF5TmFtZSI6IkFaUlVMIEFOVUFSIEJJTiBEVUwiLCJCYW5rUmVmZXJlbmNlTm8iOiIyMDI0MDkwNDIyNDk0ODU0ODMzOCIsIk9yZ25UcmFuc2FjdGlvbkFtb3VudCI6IjEuMCIsIkZyb21BY2NvdW50Tm8iOiI3OTAxMTA2MjQ4IiwiUGF5bWVudFN0YXR1cyI6IkFDU1AiLCJPcmduVGhpcmRQYXJ0eUJhbmtCSUNDb2RlIjoiTUJCRU1ZS0wiLCJPcmduQ3VycmVuY3kiOiJNWVIiLCJPcmduUmVjaXBpZW50UmVmZXJlbmNlIjoiUk0xIEZvcmV2ZXIifX0sImNsaWVudF9kYXRhIjp7InZpcnR1YWxfcG9vbF9yZWZlcmVuY2UiOiJQQVlPVVQtNUMxRToyMjQ5NDctTEVBTlgiLCJleHRlcm5hbF9pbnZvaWNlX3JlZiI6IlRFU1RJTkctUEFZT1VULTAyIiwicmVjaXBpZW50X3JlZmVyZW5jZSI6IlJNMSBGb3JldmVyIn0sImludm9pY2Vfc3RhdHVzX2lkIjoyLCJpbnZvaWNlX3N0YXR1cyI6IlNVQ0NFU1MiLCJhbW91bnQiOiIxLjAwIiwicGF5b3V0X3NlcnZpY2VfaWQiOjc3LCJjbGllbnRfY2FsbGJhY2tfdXJsIjoiaHR0cHM6Ly9hcGkubGVhbnguaW8vYXBpL3YxL2NhbGxiYWNrLXVybC9jYWxsYmFjay1yZWRpcmVjdD9fdXVpZD03OTk0MTFlOC0zYTZjLTQ4YmYtYmM0NS05ZWQ5MWJjZWQ2MmQiLCJjbGllbnRfdHJhbnNhY3Rpb25fZGV0YWlscyI6bnVsbCwicGF5b3V0X3BheW1lbnQiOnsiaXRlbSI6eyJiYWxhbmNlIjoiNy4wMCIsInZpcnR1YWxfcG9vbF9yZWZlcmVuY2UiOiJWQS0yRkRCNUMtMTkzNDIwNDM5NTUwLVBBWU9VVCIsInJlY29yZF9zdGF0dXNfaWQiOjEsInZpcnR1YWxfcG9vbF9jb2xsZWN0aW9uX3R5cGVfaWQiOjEsImNyZWF0ZWRfYXQiOiIyMDIzLTAzLTE2VDA0OjQyOjAzLjAwMDAwMFoiLCJ1cGRhdGVkX2F0IjoiMjAyNC0wOS0wNFQxNDo0OTo1MS4wMDAwMDBaIiwidmlydHVhbF9wb29sX2FsaWFzIjoiTEVBTlggUEFZT1VUIiwidmlydHVhbF9wb29sX3RyYW5zYWN0aW9uX2Ftb3VudCI6IjEuMDAiLCJwYXlvdXRfcGF5bWVudF9hbW91bnQiOiIxLjAwIn0sInJlc3BvbnNlX2NvZGUiOjIxMDB9fSwicmVzcG9uc2VfY29kZSI6MjEwMH0.toZyryF0wiW1OxGzT_TmksvZV44t4jhoZbVNhR8i_gQ",
    "response_code": 2100
}

Sample callback response after JWT decode

{
    "output": {
        "invoice_no": "17254613886HGPiuRu",
        "error_description": [],
        "bank_response": {
            "Success": true,
            "Result": {
                "OrgnFromAccountCurrency": "MYR",
                "OrgnThirdPartyAccountNo": "114085826509",
                "OrgnPaymentDescription": "66d8738c2c23f",
                "BizMsgID": "20240904OCBCMYKL010OCB89550491",
                "DisplayName": "John Doe",
                "BankReferenceNo": "20240904224948548338",
                "OrgnTransactionAmount": "13.0",
                "PaymentStatus": "ACSP",
                "OrgnThirdPartyBankBICCode": "MBBEMYKL",
                "OrgnCurrency": "MYR",
                "OrgnRecipientReference": "Test"
            }
        },
        "client_data": {
            "virtual_pool_reference": "PAYOUT-5C1E:224947-LEANX",
            "external_invoice_ref": "INVOICE1234",
            "recipient_reference": "Test"
        },
        "invoice_status_id": 2,
        "invoice_status": "SUCCESS",
        "amount": "13.00",
        "payout_service_id": 33,
        "client_callback_url": "https://api.leanx.io/api/v1/callback-url/callback-redirect?_uuid=799411e8-3a6c-48bf-bc45-9ed91bced62d",
        "client_transaction_details": null,
        "payout_payment": {
            "item": {
                "balance": "7.00",
                "virtual_pool_reference": "VA-2FDB5C-193420439550-PAYOUT",
                "record_status_id": 1,
                "virtual_pool_collection_type_id": 1,
                "created_at": "2023-03-16T04:42:03.000000Z",
                "updated_at": "2024-09-04T14:49:51.000000Z"
            },
            "response_code": 2100
        }
    },
    "response_code": 2100
}

If you are integrating via your application, the hash key will always be an identifier or a signature to ensure that the callback was intended to be send to you. If the hash key is incorrect, it might be coming from unknown sources.