Réponses Webhook (IPN) - KAYBIC AFRICA

Error

A valid request URL is required to generate request examples

POST

votre_url_webhook

Error

A valid request URL is required to generate request examples

Cette page documente les notifications IPN (Instant Payment Notification) que vous recevrez sur votre webhook. Description:

Type: Webhook (callback POST)
Utilisation: KAYBIC AFRICA envoie automatiquement les mises à jour de statut de transaction à l’URL IPN que vous avez configurée.

Exemple de réponse Webhook - SUCCESSFUL

{
  "transaction_id": "EFB.144358",
  "amount": 1000,
  "benefice": 1000,
  "commission": 0,
  "destination": "0500156008",
  "fee": 0,
  "response": "operation success",
  "error": "",
  "service_id": 14,
  "customer_name": "KAYBIC AFRICA",
  "state": "SUCCESSFUL",
  "custom_data": "custom_data",
  "ipn_url": "",
  "provider_id": null,
  "sms_link": 0,
  "created_at": "2022-10-18T02:38:44.000+00:00",
  "updated_at": "2022-10-18T02:38:44.000+00:00",
  "ipn_state": 0,
  "w_amount_after_transaction": "",
  "p_last_wallet_amount": 11,
  "p_new_wallet_amount": null,
  "p_id": 1,
  "hash": ""
}

Exemple de réponse Webhook - FAILED

{
  "transaction_id": "EFB.144359",
  "amount": 2000,
  "benefice": 2000,
  "commission": 0,
  "destination": "0670123456",
  "fee": 0,
  "response": "",
  "error": "message de l'erreur",
  "service_id": 10,
  "customer_name": "KAYBIC AFRICA",
  "state": "FAILED",
  "custom_data": "transaction_ref_123",
  "ipn_url": "",
  "provider_id": null,
  "sms_link": 0,
  "created_at": "2022-10-18T02:38:44.000+00:00",
  "updated_at": "2022-10-18T02:38:44.000+00:00",
  "ipn_state": 0,
  "w_amount_after_transaction": "",
  "p_last_wallet_amount": 11,
  "p_new_wallet_amount": null,
  "p_id": 1,
  "hash": ""
}

Champs importants

transaction_id: Identifiant unique de la transaction
state: Statut final de la transaction (SUCCESSFUL ou FAILED)
response: Message de réponse en cas de succès
error: Message d’erreur en cas d’échec
amount: Montant de la transaction
custom_data: Données personnalisées que vous avez envoyées lors de l’initiation

Notes

⚠️ Important: Vous devez retourner un code HTTP 200 pour confirmer la réception du webhook.
Si vous ne répondez pas, KAYBIC AFRICA tentera de renvoyer la notification plusieurs fois.
Les webhooks arrivent généralement dans les secondes suivant le traitement de la transaction.
Utilisez le champ custom_data pour réconcilier les transactions avec vos données internes.

Il n’existe pas de méthode spécifique pour configurer les webhooks, l’IPN est transféré directement dans la requête pendant l’initialisation de la transaction.

Body

application/json

transaction_id

string

Example:

"EFB.144358"

amount

number

Example:

1000

benefice

number

Example:

1000

commission

number

Example:

0

destination

string

Example:

"0500156008"

fee

number

Example:

0

response

string

Example:

"operation success"

error

string

Example:

"message de l'erreur (si transaction Echec)"

service_id

number

Example:

14

customer_name

string

Example:

"KAYBIC AFRICA"

state

string

Example:

"FAILED"

custom_data

string

Example:

"custom_data"

ipn_url

string

Example:

""

provider_id

null

Example:

null

sms_link

number

Example:

0

created_at

string

Example:

"2022-10-18T02:38:44.000+00:00"

updated_at

string

Example:

"2022-10-18T02:38:44.000+00:00"

ipn_state

number

Example:

0

w_amount_after_transaction

string

Example:

""

p_last_wallet_amount

number

Example:

11

p_new_wallet_amount

null

Example:

null

p_id

number

Example:

1

hash

string

Example:

""

​Exemple de réponse Webhook - SUCCESSFUL

​Exemple de réponse Webhook - FAILED

​Champs importants

​Notes

Body

Exemple de réponse Webhook - SUCCESSFUL

Exemple de réponse Webhook - FAILED

Champs importants

Notes