Event types

The catalog below covers card, transaction, and expense-report events. Expand an event to inspect its standard-envelope field types and an example payload.

Card events

card_creation.event

Emitted when a new card is created.

Payload fields

string

required

Always card_creation.event.

string

required

The per-endpoint notification id. It remains stable across delivery retries; deduplicate deliveries by this value.

string

required

The id of the entity that triggered the event.

string<date-time>

required

When the event occurred.

Example payload

{
  "event": "card_creation.event",
  "eventId": "<string>",
  "entityId": "c_example",
  "eventTimestamp": "2023-11-07T05:31:56Z"
}

card.delete

Emitted when a card is closed.

Payload fields

string

required

Always card.delete.

string

required

The per-endpoint notification id. It remains stable across delivery retries; deduplicate deliveries by this value.

string

required

The id of the entity that triggered the event.

string<date-time>

required

When the event occurred.

Example payload

{
  "event": "card.delete",
  "eventId": "<string>",
  "entityId": "c_example",
  "eventTimestamp": "2023-11-07T05:31:56Z"
}

card.update

Emitted when a card is activated, paused, or unpaused. A new card can emit this immediately after its creation event.

Payload fields

string

required

Always card.update.

string

required

The per-endpoint notification id. It remains stable across delivery retries; deduplicate deliveries by this value.

string

required

The id of the entity that triggered the event.

string<date-time>

required

When the event occurred.

Example payload

{
  "event": "card.update",
  "eventId": "<string>",
  "entityId": "c_example",
  "eventTimestamp": "2023-11-07T05:31:56Z"
}

three_ds_challenge.requested

Emitted when a card purchase asks the cardholder to confirm it with 3D Secure, for legal entities that decide their own 3D Secure challenges. Approve or decline it before `expiresAt` (about five minutes); a challenge left unanswered is declined.

Payload fields

string

required

Always three_ds_challenge.requested.

string

required

The per-endpoint notification id. It remains stable across delivery retries; deduplicate deliveries by this value.

string

required

The id of the entity that triggered the event.

string<date-time>

required

When the event occurred.

string

required

The card the purchase was made with, with the c_ prefix.

object

required

The merchant the cardholder is paying: description is its name and location.country its three-letter ISO 3166-1 alpha-3 country code, such as USA or GBR.

Show properties

string

required

object

required

Show properties

string

required

object

required

The purchase amount: amount in the minor units of currency (cents for USD) and currency as an uppercase ISO 4217 code.

Show properties

integer

required

string

required

string<date-time>

required

The deadline to approve or decline the challenge, about five minutes after it was requested. A challenge left unanswered is declined.

Example payload

{
  "event": "three_ds_challenge.requested",
  "eventId": "<string>",
  "entityId": "three_ds_challenge_example",
  "eventTimestamp": "2023-11-07T05:31:56Z",
  "cardId": "c_example",
  "merchant": {
    "description": "Acme Tickets",
    "location": {
      "country": "USA"
    }
  },
  "amount": {
    "amount": 1999,
    "currency": "USD"
  },
  "expiresAt": "2023-11-07T05:36:56Z"
}

Transaction events

aggregated_transaction.create

Emitted when a Transaction first appears in the transaction feed.

Payload fields

string

required

Always aggregated_transaction.create.

string

required

The per-endpoint notification id. It remains stable across delivery retries; deduplicate deliveries by this value.

string

required

The id of the entity that triggered the event.

string<date-time>

required

When the event occurred.

Example payload

{
  "event": "aggregated_transaction.create",
  "eventId": "<string>",
  "entityId": "agg_tx_example",
  "eventTimestamp": "2023-11-07T05:31:56Z"
}

aggregated_transaction.update

Emitted when an existing Transaction changes status or displayed details. The same Transaction can emit this event more than once.

Payload fields

string

required

Always aggregated_transaction.update.

string

required

The per-endpoint notification id. It remains stable across delivery retries; deduplicate deliveries by this value.

string

required

The id of the entity that triggered the event.

string<date-time>

required

When the event occurred.

Example payload

{
  "event": "aggregated_transaction.update",
  "eventId": "<string>",
  "entityId": "agg_tx_example",
  "eventTimestamp": "2023-11-07T05:31:56Z"
}

Expense report events

expense_report.create

Emitted when a new expense report is created.

Payload fields

string

required

Always expense_report.create.

string

required

The per-endpoint notification id. It remains stable across delivery retries; deduplicate deliveries by this value.

string

required

The id of the entity that triggered the event.

string<date-time>

required

When the event occurred.

Example payload

{
  "event": "expense_report.create",
  "eventId": "<string>",
  "entityId": "expense_report_example",
  "eventTimestamp": "2023-11-07T05:31:56Z"
}

expense_report.update

Emitted when an existing expense report changes, including updates to its status or editable report details.

Payload fields

string

required

Always expense_report.update.

string

required

The per-endpoint notification id. It remains stable across delivery retries; deduplicate deliveries by this value.

string

required

The id of the entity that triggered the event.

string<date-time>

required

When the event occurred.

Example payload

{
  "event": "expense_report.update",
  "eventId": "<string>",
  "entityId": "expense_report_example",
  "eventTimestamp": "2023-11-07T05:31:56Z"
}

Get started

Working with the API

Core objects

Money movement

Cards

Cashback

Bill pay

Invoicing

Accounting

Card events

Transaction events

Expense report events

​Card events

​Transaction events

​Expense report events

Card events

Transaction events

Expense report events