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 @deprecated
  paymentProcessorId: ID
  checkoutId: ID!
  providerInternalId: ID @deprecated
  providerReferenceId: ID
  createdAt: AWSTimestamp
  updatedAt: AWSTimestamp
  amount: Int
  amountEUR: Int
  authorizationCode: String
  billingDetails: ContactDetails
  billingPlan: BillingPlans
  currency: String!
  customerId: ID
  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
  routingSignals: RoutingSignals
  metadata: [KeyValueItem!]
  installmentsData: InstallmentsData
  chargeback: Boolean
}

Fields

ChargeEventObject.id ● ID! non-null scalar

Unique identifier for the payment (Payment ID in the dashboard).

ChargeEventObject.accountId ● ID! non-null scalar

Merchant account that owns the charge.

ChargeEventObject.providerId ● ID deprecated scalar

DEPRECATED

Use paymentProcessorId instead

Always null.

ChargeEventObject.paymentProcessorId ● ID scalar

Payment processor that processed the charge (Payment processor in the dashboard): monei:<paymentMethod> for MONEI, for example monei:card, or the ID of a processor the merchant holds a contract with. null when no processor took the charge. Pass it to the paymentProcessor query to read the processor.

ChargeEventObject.checkoutId ● ID! non-null scalar

ID of the checkout that created the charge.

ChargeEventObject.providerInternalId ● ID deprecated scalar

DEPRECATED

Use providerReferenceId instead

Always null.

ChargeEventObject.providerReferenceId ● ID scalar

Reference of the payment at the processor (Provider reference ID in the dashboard).

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

Authorization code returned by the bank that authorized the payment (Authorization code in the dashboard).

ChargeEventObject.billingDetails ● ContactDetails object

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

ChargeEventObject.billingPlan ● BillingPlans enum

Commercial billing plan of the merchant at the time of the charge.

ChargeEventObject.currency ● String! non-null scalar

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

ChargeEventObject.customerId ● ID scalar

Customer entity the payment is linked to.

ChargeEventObject.customer ● Customer object

Customer identification (email, name, phone).

ChargeEventObject.description ● String scalar

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

ChargeEventObject.descriptor ● String scalar

Statement descriptor shown on the cardholder's bank statement (max 25 chars).

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

ID of the first payment of a recurring sequence. The later payments of the sequence carry the same value.

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 refunded by the last refund, in the smallest currency unit.

ChargeEventObject.lastRefundReason ● RefundReason enum

The reason of the last refund transaction.

ChargeEventObject.refundedAmount ● Int scalar

Total amount refunded so far, in the smallest currency unit. Less than amount after a partial refund.

ChargeEventObject.shippingDetails ● ContactDetails object

Shipping information associated with the payment.

ChargeEventObject.shop ● Shop object

The shop shown to the customer on the hosted payment page: the name and country of the store of the payment, else of the business of the account.

ChargeEventObject.status ● ChargeStatus! non-null enum

Charge status at the moment the event was emitted.

ChargeEventObject.statusCode ● String scalar

MONEI status code of the payment at the moment the event was emitted. The code groups are listed on Charge.statusCode.

ChargeEventObject.statusMessage ● String scalar

Human readable status message, can be displayed to a user: the English text of statusCode. For a processor the merchant holds a contract with, the text that processor returned.

ChargeEventObject.sessionDetails ● SessionDetails object

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

ChargeEventObject.traceDetails ● TraceDetails object

The request behind the action that produced this event: IP address, browser, the dashboard user or the masked API key, and the integration source.

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 (low risk) to 1000 (high risk).

ChargeEventObject.routingSignals ● RoutingSignals object

Payment routing rule signals applied at confirm time.

ChargeEventObject.metadata ● [KeyValueItem!] list object

Merchant-defined metadata.

ChargeEventObject.installmentsData ● InstallmentsData object

Installments financing details when the payment was paid in installments.

ChargeEventObject.chargeback ● Boolean scalar

The payment has been disputed by the cardholder. true or null, never false: null on payments that were never disputed. To find disputed payments filter on eq: true; to find the others filter on ne: true, because eq: false finds none. Once set it is not cleared: winning a dispute leaves the flag in place. A disputed payment cannot be refunded.

Member Of

ChargeEvent object