collection.underpaid

{
  "id": "evt_6d5c4b3a2f1e0d9c8b7a6f5e4d3c2b1a",
  "type": "collection.underpaid",
  "created_at": "2026-02-22T17:10:00.000000+00:00",
  "organization_id": "acct_7KpQ2mNv4XbR9dLc",
  "data": {
    "charge_id": "ch_1a2b3c4d5e6f",
    "reference": "order_1042",
    "checkout_id": "chk_6R7s8T9u0V1w2X3y",
    "amount_paid": "50000.00",
    "amount_expected": "75000.00",
    "amount_remaining": "25000.00",
    "currency": "NGN",
    "status": "UNDERPAID",
    "metadata": {}
  }
}

{
  "id": "evt_6d5c4b3a2f1e0d9c8b7a6f5e4d3c2b1a",
  "type": "collection.underpaid",
  "created_at": "2026-02-22T17:10:00.000000+00:00",
  "organization_id": "acct_7KpQ2mNv4XbR9dLc",
  "data": {
    "charge_id": "ch_1a2b3c4d5e6f",
    "reference": "order_1042",
    "checkout_id": "chk_6R7s8T9u0V1w2X3y",
    "amount_paid": "50000.00",
    "amount_expected": "75000.00",
    "amount_remaining": "25000.00",
    "currency": "NGN",
    "status": "UNDERPAID",
    "metadata": {}
  }
}

Sent when a crypto payment arrives for less than the charge amount. The customer can send the rest to complete the payment. A bank transfer that arrives short does not send this event: the checkout does not complete, and you can refund the amount received.

{
  "id": "evt_6d5c4b3a2f1e0d9c8b7a6f5e4d3c2b1a",
  "type": "collection.underpaid",
  "created_at": "2026-02-22T17:10:00.000000+00:00",
  "organization_id": "acct_7KpQ2mNv4XbR9dLc",
  "data": {
    "charge_id": "ch_1a2b3c4d5e6f",
    "reference": "order_1042",
    "checkout_id": "chk_6R7s8T9u0V1w2X3y",
    "amount_paid": "50000.00",
    "amount_expected": "75000.00",
    "amount_remaining": "25000.00",
    "currency": "NGN",
    "status": "UNDERPAID",
    "metadata": {}
  }
}

Event fields

string

The event’s unique identifier, prefixed evt_.

string

Always collection.underpaid.

string

When the event occurred, in UTC.

string

Your account’s ID.

string

The underpaid charge’s ID.

string | null

Checkout reference, when available.

string | null

The checkout that originated the charge.

string

Amount the customer actually paid, in data.currency.

string

Amount that was due.

string

The shortfall: amount_expected minus amount_paid.

string

Customer payment currency code.

string

Always UNDERPAID, in uppercase. The payment object returns this state in lowercase, so do not compare the two directly.

object

Public metadata stored with the charge.

Concepts

Events

Endpoint API

collection.underpaid

Event fields

​Event fields

Event fields