v1

latestOpenAPI 3.1.02026-07-2656258207.2 KB
charge.completed

Send charge completion webhook

postWebhookcharge.completed

Payload

webhook_idstring required

Webhook event identifier

timestampinteger required

Webhook event timestamp

type'charge.completed' | 'transfer.disburse' | 'transfer.reversal' | 'order.authorization' required

Webhook event type

Example payload

{
  "data": {
    "amount": 12.34,
    "currency": "NGN",
    "customer": {
      "id": "cus_3XarBILKQS",
      "address": {
        "city": "New York",
        "country": "US",
        "line1": "123 Main Street",
        "line2": "Apt 4B",
        "postal_code": "10001",
        "state": "New York"
      },
      "email": "cornelius@gmail.com",
      "name": {
        "first": "King",
        "middle": "Leo",
        "last": "LeBron"
      },
      "phone": {
        "country_code": "234",
        "number": "08012345678"
      }
    },
    "payment_method": {
      "id": "pmd_WRq7L4TM8p",
      "type": "card",
      "customer_id": "cus_3XarBILKQS",
      "device_fingerprint": "62wd23423rq324323qew1",
      "client_ip": "154.123.220.1",
      "created_datetime": "2024-12-03T13:54:21.546559974Z"
    }
  }
}

Response

Return a 200 status to indicate that the webhook was received successfully