Skip to main content

SettlementEvent

Lifecycle event for a settlement (status transition or balance update).

type SettlementEvent {
  id: ID!
  type: String!
  accountId: ID!
  objectId: ID!
  objectType: String!
  object: SettlementEventObject!
  createdAt: AWSTimestamp!
}

Fields​

SettlementEvent.id ● ID! non-null scalar​

Event ID.

SettlementEvent.type ● String! non-null scalar​

Event type. One of settlement.pending, settlement.completed, settlement.suspended.

SettlementEvent.accountId ● ID! non-null scalar​

Account ID the settlement belongs to.

SettlementEvent.objectId ● ID! non-null scalar​

ID of the settlement the event refers to (matches object.id).

SettlementEvent.objectType ● String! non-null scalar​

Object type. Always settlement.

SettlementEvent.object ● SettlementEventObject! non-null object​

Settlement state captured when the event was emitted.

SettlementEvent.createdAt ● AWSTimestamp! non-null scalar​

Event timestamp (seconds).

Member Of​

SettlementEventsConnection object