Saltar al contenido principal

ChargeEvent

One event in the life of a charge: a status change, a refund, a dispute or an update. The Payment events page of the dashboard lists them.

type ChargeEvent {
id: ID!
type: String!
accountId: ID!
livemode: Boolean
objectId: ID!
objectType: String!
object: ChargeEventObject!
createdAt: AWSTimestamp
}

Fields​

ChargeEvent.id ● ID! non-null scalar​

Event identifier.

ChargeEvent.type ● String! non-null scalar​

Event type. One of charge.pending (Payment started), charge.pending_processing, charge.authorized, charge.succeeded, charge.captured, charge.failed, charge.canceled, charge.expired, charge.refunded, charge.partially_refunded, charge.paid_out, charge.chargeback (the payment was disputed) and charge.updated (details changed, status kept). charge.captured marks the capture of an authorized payment, charge.succeeded a payment captured at once.

ChargeEvent.accountId ● ID! non-null scalar​

Merchant account that owns the event.

ChargeEvent.livemode ● Boolean scalar​

true if the event came from a live charge, false for test mode.

ChargeEvent.objectId ● ID! non-null scalar​

Identifier of the related object. Currently always a charge id.

ChargeEvent.objectType ● String! non-null scalar​

Type of the related object. Currently always charge.

ChargeEvent.object ● ChargeEventObject! non-null object​

Snapshot of the charge at the time the event was emitted.

ChargeEvent.createdAt ● AWSTimestamp scalar​

Event time as a unix timestamp (seconds).

Member Of​

ChargeEventsConnection object