Getting started
Webhooks
Samples
Below are some samples of webhooks the HUB2 API can send.
{
"owner": "3",
"type": "transfer.created",
"data": {
"id": "tr_ntP3VFmvRNJ1L5lk5kK3E",
"merchantId": "nS4vWERynqjMDFR20cGmL",
"createdAt": "2024-06-06T10:49:36.122Z",
"updatedAt": "2024-06-06T10:49:36.122Z",
"reference": "ref_01",
"description": "description",
"status": "created",
"amount": 33950,
"currency": "XOF",
"mode": "live",
"destination": {
"type": "mobile_money",
"country": "CI",
"provider": "orange",
"number": "00000001",
"recipientName": "XXX"
},
"fees": [
{
"id": "fee_EhsB9ZYhNuIxZ9JSQaMxN",
"rate": 2,
"type": "percent",
"amount": 679,
"currency": "XOF",
"label": null,
"taxes": []
}
],
"origin": {
"name": "XXX",
"country": "CI"
},
"overrideBusinessName": "XXXX",
"overrideBusinessId": null,
"isIrt": false
},
"test": false,
"id": "evt_q4FFfUVzok5fuZz9rk7ta",
"createdAt": "2024-06-06T10:49:36.212Z"
}
{
"owner": "3",
"type": "transfer.processing",
"data": {
"id": "tr_dfOVfrBHdyPuD0w4Hgfse",
"merchantId": "K6iaxjfUZg1urpLUbSkXN",
"createdAt": "2024-06-06T10:57:04.304Z",
"updatedAt": "2024-06-06T10:57:04.449Z",
"reference": "ref_01",
"description": "desc_01",
"status": "pending",
"amount": 11000,
"currency": "XOF",
"mode": "live",
"destination": {
"type": "mobile_money",
"country": "CI",
"provider": "orange",
"number": "00000001",
"recipientName": "XXXX"
},
"fees": [
{
"id": "fee_dhjkdTkanhKBt3ckhZl9E",
"rate": 0.8,
"type": "percent",
"amount": 88,
"currency": "XOF",
"label": null,
"taxes": []
}
],
"origin": {
"name": "XXXX",
"country": "CI"
},
"overrideBusinessName": "XXXX",
"overrideBusinessId": null,
"isIrt": false
},
"test": false,
"id": "evt_LCEbahLw6S9JHWUUkgLPE",
"createdAt": "2024-06-06T10:57:04.470Z"
}
{
"owner": "3",
"type": "transfer.failed",
"data": {
"id": "tr_GvzsTY3HdbGbo1NaPB6Ml",
"merchantId": "nS4vWERynqjMDFR20cGmL",
"createdAt": "2024-06-06T10:49:25.669Z",
"updatedAt": "2024-06-06T10:49:29.535Z",
"reference": "4lDfuTZ9",
"description": "desc_001",
"status": "failed",
"amount": 11900,
"currency": "XOF",
"mode": "live",
"destination": {
"type": "mobile_money",
"country": "CI",
"provider": "orange",
"number": "00000001",
"recipientName": "XXXX"
},
"fees": [
{
"id": "fee_1Lsk4j0l1pH0KQ4D2ESLn",
"rate": 2,
"type": "percent",
"amount": 238,
"currency": "XOF",
"label": null,
"taxes": []
}
],
"failureCause": {
"code": "internal_error",
"message": "Le transfert a échoué, une erreur interne est survenue. Notre service technique est au courant et travaille à sa résolution."
},
"origin": {
"name": "XXXX",
"country": "CI"
},
"overrideBusinessName": "XXXX",
"overrideBusinessId": null,
"isIrt": false
},
"test": false,
"id": "evt_JhCfP5hZX60E7CN8wTbbW",
"createdAt": "2024-06-06T10:49:29.553Z"
}
{
"owner": "3",
"type": "transfer.succeeded",
"data": {
"id": "tr_rneqc0ufyVLUuQZrgXAIq",
"merchantId": "dxpIyVe2AfMDoWwr5XyPM",
"createdAt": "2024-06-06T09:48:39.457Z",
"updatedAt": "2024-06-06T09:48:40.119Z",
"reference": "ref_0021",
"description": "Unit Testing - 30 Test transfer",
"status": "successful",
"amount": 1000,
"currency": "XOF",
"mode": "live",
"destination": {
"type": "mobile_money",
"country": "CI",
"provider": "orange",
"number": "00000001",
"recipientName": "..."
},
"fees": [
{
"id": "fee_DAuH52rhjNfPHfnRcieCJ",
"rate": 1.6,
"type": "percent",
"amount": 16,
"currency": "XOF",
"label": null,
"taxes": []
}
],
"origin": {
"name": "XXX",
"country": "CI"
},
"overrideBusinessName": " XXX",
"overrideBusinessId": null,
"isIrt": false
},
"test": false,
"id": "evt_grPErVipwaRVWaXh1mx37",
"createdAt": "2024-06-06T09:48:40.242Z"
}
{
"owner": "3",
"type": "payment_intent.created",
"data": {
"id": "pi_Vjdcw4aV8LPn9e0sD92gr",
"createdAt": "2024-06-06T10:13:04.414Z",
"updatedAt": "2024-06-06T10:13:04.415Z",
"merchantId": "1092",
"purchaseReference": "p_ref_01",
"customerReference": "c_ref_01",
"amount": 5000,
"currency": "XOF",
"token": "XXX",
"status": "payment_required",
"overrideBusinessName": null,
"payments": [],
"mode": "live"
},
"test": false,
"id": "evt_jYRsQUGrFugLxmmNevya9",
"createdAt": "2024-06-06T10:13:04.448Z"
}
{
"owner": "3",
"type": "payment_intent.processing",
"data": {
"id": "pi_8UG3Hbof1n1XitPJm1nUG",
"createdAt": "2024-06-06T10:17:40.305Z",
"updatedAt": "2024-06-06T10:17:42.933Z",
"merchantId": "1013",
"purchaseReference": "p_ref_01",
"customerReference": "c_ref_01",
"amount": 9455,
"currency": "XOF",
"token": "XXX",
"status": "processing",
"overrideBusinessName": null,
"payments": [
{
"id": "pay_Yksq7VTUMQiDu5yR3LjAP",
"intentId": "pi_8UG3Hbof1n1XitPJm1nUG",
"createdAt": "2024-06-06T10:17:42.855Z",
"updatedAt": "2024-06-06T10:17:42.933Z",
"amount": 9455,
"currency": "XOF",
"status": "pending",
"method": "mobile_money",
"country": "CI",
"provider": "wave",
"number": "00000001",
"fees": [
{
"currency": "XOF",
"id": "fee_ZIp4Nn4CiclTRdJ8vXjCo",
"label": "payments.payment_processor_fee",
"rate": 2.5,
"rateType": "percent",
"amount": 237,
"taxes": [
{
"id": "tax_TvP2DXWqjcjyEhMeC1UON",
"feeId": "fee_ZIp4Nn4CiclTRdJ8vXjCo",
"taxType": "tva",
"type": "percent",
"value": "42.66"
}
]
}
]
}
],
"mode": "live"
},
"test": false,
"id": "evt_Xj0QP8b5NqYgXq8rg3IgB",
"createdAt": "2024-06-06T10:17:42.968Z"
}
{
"owner": "3",
"type": "payment_intent.action_required",
"data": {
"id": "pay_Wwpm3BarAzK1nFsaChILY",
"createdAt": "2024-06-06T09:48:40.202Z",
"updatedAt": "2024-06-06T09:48:41.018Z",
"merchantId": "3",
"purchaseReference": "ref_001",
"customerReference": "cref_111",
"amount": 4950,
"currency": "XOF",
"token": "XXX",
"status": "action_required",
"overrideBusinessName": null,
"payments": [
{
"id": "pay_Wwpm3BarAzK1nFsaChILY",
"intentId": "pi_rRiK6_4YehnDKZtlv6ce5",
"createdAt": "2024-06-06T09:48:40.419Z",
"updatedAt": "2024-06-06T09:48:41.018Z",
"amount": 4950,
"currency": "XOF",
"status": "pending",
"method": "mobile_money",
"country": "CI",
"provider": "orange",
"number": "00000001",
"fees": [
{
"currency": "XOF",
"id": "fee_XTyrlgrls3nprRNXjTIFC",
"label": "payments.payment_processor_fee",
"rate": 1.5,
"rateType": "percent",
"amount": 75,
"taxes": [
{
"id": "tax_14NEcKn3mbIWRIJgSboWD",
"feeId": "fee_XTyrlgrls3nprRNXjTIFC",
"taxType": "tva",
"type": "percent",
"value": "13.5"
}
]
}
],
"nextAction": {
"type": "ussd",
"message": "Vous allez bientôt recevoir un message USSD sur votre téléphone pour valider la transaction."
}
}
],
"mode": "live",
"nextAction": {
"type": "ussd",
"message": "Vous allez bientôt recevoir un message USSD sur votre téléphone pour valider la transaction."
}
},
"test": false,
"id": "evt_NeQIBbHU415HtytWfpdI9",
"createdAt": "2024-06-06T09:48:41.049Z"
}
{
"owner": "3",
"type": "payment_intent.payment_failed",
"data": {
"id": "pi_ARPsD0D1Ip6h6t7imj_td",
"createdAt": "2024-06-06T09:36:15.932Z",
"updatedAt": "2024-06-06T10:15:06.637Z",
"merchantId": "3",
"purchaseReference": "p_ref_01",
"customerReference": "c_ref_01",
"amount": 300,
"currency": "XOF",
"token": "XXX",
"status": "payment_required",
"overrideBusinessName": "XXX",
"payments": [
{
"id": "pay_Ibrv2miHcxilNXuCCVWJH",
"intentId": "pi_ARPsD0D1Ip6h6t7imj_td",
"createdAt": "2024-06-06T09:36:16.155Z",
"updatedAt": "2024-06-06T10:15:06.637Z",
"amount": 300,
"currency": "XOF",
"status": "failed",
"method": "mobile_money",
"country": "CI",
"provider": "orange",
"number": "0704903330",
"fees": [
{
"currency": "XOF",
"id": "fee_UxpPlDEEGRpzGUNfr2mjv",
"label": "payments.payment_processor_fee",
"rate": 1.6,
"rateType": "percent",
"amount": 5,
"taxes": [
{
"id": "tax_cMk0WxrvVumkzvvjuihZv",
"feeId": "fee_UxpPlDEEGRpzGUNfr2mjv",
"taxType": "tva",
"type": "percent",
"value": "0.9"
}
]
}
],
"failure": {
"code": "forbidden_by_provider",
"message": "Le paiement a été refusé par l'opérateur."
}
}
],
"lastPaymentFailure": {
"code": "forbidden_by_provider",
"message": "Le paiement a été refusé par l'opérateur."
},
"mode": "live"
},
"test": false,
"id": "evt_a1qAnpgqMXwWuEl3Y2CWM",
"createdAt": "2024-06-06T10:15:06.676Z"
}
{
"owner": "3",
"type": "payment.pending",
"data": {
"id": "pay_Yw1lPIiq4NXS0GhDghSCf",
"intentId": "pi_OIULZrtgDsFyW740lSte4",
"createdAt": "2024-06-06T10:47:54.087Z",
"updatedAt": "2024-06-06T10:47:54.146Z",
"amount": 540,
"currency": "XOF",
"status": "pending",
"method": "mobile_money",
"country": "CI",
"provider": "orange",
"number": "00000001",
"fees": [
{
"currency": "XOF",
"id": "fee_gHuiX6MPbxzelvNiYFaX5",
"label": "payments.payment_processor_fee",
"rate": 1.6,
"rateType": "percent",
"amount": 9,
"taxes": [
{
"id": "tax_5AMRKK4mvhJAsU0brDuPF",
"feeId": "fee_gHuiX6MPbxzelvNiYFaX5",
"taxType": "tva",
"type": "percent",
"value": "1.62"
}
]
},
{
"currency": "XOF",
"id": "fee_AltZakt33ORsJOWoWddVb",
"label": "payments.modulo_5_roundup_fee",
"rate": 3,
"rateType": "flat",
"amount": 3,
"taxes": [
{
"id": "tax_RTxQuFscObmPtAAdVjCrb",
"feeId": "fee_AltZakt33ORsJOWoWddVb",
"taxType": "tva",
"type": "percent",
"value": "0.54"
}
]
}
]
},
"test": false,
"id": "evt_55TvVdQwnOtc2PKpSYGob",
"createdAt": "2024-06-06T10:47:54.184Z"
}
{
"owner": "3",
"type": "payment.action_required",
"data": {
"id": "pay_NXlR88JW89yXQSGP4oDLb",
"intentId": "pi_coTk5ZhyvqVFBVUul_OZO",
"createdAt": "2024-06-06T10:44:04.636Z",
"updatedAt": "2024-06-06T10:44:05.842Z",
"amount": 18450,
"currency": "XOF",
"status": "pending",
"method": "mobile_money",
"country": "CI",
"provider": "orange",
"number": "00000001",
"fees": [
{
"currency": "XOF",
"id": "fee_AqKZpdHaSiI5jOTHuLn4G",
"label": "payments.payment_processor_fee",
"rate": 2,
"rateType": "percent",
"amount": 369,
"taxes": [
{
"id": "tax_RR4njYvTrV4gu9VzX9hM0",
"feeId": "fee_AqKZpdHaSiI5jOTHuLn4G",
"taxType": "tva",
"type": "percent",
"value": "66.42"
}
]
}
],
"nextAction": {
"type": "ussd",
"message": "Vous allez bientôt recevoir un message USSD sur votre téléphone pour valider la transaction."
}
},
"test": false,
"id": "evt_hpySeIXRQCUzXqX8B9c7K",
"createdAt": "2024-06-06T10:44:05.888Z"
}
{
"owner": "3",
"type": "payment.failed",
"data": {
"id": "pay_RlL8voNJYNxVGC8wmj50f",
"intentId": "pi_N4i4MrVJM32heF5KLlqsf",
"createdAt": "2024-06-06T10:45:14.299Z",
"updatedAt": "2024-06-06T10:46:33.353Z",
"amount": 23065,
"currency": "XOF",
"status": "failed",
"method": "mobile_money",
"country": "CI",
"provider": "orange",
"number": "00000001",
"fees": [
{
"currency": "XOF",
"id": "fee_rR4XkFLUKhL8MYk9lsGFd",
"label": "payments.payment_processor_fee",
"rate": 2,
"rateType": "percent",
"amount": 462,
"taxes": [
{
"id": "tax_iUzzGD3heWrpILYqBNxTI",
"feeId": "fee_rR4XkFLUKhL8MYk9lsGFd",
"taxType": "tva",
"type": "percent",
"value": "83.16"
}
]
}
],
"failure": {
"code": "authentication_failed",
"message": "La validation du paiement par le client a échoué, le paiement a été annulé."
}
},
"test": false,
"id": "evt_XLFQHgszsCpvIyPyhCSlv",
"createdAt": "2024-06-06T10:46:33.413Z"
}
{
"owner": "3",
"type": "payment.succeeded",
"data": {
"id": "pay_KzParl9RAAzhaWVCIf3FO",
"intentId": "pi_RR1FVRA6sP46K7ryRHzyk",
"createdAt": "2024-06-06T09:48:26.004Z",
"updatedAt": "2024-06-06T09:48:40.910Z",
"amount": 2000,
"currency": "XOF",
"status": "successful",
"method": "mobile_money",
"country": "CI",
"provider": "orange",
"number": "00000001",
"fees": [
{
"currency": "XOF",
"id": "fee_kC9TDTKyfzaHdJW9BUN09",
"label": "payments.payment_processor_fee",
"rate": 2.7,
"rateType": "percent",
"amount": 54,
"taxes": [
{
"id": "tax_yrcpDQ3RLMx1usf2gPISb",
"feeId": "fee_kC9TDTKyfzaHdJW9BUN09",
"taxType": "tva",
"type": "percent",
"value": "10.395"
}
]
}
]
},
"test": false,
"id": "evt_HdpvK6G9lh3m9Z7oLEYv1",
"createdAt": "2024-06-06T09:48:40.955Z"
}