Skip to main content

ChargeEventObject

Charge snapshot embedded in a ChargeEvent. Captures the charge as it looked at the moment the event was emitted.

type ChargeEventObject {
  id: ID!
  accountId: ID!
  providerId: ID
  checkoutId: ID!
  providerInternalId: ID
  providerReferenceId: ID
  createdAt: AWSTimestamp
  updatedAt: AWSTimestamp
  amount: Int
  amountEUR: Int
  authorizationCode: String
  billingDetails: ContactDetails
  billingPlan: BillingPlans
  currency: String!
  customer: Customer
  description: String
  descriptor: String
  livemode: Boolean
  orderId: ID
  storeId: ID
  pointOfSaleId: ID
  sequenceId: ID
  subscriptionId: ID
  paymentMethod: PaymentMethod
  cancellationReason: CancellationReason
  lastRefundAmount: Int
  lastRefundReason: RefundReason
  refundedAmount: Int
  shippingDetails: ContactDetails
  shop: Shop
  status: ChargeStatus!
  statusCode: String
  statusMessage: String
  sessionDetails: SessionDetails
  traceDetails: TraceDetails
  pageOpenedAt: AWSTimestamp
  fraudDetectorScore: Int
  metadata: [KeyValueItem!]
}

Fields

`ChargeEventObject.id` ● `ID!` non-null scalar

Unique identifier for the payment.

`ChargeEventObject.accountId` ● `ID!` non-null scalar

Merchant account that owns the charge.

`ChargeEventObject.providerId` ● `ID` scalar

Configured payment provider.

`ChargeEventObject.checkoutId` ● `ID!` non-null scalar

Underlying checkout/operation.

`ChargeEventObject.providerInternalId` ● `ID` scalar

Provider-side transaction identifier.

`ChargeEventObject.providerReferenceId` ● `ID` scalar

Provider-side reference.

`ChargeEventObject.createdAt` ● `AWSTimestamp` scalar

Creation time as a unix timestamp (seconds).

`ChargeEventObject.updatedAt` ● `AWSTimestamp` scalar

Last update time as a unix timestamp (seconds).

`ChargeEventObject.amount` ● `Int` scalar

Amount intended to be collected by this payment. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge 1.00 USD).

`ChargeEventObject.amountEUR` ● `Int` scalar

Amount converted to EUR, in cents.

`ChargeEventObject.authorizationCode` ● `String` scalar

Unique identifier provided by the bank performing transaction.

`ChargeEventObject.billingDetails` ● `ContactDetails` object

Billing information associated with the payment method at the time of the transaction.

`ChargeEventObject.billingPlan` ● `BillingPlans` enum

Merchant billing plan.

`ChargeEventObject.currency` ● `String!` non-null scalar

Three-letter ISO 4217 currency code, in uppercase. Must be a supported currency.

`ChargeEventObject.customer` ● `Customer` object

Customer identification.

`ChargeEventObject.description` ● `String` scalar

An arbitrary string attached to the payment. Often useful for displaying to users.

`ChargeEventObject.descriptor` ● `String` scalar

Statement descriptor.

`ChargeEventObject.livemode` ● `Boolean` scalar

true for live transactions, false for test mode.

`ChargeEventObject.orderId` ● `ID` scalar

An order ID from your system. A unique identifier that can be used to reconcile the payment with your internal system.

`ChargeEventObject.storeId` ● `ID` scalar

A unique identifier of the Store. If specified the payment is attached to this Store.

`ChargeEventObject.pointOfSaleId` ● `ID` scalar

A unique identifier of the Point of Sale. If specified the payment is attached to this Point of Sale.

`ChargeEventObject.sequenceId` ● `ID` scalar

A permanent identifier that refers to the initial payment of a sequence of payments.

`ChargeEventObject.subscriptionId` ● `ID` scalar

A unique identifier of the Subscription. If specified the payment is attached to this Subscription.

`ChargeEventObject.paymentMethod` ● `PaymentMethod` object

Details about the payment method at the time of the transaction.

`ChargeEventObject.cancellationReason` ● `CancellationReason` enum

The reason for canceling the Payment.

`ChargeEventObject.lastRefundAmount` ● `Int` scalar

Amount in cents refunded in the last transaction.

`ChargeEventObject.lastRefundReason` ● `RefundReason` enum

The reason of the last refund transaction.

`ChargeEventObject.refundedAmount` ● `Int` scalar

Amount in cents refunded (can be less than the amount attribute on the payment if a partial refund was issued).

`ChargeEventObject.shippingDetails` ● `ContactDetails` object

Shipping information associated with the payment.

`ChargeEventObject.shop` ● `Shop` object

The information about the shop (used in hosted payment page).

`ChargeEventObject.status` ● `ChargeStatus!` non-null enum

Charge status at the moment the event was emitted.

`ChargeEventObject.statusCode` ● `String` scalar

Payment status code at the moment the event was emitted.

`ChargeEventObject.statusMessage` ● `String` scalar

Human readable status message, can be displayed to a user.

`ChargeEventObject.sessionDetails` ● `SessionDetails` object

Information related to the browsing session of the user who initiated the payment.

`ChargeEventObject.traceDetails` ● `TraceDetails` object

Origin metadata for the action that produced this event.

`ChargeEventObject.pageOpenedAt` ● `AWSTimestamp` scalar

When the customer first opened the hosted payment page, as a unix timestamp (seconds).

`ChargeEventObject.fraudDetectorScore` ● `Int` scalar

Fraud detector score, 0-1000.

`ChargeEventObject.metadata` ● `[KeyValueItem!]` list object

Merchant-defined metadata.

Member Of

ChargeEvent object

Fields
Member Of