Send charge completion webhook

WEBHOOK charge.completed

Example

{
  "webhook_id": "<string>",
  "timestamp": 123,
  "type": "charge.completed",
  "data": {
    "id": "<string>",
    "amount": 12.34,
    "currency": "NGN",
    "customer": {
      "id": "cus_3XarBILKQS",
      "address": {
        "city": "New York",
        "country": "US",
        "line1": "123 Main Street",
        "postal_code": "10001",
        "state": "New York",
        "line2": "Apt 4B"
      },
      "email": "[e-mail]",
      "name": {
        "first": "King",
        "middle": "Leo",
        "last": "LeBron"
      },
      "phone": {
        "country_code": "234",
        "number": "08012345678"
      },
      "meta": {},
      "created_datetime": "2023-11-07T05:31:56Z"
    },
    "description": "<string>",
    "meta": {},
    "payment_method": {
      "id": "pmd_WRq7L4TM8p",
      "type": "card",
      "card": {
        "expiry_month": "09",
        "expiry_year": "32",
        "first6": "123412",
        "last4": "1234",
        "network": "MASTERCARD",
        "billing_address": {
          "city": "New York",
          "country": "US",
          "line1": "123 Main Street",
          "postal_code": "10001",
          "state": "New York",
          "line2": "Apt 4B"
        },
        "cof": {
          "enabled": true,
          "agreement_id": "Agreement00w02W1",
          "recurring_amount_variability": "VARIABLE",
          "agreement_type": "UNSCHEDULED",
          "trace_id": "123456789"
        },
        "card_holder_name": "Alex James"
      },
      "customer_id": "cus_3XarBILKQS",
      "meta": {},
      "device_fingerprint": "62wd23423rq324323qew1",
      "client_ip": "154.123.220.1",
      "created_datetime": "2024-12-03T13:54:21.546559974Z"
    },
    "redirect_url": "<string>",
    "reference": "<string>",
    "status": "<string>",
    "processor_response": {
      "type": "approved",
      "code": "00"
    },
    "created_datetime": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Notification about a completed charge

Charge completion webhook payload

webhook_id · string · required

Webhook event identifier

timestamp · integer<int64> · required

Webhook event timestamp

type · enum<string> · required

Webhook event type

Available options: charge.completed, transfer.disburse, transfer.reversal, order.authorization

data · object · required

Show child attributes

Response

200

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