Webhook

Webhook response

If you have Webhook notifications set up on your dashboard, we will send you a transaction response, a sample of which can be found below:

{
  "event": "charge.completed",
  "data": {
    "createdAt": "2021-11-18T15:23:16.781",
    "narration": "CARD Transaction ",
    "destinationCurrency": "NGN",
    "sourceAmount": 0.0023,
    "sourceCurrency": "USD",
    "tnxRef": "test910-on2007u047e-errrtd",
    "status": "successful",
    "destinationAmount": 1,
    "customer": {
      "id": 13,
      "name": "Steph Oj",
      "email": "[email protected]",
      "phone": null,
      "createdAt": "2021-07-20 10:28:43",
      "updatedAt": "2021-07-20 10:28:43"
    }
  }
}

Resend Webhook

POST {{env_url}}/nucleus/tnx/webhook?reference={{tx_ref}}

This endpoint allows you to resend webhooks from failed sending queues to your server.

You’d need to pass, as header the x-auth-token. This can be obtained from your merchant dashboard → Settings → Generate API keys → Merchant public key.

Headers

Name	Value
Content-Type	application/json
x-auth-token	Your merchant public key
Authorization	Bearer {{token}}

Query Params

"reference": {{tx_ref}}

Response

200

{
    "message": "webhook sent for reference {{tx_ref}}",
    "error": null,
    "data": null
}