Event Types

See Webhooks overview for the delivery model, retries, and signature verification, and the Webhooks API reference for creating and managing webhook endpoints. All webhook payloads follow the same envelope:

{
  "event": "<event-type>",
  "data": { ... }
}

The data object shape depends on the event type. Every field documented below is present in the data object.

entities.created

Fired when a new entity is created via POST /individual-entities or POST /business-entities. data is the entity object directly, not wrapped further.

string

Unique entity identifier.

string

individual or business.

string

Review state. One of incomplete, pending, approved, rejected, or suspended. Always incomplete for a newly created entity.

string

Display name for the entity.

boolean

Whether this entity is the top of its hierarchy, or a child of another entity.

string

The ID of the parent entity, when this entity was created under one.

string

The ID of the associated person record. Present only when type is individual.

string

The ID of the associated business record. Present only when type is business.

string

The ID of the user associated with this entity, when applicable.

string

How the entity was created. e.g. api, user.

string

The compliance risk band assigned to this entity. e.g. medium.

number

Unix timestamp in milliseconds when the entity was created.

number

Unix timestamp in milliseconds when the entity was last updated.

{
  "event": "entities.created",
  "data": {
    "id": "01HXYZ1234ABCDEFGHJKMNPQRS",
    "type": "business",
    "status": "incomplete",
    "name": "App Business Ltd",
    "is_root": false,
    "parent_entity": "01HXYZ2345ABCDEFGHJKMNPQRS",
    "business_id": "01HXYZ3456ABCDEFGHJKMNPQRS",
    "user_id": "01HXYZ4567ABCDEFGHJKMNPQRS",
    "creation_context": "api",
    "risk_level": "medium",
    "created": 1787487225040,
    "updated": 1787487225040
  }
}

entities.updated

Fired when an entity’s state changes, e.g. status moves from pending to approved, or any other field on the entity object is updated. data is the entity object directly, not wrapped further.

string

Unique entity identifier.

string

individual or business.

string

Review state. One of incomplete, pending, approved, rejected, or suspended.

string

Display name for the entity.

boolean

Whether this entity is the top of its hierarchy, or a child of another entity.

string

The ID of the parent entity, when this entity was created under one.

string

The ID of the associated person record. Present only when type is individual.

string

The ID of the associated business record. Present only when type is business.

string

The ID of the user associated with this entity, when applicable.

string

How the entity was created. e.g. api, user.

string

The compliance risk band assigned to this entity. e.g. medium.

number

Unix timestamp in milliseconds when the entity was created.

number

Unix timestamp in milliseconds when the entity was last updated.

{
  "event": "entities.updated",
  "data": {
    "id": "01HXYZ1234ABCDEFGHJKMNPQRS",
    "type": "business",
    "status": "approved",
    "name": "App Business Ltd",
    "is_root": false,
    "parent_entity": "01HXYZ2345ABCDEFGHJKMNPQRS",
    "business_id": "01HXYZ3456ABCDEFGHJKMNPQRS",
    "user_id": "01HXYZ4567ABCDEFGHJKMNPQRS",
    "creation_context": "api",
    "risk_level": "medium",
    "created": 1787487225040,
    "updated": 1787487593518
  }
}

accounts.created

Fired when a new account is created for an entity.

object

The newly created account.

Show account fields

string

Unique account identifier.

string

The ID of the entity that owns this account.

string

Account type. e.g. checking.

string

ISO 4217 currency code.

string

Human-readable account label.

object

Current account balance.

Show balance fields

number

Available balance in the smallest currency unit.

number

Current balance including pending transactions.

object

Key-value metadata attached to the account.

number

Creation timestamp in Unix milliseconds.

number

Last update timestamp in Unix milliseconds.

object

Summary of how this account creation affects the entity.

Show entity_impact fields

string

The entity ID.

number

Total number of accounts now held by this entity.

array

List of account types held by the entity.

boolean

Whether a default account has been set for this entity.

{
  "event": "accounts.created",
  "data": {
    "account": {
      "id": "01HXYZ5001ABCDEFGHJKMNPQRS",
      "entity_id": "01HXYZ5002ABCDEFGHJKMNPQRS",
      "type": "checking",
      "currency": "USD",
      "display_name": "Primary USD Account",
      "balance": {
        "available": 0,
        "current": 0
      },
      "meta": {
        "external_ref": "ext_acc_12345",
        "purpose": "operational"
      },
      "created": 1759859936448,
      "updated": 1759859936448
    },
    "entity_impact": {
      "entity_id": "01HXYZ5002ABCDEFGHJKMNPQRS",
      "total_accounts": 1,
      "account_type": ["checking"],
      "default_account_set": true
    }
  }
}

account_details.created

Fired when bank account numbers or wallet details are generated for an account.

object

The newly created account details record.

Show account_details fields

string

Unique identifier for the account details record.

string

The ID of the entity that owns this account.

string

The ID of the account these details belong to.

string

The assigned account number.

string

The routing number (where applicable).

object

The issuing bank or institution.

Show issuer fields

string

Institution code.

string

Institution name.

string

Account details status. e.g. active.

number

Creation timestamp in Unix milliseconds.

number

Last update timestamp in Unix milliseconds.

{
  "event": "account_details.created",
  "data": {
    "account_details": {
      "id": "01HXYZ5101ABCDEFGHJKMNPQRS",
      "entity_id": "01HXYZ5102ABCDEFGHJKMNPQRS",
      "account_id": "01HXYZ5103ABCDEFGHJKMNPQRS",
      "account_number": "000987654321",
      "routing_number": "021000021",
      "issuer": {
        "code": "CHASE",
        "name": "JPMorgan Chase"
      },
      "status": "active",
      "created": 1759859979165,
      "updated": 1759859979165
    }
  }
}

account_details.updated

Fired when account details are modified, for example a status change or metadata update.

string

Unique identifier for the account details record.

string

The ID of the entity that owns this account.

string

The ID of the account these details belong to.

string

The account number.

object

The issuing bank or institution.

Show issuer fields

string

Institution code.

string

Institution name.

string

Updated status of the account details record.

number

Original creation timestamp in Unix milliseconds.

number

Timestamp of this update in Unix milliseconds.

{
  "event": "account_details.updated",
  "data": {
    "id": "01HXYZ5201ABCDEFGHJKMNPQRS",
    "entity_id": "01HXYZ5202ABCDEFGHJKMNPQRS",
    "account_id": "01HXYZ5203ABCDEFGHJKMNPQRS",
    "account_number": "12345678",
    "issuer": {
      "code": "HSBC",
      "name": "HSBC UK"
    },
    "status": "active",
    "created": 1760005788571,
    "updated": 1760005799179
  }
}

inflows.completed

Fired when a payment is received into an account.

string

Unique identifier for the inflow transaction.

number

Amount received in the smallest currency unit. 100 = $1.00 USD.

string

ISO 4217 currency code.

string

Unique reference for the transaction. Use this to deduplicate events.

string

Identifier of the sending counterparty.

string

The ID of the account that received the funds.

string

The ID of the entity that owns the receiving account.

string

Transaction status. successful for completed inflows.

string

Human-readable status description.

string

Payment reference or description from the sender.

string

inflow.

string

The rail or method for this inflow, e.g. bank-transfer, book-transfer.

number

Fee applied to this transaction in the smallest currency unit.

object

Provider-specific metadata. Field set varies by payment_type; commonly includes fx_quote_id and provider_reference when the inflow involved a currency conversion.

object

The account credited.

Show account fields

string

The account’s ID. Matches account_id.

string

Display name of the account.

number

Creation timestamp in Unix milliseconds.

number

Last update timestamp in Unix milliseconds.

{
  "event": "inflows.completed",
  "data": {
    "id": "01HXYZ5301ABCDEFGHJKMNPQRS",
    "amount": 10000,
    "currency": "USD",
    "unique_reference": "01HXYZ5302ABCDEFGHJKMNPQRS-1759504425996",
    "counterparty_id": "01HXYZ5304ABCDEFGHJKMNPQRS",
    "account_id": "01HXYZ5302ABCDEFGHJKMNPQRS",
    "entity_id": "01HXYZ5303ABCDEFGHJKMNPQRS",
    "status": "successful",
    "status_reason": "Successful.",
    "narration": "Invoice payment received",
    "type": "inflow",
    "payment_type": "bank-transfer",
    "applicable_fee": 0,
    "meta": {},
    "account": {
      "id": "01HXYZ5302ABCDEFGHJKMNPQRS",
      "display_name": "Primary USD Account"
    },
    "created": 1759860119195,
    "updated": 1759860119195
  }
}

funding_sessions.updated

Fired when a funding session is updated, such as when it is settled or failed.

string

Unique identifier for the funding session.

string

Current status of the funding session. e.g. settled, failed, awaiting_user.

string

The status before this update.

number

Funding amount in the smallest currency unit. 100 = $1.00 USD.

string

ISO 4217 currency code.

string

The ID of the account being funded.

string

Unique reference for the funding session. Use this to deduplicate events.

string

Description of the funding session.

object

Present when status is settled.

Show settlement fields

string

The settlement rail. Present only for open-banking funding sessions.

number

Unix timestamp in milliseconds when the funding session settled.

object

Present when status is failed. See Failure codes below.

Show failure fields

string

Machine-readable failure reason.

string

Human-readable failure description.

number

Unix timestamp in milliseconds when the funding session failed.

object

Optional key-value metadata, present only when additional data was sent to the field. Contents vary by provider. For momo, always includes msisdn and channel.

{
  "event": "funding_sessions.updated",
  "data": {
    "id": "01HXYZ5701ABCDEFGHJKMNPQRS",
    "status": "settled",
    "previous_status": "awaiting_user",
    "amount": 10000,
    "currency": "GBP",
    "account_id": "01HXYZ5702ABCDEFGHJKMNPQRS",
    "unique_reference": "1782291912280",
    "narration": "Funding session",
    "settlement": {
        "rail": "bacs",
        "settled_at": 1782292167277
    }
  }
}

{
  "event": "funding_sessions.updated",
  "data": {
    "id": "01HXYZ5801ABCDEFGHJKMNPQRS",
    "status": "failed",
    "previous_status": "awaiting_user",
    "amount": 1000,
    "currency": "GBP",
    "account_id": "01HXYZ5702ABCDEFGHJKMNPQRS",
    "unique_reference": "1782292544740",
    "narration": "Funding session",
    "failure": {
        "code": "INSUFFICIENT_FUNDS",
        "message": "There isn't enough money in this account to complete the payment. Try again, or select another account or bank.",
        "failed_at": 1782292572343
    }
  }
}

Failure codes

The failure.code field identifies the reason for funding session failures:

Code	Description
`PAYMENT_BLOCKED`	Payment was blocked for violating compliance rules
`PAYMENT_REJECTED`	Payment was rejected by the financial institution
`PAYMENT_CANCELLED`	User cancelled the payment during authorisation
`INSUFFICIENT_FUNDS`	Account does not have enough funds
`INSTITUTION_UNAVAILABLE`	Financial institution is temporarily down or not responding
`INSTITUTION_NOT_SUPPORTED`	Financial institution is no longer supported on provider
`PROVIDER_ERROR`	Undocumented error from provider
`SESSION_EXPIRED`	Checkout URL expired before the user completed the payment flow

payment_intent.completed

Fired when a Payment Intent completes successfully. Use this event to fulfil the customer’s order or mark the payment as paid.

string

Unique identifier for the payment intent.

string

ISO 4217 currency code.

number

Amount in the smallest currency unit. 100 = $1.00 USD.

string

Merchant-supplied reference for the payment.

string

Description of what the payment is for.

string

completed for a successful payment intent.

string

Human-readable status description. Present when status is cancelled. For a failed payment, check status_reason on the nested intent_action instead.

string

The ID of the entity receiving the payment.

string

The ID of the account credited.

number

Unix timestamp in milliseconds when the payment intent was created.

object | null

The confirmation attempt for this payment intent. See The Intent Action object. null after a cancellation.

{
  "event": "payment_intent.completed",
  "data": {
    "id": "01HXYZ5501ABCDEFGHJKMNPQRS",
    "currency": "USD",
    "amount": 1000,
    "reference": "order_abc123",
    "description": "Order #1042",
    "status": "completed",
    "entity_id": "01HXYZ5502ABCDEFGHJKMNPQRS",
    "account_id": "01HXYZ5503ABCDEFGHJKMNPQRS",
    "created": 1787943000000,
    "intent_action": {
      "id": "01HXYZ5504ABCDEFGHJKMNPQRS",
      "currency": "USD",
      "amount": 1000,
      "applicable_fee": 60,
      "charge_amount": 1000,
      "refunded_amount": 0,
      "reference": "order_abc123",
      "action": "confirm",
      "category": "collections",
      "payment_type": "card-acq",
      "payment_type_data": {
        "payment_country": "US",
        "auth_model": "3ds_required",
        "last_four_digits": "1111",
        "card_brand": "visa",
        "card_type": "credit"
      },
      "status": "completed",
      "entity_id": "01HXYZ5502ABCDEFGHJKMNPQRS",
      "account_id": "01HXYZ5503ABCDEFGHJKMNPQRS",
      "payment_intent_id": "01HXYZ5501ABCDEFGHJKMNPQRS",
      "return_url": "https://yourplatform.com/checkout/complete",
      "created": 1787943005000
    }
  }
}

payment_intent.failed

Fired when a Payment Intent cannot be completed. Check status_reason on the nested intent_action when it is present. The payload shape is identical to payment_intent.completed. The status field will be failed.

{
  "event": "payment_intent.failed",
  "data": {
    "id": "01HXYZ5509ABCDEFGHJKMNPQRS",
    "currency": "USD",
    "amount": 1000,
    "reference": "order_abc125",
    "description": "Order #1044",
    "status": "failed",
    "entity_id": "01HXYZ5502ABCDEFGHJKMNPQRS",
    "account_id": "01HXYZ5503ABCDEFGHJKMNPQRS",
    "created": 1787945000000,
    "intent_action": {
      "id": "01HXYZ5510ABCDEFGHJKMNPQRS",
      "currency": "USD",
      "amount": 1000,
      "applicable_fee": 75,
      "charge_amount": 1000,
      "refunded_amount": 0,
      "reference": "order_abc125",
      "action": "confirm",
      "category": "collections",
      "payment_type": "applepay-acq",
      "payment_type_data": {
        "payment_country": "NL"
      },
      "status": "failed",
      "status_reason": "User cancelled payment session",
      "entity_id": "01HXYZ5502ABCDEFGHJKMNPQRS",
      "account_id": "01HXYZ5503ABCDEFGHJKMNPQRS",
      "payment_intent_id": "01HXYZ5509ABCDEFGHJKMNPQRS",
      "return_url": "https://yourplatform.com/checkout/complete",
      "created": 1787945005000
    }
  }
}

payment_intent.cancelled

Fired when a Payment Intent is cancelled before it is confirmed. The payload shape is identical to payment_intent.completed. The status field will be cancelled, and intent_action is null since no confirmation was submitted.

{
  "event": "payment_intent.cancelled",
  "data": {
    "id": "01HXYZ5511ABCDEFGHJKMNPQRS",
    "currency": "USD",
    "amount": 1000,
    "reference": "order_abc126",
    "description": "Order #1045",
    "status": "cancelled",
    "status_reason": "Customer abandoned checkout",
    "entity_id": "01HXYZ5502ABCDEFGHJKMNPQRS",
    "account_id": "01HXYZ5503ABCDEFGHJKMNPQRS",
    "created": 1787946000000,
    "intent_action": null
  }
}

payment_refund.completed

Fired when a refund request completes successfully.

string

Unique identifier for the refund.

string

Merchant-supplied reference for the refund.

string

The ID of the original payment this refund applies to.

number

Refund amount in the smallest currency unit. 100 = $1.00 USD.

string

ISO 4217 currency code.

string

Reason provided for the refund.

string

successful for a completed refund.

string

Human-readable status description. Present when status is failed.

string

The ID of the account the refund was issued from.

string

The ID of the entity that issued the refund.

number

Unix timestamp in milliseconds when the refund was created.

{
  "event": "payment_refund.completed",
  "data": {
    "id": "01HXYZ5601ABCDEFGHJKMNPQRS",
    "reference": "refund_001",
    "payment_intent_action_id": "01HXYZ5602ABCDEFGHJKMNPQRS",
    "amount": 5000,
    "currency": "USD",
    "refund_reason": "Customer requested a refund",
    "status": "successful",
    "account_id": "01HXYZ5603ABCDEFGHJKMNPQRS",
    "entity_id": "01HXYZ5604ABCDEFGHJKMNPQRS",
    "created": 1700000000000
  }
}

payment_refund.failed

Fired when a refund request fails. The payload shape is identical to payment_refund.completed. The status field will be failed.

{
  "event": "payment_refund.failed",
  "data": {
    "id": "01HXYZ5601ABCDEFGHJKMNPQRS",
    "reference": "refund_001",
    "payment_intent_action_id": "01HXYZ5602ABCDEFGHJKMNPQRS",
    "amount": 6000,
    "currency": "USD",
    "refund_reason": "Customer requested a refund",
    "status": "failed",
    "status_reason": "The requested refund amount exceeds the amount collected for this payment.",
    "account_id": "01HXYZ5603ABCDEFGHJKMNPQRS",
    "entity_id": "01HXYZ5604ABCDEFGHJKMNPQRS",
    "created": 1700000000000
  }
}

outflows.created

Fired when a transfer request is received and queued for processing.

string

Unique identifier for the outflow transaction.

number

Transfer amount in the smallest currency unit. 100 = $1.00 USD.

string

ISO 4217 currency code.

string

The idempotency key passed when initiating the transfer.

string

The ID of the recipient counterparty.

string

The ID of the source account being debited.

string

The ID of the entity initiating the transfer.

string

pending: transfer is queued and awaiting processing.

string

awaiting_processing.

string

Transfer description.

string

outflow.

string

The rail or method for this transfer, e.g. bank-transfer, book-transfer. For a card transaction, one of card-debit or card-debit-recoup (both debits).

number

Fee applied to this transfer in the smallest currency unit.

object

Provider-specific metadata. Field set varies by payment_type; commonly includes fx_quote_id and provider_reference when the transfer involved a currency conversion.

object

The source account being debited.

Show account fields

string

The account’s ID. Matches account_id.

string

Display name of the account.

object

Present for some account types. Additional account metadata, e.g. asset_type, network.

string

Present for card transactions. The ID of the card used.

number

Creation timestamp in Unix milliseconds.

number

Last update timestamp in Unix milliseconds.

{
  "event": "outflows.created",
  "data": {
    "id": "01HXYZ5401ABCDEFGHJKMNPQRS",
    "amount": 5000,
    "currency": "GBP",
    "unique_reference": "PAY-2025-001",
    "counterparty_id": "01HXYZ5402ABCDEFGHJKMNPQRS",
    "account_id": "01HXYZ5403ABCDEFGHJKMNPQRS",
    "entity_id": "01HXYZ5404ABCDEFGHJKMNPQRS",
    "status": "pending",
    "status_reason": "awaiting_processing",
    "narration": "Vendor payment",
    "type": "outflow",
    "payment_type": "bank-transfer",
    "applicable_fee": 75,
    "meta": {},
    "account": {
      "id": "01HXYZ5403ABCDEFGHJKMNPQRS",
      "display_name": "Operating GBP"
    },
    "created": 1760434049154,
    "updated": 1760434050159
  }
}

outflows.completed

Fired when a transfer is delivered successfully to the recipient. The payload shape is identical to outflows.created. The status field will be successful and status_reason will be processing_complete.

{
  "event": "outflows.completed",
  "data": {
    "id": "01HXYZ5401ABCDEFGHJKMNPQRS",
    "amount": 5000,
    "currency": "GBP",
    "unique_reference": "PAY-2025-001",
    "counterparty_id": "01HXYZ5402ABCDEFGHJKMNPQRS",
    "account_id": "01HXYZ5403ABCDEFGHJKMNPQRS",
    "entity_id": "01HXYZ5404ABCDEFGHJKMNPQRS",
    "status": "successful",
    "status_reason": "processing_complete",
    "narration": "Vendor payment",
    "type": "outflow",
    "payment_type": "bank-transfer",
    "applicable_fee": 75,
    "meta": {},
    "account": {
      "id": "01HXYZ5403ABCDEFGHJKMNPQRS",
      "display_name": "Operating GBP"
    },
    "created": 1760434049154,
    "updated": 1760434050159
  }
}

outflows.failed

Fired when a transfer cannot be completed. Check status_reason for the failure cause. The payload shape is identical to outflows.created. The status field will be failed.

Common status_reason values include insufficient_funds, invalid_account_details, and compliance_hold. Use status_reason to determine whether to retry the transfer or surface an error to your user.

{
  "event": "outflows.failed",
  "data": {
    "id": "01HXYZ5401ABCDEFGHJKMNPQRS",
    "amount": 10000,
    "currency": "USD",
    "unique_reference": "PAY-2025-002",
    "counterparty_id": "01HXYZ5402ABCDEFGHJKMNPQRS",
    "account_id": "01HXYZ5403ABCDEFGHJKMNPQRS",
    "entity_id": "01HXYZ5404ABCDEFGHJKMNPQRS",
    "status": "failed",
    "status_reason": "insufficient_funds",
    "narration": "Contractor payment",
    "type": "outflow",
    "payment_type": "bank-transfer",
    "applicable_fee": 150,
    "meta": {},
    "account": {
      "id": "01HXYZ5403ABCDEFGHJKMNPQRS",
      "display_name": "Operating USD"
    },
    "created": 1760434049154,
    "updated": 1760434050159
  }
}

outflows.cancelled

Fired when a transfer is cancelled before it is processed. The payload shape is identical to outflows.created. The status field will be failed and status_reason will be cancelled_by_user.

{
  "event": "outflows.cancelled",
  "data": {
    "id": "01HXYZ5401ABCDEFGHJKMNPQRS",
    "amount": 25000,
    "currency": "USD",
    "unique_reference": "PAY-2025-003",
    "counterparty_id": "01HXYZ5402ABCDEFGHJKMNPQRS",
    "account_id": "01HXYZ5403ABCDEFGHJKMNPQRS",
    "entity_id": "01HXYZ5404ABCDEFGHJKMNPQRS",
    "status": "failed",
    "status_reason": "cancelled_by_user",
    "narration": "Office supplies order",
    "type": "outflow",
    "payment_type": "bank-transfer",
    "applicable_fee": 250,
    "meta": {},
    "account": {
      "id": "01HXYZ5403ABCDEFGHJKMNPQRS",
      "display_name": "Operating USD"
    },
    "created": 1760434049154,
    "updated": 1760434050159
  }
}

outflows.refunded

Fired when a completed transfer is reversed or refunded back to the paying account. The event name is outflows.refunded, but the payload’s type field is inflow.

string

Unique identifier for this credit record.

number

Amount returned, in the smallest currency unit. 100 = $1.00 USD.

string

ISO 4217 currency code.

string

Unique reference for this record.

string

Synthetic counterparty ID for the card network, in the form acct-{account_id}-card-debit-reversal or acct-{account_id}-card-credit-refund.

string

The ID of the account credited.

string

The ID of the entity that owns the account.

string

successful once the credit is applied.

string

card_payment_reversed for a reversal, card_credit_refunded for a refund.

string

Description of the credit.

string

inflow.

string

card-debit-reversal when funds from a specific prior card debit are reversed, or card-credit-refund when the provider issues a refund without referencing a specific original transaction.

number

Fee applied to this credit, in the smallest currency unit.

object

Provider-specific metadata. Field set varies by payment_type.

Show meta fields

string

What triggered the credit, e.g. card_payment_reversal or card_credit_refund.

string

Present on reversals. The id of the original card-debit transaction being reversed.

boolean

Present on reversals. Whether the reversal covers part of the original amount.

string

Processor’s reference for the credit. null when not provided.

object

The account credited.

Show account fields

string

The account’s ID. Matches account_id.

string

Display name of the account.

object

Present for some account types. Additional account metadata, e.g. asset_type, network.

string

Present on reversals. The ID of the card the original debit was made on.

number

Unix timestamp in milliseconds.

number

Unix timestamp in milliseconds.

{
  "event": "outflows.refunded",
  "data": {
    "id": "01HK6PJQC42EJ5E6RHXQAQPDH4",
    "amount": 515,
    "currency": "USD",
    "unique_reference": "0001409402026081917044520-0000000006248994593-01HK7QM9S346Q3D25VT4F5V37E_reversal",
    "counterparty_id": "acct-01HK4MX9G8FGVSQE8Z5379AV4R-card-debit-reversal",
    "account_id": "01HK4MX9G8FGVSQE8Z5379AV4R",
    "entity_id": "01HN4V7SWKXPCGZDF3TMJBQ2AY",
    "status": "successful",
    "status_reason": "card_payment_reversed",
    "narration": "REVERSAL | 01HK7QM9S346Q3D25VT4F5V37E",
    "type": "inflow",
    "payment_type": "card-debit-reversal",
    "applicable_fee": 0,
    "meta": {
      "source": "card_payment_reversal",
      "source_payment_id": "01HK7QM9S346Q3D25VT4F5V37E",
      "provider_reference": null,
      "is_partial_refund": false
    },
    "created": 1787177096223,
    "updated": 1787177096223,
    "card_id": "01HXYZ9012ABCDEFGHJKMNPQRS"
  }
}

{
  "event": "outflows.refunded",
  "data": {
    "id": "01HK5N71HFE865V215DE1CTEWH",
    "amount": 1500,
    "currency": "USD",
    "unique_reference": "card-credit-refund_db5b5fab-8f4d-3e27-dda1-494c73cf256d",
    "counterparty_id": "acct-01HK4MX9G8FGVSQE8Z5379AV4R-card-credit-refund",
    "account_id": "01HK4MX9G8FGVSQE8Z5379AV4R",
    "entity_id": "01HN4V7SWKXPCGZDF3TMJBQ2AY",
    "status": "successful",
    "status_reason": "card_credit_refunded",
    "narration": "CREDIT REFUND | card-credit-refund_db5b5fab-8f4d-3e27-dda1-494c73cf256d",
    "type": "inflow",
    "payment_type": "card-credit-refund",
    "applicable_fee": 0,
    "meta": {
      "source": "card_credit_refund",
      "provider_reference": "db5b5fab-8f4d-3e27-dda1-494c73cf256d"
    },
    "account": {
      "id": "01HK4MX9G8FGVSQE8Z5379AV4R",
      "display_name": "Marketing UST",
      "meta": {
        "asset_type": "",
        "network": ""
      }
    },
    "created": 1787763168732,
    "updated": 1787763168732
  }
}

A refund (no source_payment_id) doesn’t reference a specific prior transaction; a reversal always does.

cards.created

Fired when a new card is issued via POST /disposable-cards or POST /virtual-cards.

string

Unique card identifier.

string

Display name assigned to the card.

string

Card type. One of disposable or virtual.

string

Card status. One of active, blocked, or fraud.

string

ISO 4217 currency code for the card.

string

The ID of the account the card is funded from.

string

Display name of the account the card is funded from.

string

Date the card was created, as YYYY-MM-DD.

{
  "event": "cards.created",
  "data": {
    "id": "01HXYZ9012ABCDEFGHJKMNPQRS",
    "name": "Marketing Team Card",
    "type": "virtual",
    "status": "active",
    "currency": "USD",
    "account_id": "01HQ7K3PXDCVNZFTMGBRY5WSJA",
    "nuvion_account_name": "Marketing USD",
    "created": "2026-01-15"
  }
}

cards.frozen

Fired when a card is frozen via Freeze a card. The payload shape is identical to cards.created. The status field will be blocked.

{
  "event": "cards.frozen",
  "data": {
    "id": "01HXYZ9012ABCDEFGHJKMNPQRS",
    "name": "Marketing Team Card",
    "type": "virtual",
    "status": "blocked",
    "currency": "USD",
    "account_id": "01HQ7K3PXDCVNZFTMGBRY5WSJA",
    "nuvion_account_name": "Marketing USD",
    "created": "2026-01-15"
  }
}

cards.unfrozen

Fired when a frozen card is restored to active status via Unfreeze a card. The payload shape is identical to cards.created. The status field will be active.

{
  "event": "cards.unfrozen",
  "data": {
    "id": "01HXYZ9012ABCDEFGHJKMNPQRS",
    "name": "Marketing Team Card",
    "type": "virtual",
    "status": "active",
    "currency": "USD",
    "account_id": "01HQ7K3PXDCVNZFTMGBRY5WSJA",
    "nuvion_account_name": "Marketing USD",
    "created": "2026-01-15"
  }
}

cards.deleted

Fired when a card is soft-deleted via Delete a card. The payload shape is identical to cards.created. The status field will be blocked.

{
  "event": "cards.deleted",
  "data": {
    "id": "01HXYZ9012ABCDEFGHJKMNPQRS",
    "name": "Marketing Team Card",
    "type": "virtual",
    "status": "blocked",
    "currency": "USD",
    "account_id": "01HQ7K3PXDCVNZFTMGBRY5WSJA",
    "nuvion_account_name": "Marketing USD",
    "created": "2026-01-15"
  }
}

What’s next

Webhooks overview

Delivery model, retries, idempotency, and signature verification.

Webhooks API reference

Create, update, and manage webhook endpoints, plus delivery logs and test events.

Get Started

Core Concepts

Webhooks

Guides

entities.created

entities.updated

accounts.created

account_details.created

account_details.updated

inflows.completed

funding_sessions.updated

Failure codes

payment_intent.completed

payment_intent.failed

payment_intent.cancelled

payment_refund.completed

payment_refund.failed

outflows.created

outflows.completed

outflows.failed

outflows.cancelled

outflows.refunded

cards.created

cards.frozen

cards.unfrozen

cards.deleted

What’s next

Webhooks overview

Webhooks API reference

​entities.created

​entities.updated

​accounts.created

​account_details.created

​account_details.updated

​inflows.completed

​funding_sessions.updated

​Failure codes

​payment_intent.completed

​payment_intent.failed

​payment_intent.cancelled

​payment_refund.completed

​payment_refund.failed

​outflows.created

​outflows.completed

​outflows.failed

​outflows.cancelled

​outflows.refunded

​cards.created

​cards.frozen

​cards.unfrozen

​cards.deleted

​What’s next

Webhooks overview

Webhooks API reference

entities.created

entities.updated

accounts.created

account_details.created

account_details.updated

inflows.completed

funding_sessions.updated

Failure codes

payment_intent.completed

payment_intent.failed

payment_intent.cancelled

payment_refund.completed

payment_refund.failed

outflows.created

outflows.completed

outflows.failed

outflows.cancelled

outflows.refunded

cards.created

cards.frozen

cards.unfrozen

cards.deleted

What’s next