collection.succeeded

{
  "id": "evt_3ab4e0d5d27445cf8a52ab3d8cb8f0b1",
  "type": "collection.succeeded",
  "created_at": "2026-09-22T10:41:18.402Z",
  "organization_id": "acct_7KpQ2mNv4XbR9dLc",
  "data": {
    "charge_id": "ch_1a2b3c4d5e6f",
    "checkout_id": "chk_6R7s8T9u0V1w2X3y",
    "reference": "ORD-20260922-1041",
    "status": "SUCCEEDED",
    "amount": "75000.00",
    "currency": "NGN",
    "settlement_amount": "73875.00",
    "settlement_currency": "NGN",
    "processing_fee": "1125.00",
    "processing_fee_currency": "NGN",
    "fee_bearer": "merchant",
    "product_cart": [
      { "product_id": "prod_1a2b3c", "quantity": 2 },
      { "product_id": "prod_9x8y7z", "quantity": 1, "amount": "5000.00" }
    ],
    "customer": {
      "id": "cust_xyz789",
      "email": "jane@example.com",
      "name": "Jane Doe"
    },
    "payment_method_details": {
      "type": "bank_transfer",
      "bank_transfer": {
        "sender_name": "JANE ADEYEMI",
        "sender_bank": "Guaranty Trust Bank",
        "sender_bank_code": "058",
        "sender_account_number": "2294879124",
        "session_id": "000013260922104115000821734502",
        "narration": "ORD-20260922-1041",
        "virtual_account": {
          "id": null,
          "account_number": "9902847361",
          "bank_name": "Example Bank",
          "type": "one_time",
          "expires_at": "2026-09-22T11:11:18.402Z"
        }
      }
    },
    "metadata": {
      "order_id": "ORD-20260922-1041"
    }
  }
}

{
  "id": "evt_3ab4e0d5d27445cf8a52ab3d8cb8f0b1",
  "type": "collection.succeeded",
  "created_at": "2026-09-22T10:41:18.402Z",
  "organization_id": "acct_7KpQ2mNv4XbR9dLc",
  "data": {
    "charge_id": "ch_1a2b3c4d5e6f",
    "checkout_id": "chk_6R7s8T9u0V1w2X3y",
    "reference": "ORD-20260922-1041",
    "status": "SUCCEEDED",
    "amount": "75000.00",
    "currency": "NGN",
    "settlement_amount": "73875.00",
    "settlement_currency": "NGN",
    "processing_fee": "1125.00",
    "processing_fee_currency": "NGN",
    "fee_bearer": "merchant",
    "product_cart": [
      { "product_id": "prod_1a2b3c", "quantity": 2 },
      { "product_id": "prod_9x8y7z", "quantity": 1, "amount": "5000.00" }
    ],
    "customer": {
      "id": "cust_xyz789",
      "email": "jane@example.com",
      "name": "Jane Doe"
    },
    "payment_method_details": {
      "type": "bank_transfer",
      "bank_transfer": {
        "sender_name": "JANE ADEYEMI",
        "sender_bank": "Guaranty Trust Bank",
        "sender_bank_code": "058",
        "sender_account_number": "2294879124",
        "session_id": "000013260922104115000821734502",
        "narration": "ORD-20260922-1041",
        "virtual_account": {
          "id": null,
          "account_number": "9902847361",
          "bank_name": "Example Bank",
          "type": "one_time",
          "expires_at": "2026-09-22T11:11:18.402Z"
        }
      }
    },
    "metadata": {
      "order_id": "ORD-20260922-1041"
    }
  }
}

Sent when a charge reaches a successful state. For a checkout payment, use data.checkout_id or your supplied data.reference to find the order before fulfilling it or granting access. A virtual account deposit has no checkout or order reference; reconcile the sender and amount against your records before marking any order paid. Deduplicate deliveries using the event id.

data.charge_id may be null in some scenarios:

Test webhooks: events sent from the webhook test tool are not backed by a real charge.
Legacy payments: collections processed before the charge model was introduced may not have an associated charge record.
Manual reconciliation: administrative payment confirmations applied outside the standard charge flow do not create a charge.

Always guard against a null charge_id before using it for lookups.

The example below is for an account’s own checkout. Events forwarded to a platform from a connected account also include a top-level account field with the connected account’s ID.

{
  "id": "evt_3ab4e0d5d27445cf8a52ab3d8cb8f0b1",
  "type": "collection.succeeded",
  "created_at": "2026-09-22T10:41:18.402Z",
  "organization_id": "acct_7KpQ2mNv4XbR9dLc",
  "data": {
    "charge_id": "ch_1a2b3c4d5e6f",
    "checkout_id": "chk_6R7s8T9u0V1w2X3y",
    "reference": "ORD-20260922-1041",
    "status": "SUCCEEDED",
    "amount": "75000.00",
    "currency": "NGN",
    "settlement_amount": "73875.00",
    "settlement_currency": "NGN",
    "processing_fee": "1125.00",
    "processing_fee_currency": "NGN",
    "fee_bearer": "merchant",
    "product_cart": [
      { "product_id": "prod_1a2b3c", "quantity": 2 },
      { "product_id": "prod_9x8y7z", "quantity": 1, "amount": "5000.00" }
    ],
    "customer": {
      "id": "cust_xyz789",
      "email": "jane@example.com",
      "name": "Jane Doe"
    },
    "payment_method_details": {
      "type": "bank_transfer",
      "bank_transfer": {
        "sender_name": "JANE ADEYEMI",
        "sender_bank": "Guaranty Trust Bank",
        "sender_bank_code": "058",
        "sender_account_number": "2294879124",
        "session_id": "000013260922104115000821734502",
        "narration": "ORD-20260922-1041",
        "virtual_account": {
          "id": null,
          "account_number": "9902847361",
          "bank_name": "Example Bank",
          "type": "one_time",
          "expires_at": "2026-09-22T11:11:18.402Z"
        }
      }
    },
    "metadata": {
      "order_id": "ORD-20260922-1041"
    }
  }
}

Event fields

string

The event’s unique identifier, prefixed evt_. Use it to deduplicate deliveries.

string

Always collection.succeeded.

string

When the event occurred, in UTC.

string

The account where the event originated. For a connected-account payment, this is the connected account’s ID, not your platform’s ID.

string

Present on an event delivered to a platform from a connected account; contains that connected account’s ID. See Connect events.

string | null

Charge ID for reconciliation and retrieval calls. May be null, see note above.

string | null

Checkout that originated the charge. null for a fixed virtual-account deposit and other payments without a checkout.

string | null

Checkout reference you supplied, when available.

string

The uppercase charge state that triggered this event. SUCCEEDED: the full amount was collected. ACCEPTED: the payment was accepted on terms other than the exact amount requested. OVERPAID: more arrived than was due, with the difference in the overpayment fields below. The payment object returns these states in lowercase, so do not compare the values directly.

string

Original charged amount in data.currency.

string

Customer payment currency code.

string

Amount credited in data.settlement_currency.

string

Currency used for settlement credit.

string | null

Bachs processing fee in data.processing_fee_currency. null when the final settlement value has not yet been determined.

string | null

Currency of data.processing_fee, typically the settlement currency. null when processing_fee is null.

string

Who absorbed the processing fee. Either customer (fee added on top of the charge amount) or merchant (fee deducted from settlement).

array | null

Products purchased in a one-time checkout session. Each item contains product_id, quantity, and amount (present only for custom-priced products). null when no checkout created the charge.

object

The customer who made the payment. id is always present and can be null for a guest or a payment received without a checkout, such as a virtual account deposit. email and name appear only when a checkout collected them.

object | null

How the money moved, keyed by type. For a bank transfer, bank_transfer can include the sender’s details, the interbank session_id, their narration, and the virtual account that received the money. Treat each nested field as optional because the sending bank may omit it. See the payment object for the full shape.

object

Public metadata stored with the charge.

string | null

Why the charge reached this state, when we have something to say. Absent on an ordinary success.

string

Present only when status is OVERPAID: the amount that was due.

string

Present only when status is OVERPAID: the amount that actually arrived.

string

Present only when status is OVERPAID: the difference between the two, which the customer paid on top.

Concepts

Events

Endpoint API

collection.succeeded

Event fields

​Event fields

Event fields