Webhooks

What is a Webhook

At Vella, webhooks are a very important part of our payment processor. We use webhooks to communicate with different services. Primarily we use webhooks to share information about an event that happened on your account with you. These events could range from a successful transaction to a failed transaction or even a new transaction on your account.

Sample Webhooks

{
  "type": "transaction.completed",
  "data": {
    "narration": "Received $100 from Vella Checkout",
    "settlement_currency": "USDC",
    "amount": 100,
    "total": 101,
    "tnx_ref": "TRSVFV345345365365365",
    "reference": "TRSVFV345345365365365XXX",
    "status": "successful",
    "created_at": "2021-11-18T15:23:16.781",
    "customer": {
      "name": "vella",
      "email": "[email protected]",
    }
  }
}

{
  "type": "transaction.rejected",
  "data": {
    "narration": "From OPay/XOOp6/1000042309151914141066651200000",
    "settlement_currency": "NGN",
    "amount": 100,
    "amount_received": 200,
    "total": 101,
    "tnx_ref": "TRSVFV345345365365365",
    "reference": "TRSVFV345345365365365XXX",
    "reason":"The received amount N200 does not match the required amount N101 ",
    "status": "failed",
    "created_at": "2021-11-18T15:23:16.781",
    "customer": {
      "name": "vella",
      "email": "[email protected]",
    }
  }
}

{
  "type": "payout.completed",
  "data": {
    "id": "xxxx-xxxx-xxxx-xxxx-xxx-",
    "currency": "NGN",
    "amount": 100,
    "total": 120,
    "fee":20,
    "reference": "TRSVFV345345365365365XXX",
    "status": "successful",
    "created_at": "2021-11-18T15:23:16.781",
  }
}