Skip to main content

SearchableEventFilterInput

Filter for events. Each field is an OpenSearch-style filter; combine fields with and / or / not.

input SearchableEventFilterInput {
  id: SearchableIDFilterInput
  objectId: SearchableIDFilterInput
  type: SearchableStringFilterInput
  createdAt: SearchableIntFilterInput
  checkoutId: SearchableIDFilterInput
  providerInternalId: SearchableStringFilterInput
  providerReferenceId: SearchableStringFilterInput
  amount: SearchableIntFilterInput
  authorizationCode: SearchableStringFilterInput
  currency: SearchableStringFilterInput
  description: SearchableStringFilterInput
  descriptor: SearchableStringFilterInput
  orderId: SearchableStringFilterInput
  storeId: SearchableStringFilterInput
  pointOfSaleId: SearchableStringFilterInput
  sequenceId: SearchableStringFilterInput
  subscriptionId: SearchableStringFilterInput
  refundedAmount: SearchableIntFilterInput
  status: SearchableStringFilterInput
  statusCode: SearchableStringFilterInput
  statusMessage: SearchableStringFilterInput
  customerEmail: SearchableStringFilterInput
  customerPhone: SearchableStringFilterInput
  customerName: SearchableStringFilterInput
  paymentMethodMethod: SearchableStringFilterInput
  paymentMethodCardBrand: SearchableStringFilterInput
  paymentMethodCardLast4: SearchableStringFilterInput
  paymentMethodCardType: SearchableStringFilterInput
  paymentMethodCardThreeDSecure: SearchableBooleanFilterInput
  paymentMethodCardThreeDSecureVersion: SearchableStringFilterInput
  paymentMethodCardTokenizationMethod: SearchableStringFilterInput
  paymentMethodCardFingerprint: SearchableStringFilterInput
  shopCountry: SearchableStringFilterInput
  shopName: SearchableStringFilterInput
  sessionIp: SearchableStringFilterInput
  sessionFingerprint: SearchableStringFilterInput
  sessionCountry: SearchableStringFilterInput
  fraudDetectorScore: SearchableIntFilterInput
  and: [SearchableEventFilterInput]
  or: [SearchableEventFilterInput]
  not: SearchableEventFilterInput
}

Fields​

SearchableEventFilterInput.id ● SearchableIDFilterInput input​

Filter by event id.

SearchableEventFilterInput.objectId ● SearchableIDFilterInput input​

Filter by underlying charge id.

SearchableEventFilterInput.type ● SearchableStringFilterInput input​

Filter by event type (e.g. payment.succeeded).

SearchableEventFilterInput.createdAt ● SearchableIntFilterInput input​

Filter by event creation unix timestamp (seconds). range = two values.

SearchableEventFilterInput.checkoutId ● SearchableIDFilterInput input​

Filter by checkout/operation id.

SearchableEventFilterInput.providerInternalId ● SearchableStringFilterInput input​

Filter by provider-side transaction id.

SearchableEventFilterInput.providerReferenceId ● SearchableStringFilterInput input​

Filter by provider-side reference id.

SearchableEventFilterInput.amount ● SearchableIntFilterInput input​

Filter by amount in the smallest currency unit. range = two values.

SearchableEventFilterInput.authorizationCode ● SearchableStringFilterInput input​

Filter by acquirer authorization code.

SearchableEventFilterInput.currency ● SearchableStringFilterInput input​

Filter by ISO 4217 currency code.

SearchableEventFilterInput.description ● SearchableStringFilterInput input​

Filter by description.

SearchableEventFilterInput.descriptor ● SearchableStringFilterInput input​

Filter by statement descriptor.

SearchableEventFilterInput.orderId ● SearchableStringFilterInput input​

Filter by merchant order id.

SearchableEventFilterInput.storeId ● SearchableStringFilterInput input​

Filter by store id.

SearchableEventFilterInput.pointOfSaleId ● SearchableStringFilterInput input​

Filter by Point of Sale id.

SearchableEventFilterInput.sequenceId ● SearchableStringFilterInput input​

Filter by recurring sequence id.

SearchableEventFilterInput.subscriptionId ● SearchableStringFilterInput input​

Filter by subscription id.

SearchableEventFilterInput.refundedAmount ● SearchableIntFilterInput input​

Filter by cumulative refunded amount. range = two values.

SearchableEventFilterInput.status ● SearchableStringFilterInput input​

Filter by ChargeStatus value.

SearchableEventFilterInput.statusCode ● SearchableStringFilterInput input​

Filter by status code.

SearchableEventFilterInput.statusMessage ● SearchableStringFilterInput input​

Filter by status message.

SearchableEventFilterInput.customerEmail ● SearchableStringFilterInput input​

Filter by customer email.

SearchableEventFilterInput.customerPhone ● SearchableStringFilterInput input​

Filter by customer phone.

SearchableEventFilterInput.customerName ● SearchableStringFilterInput input​

Filter by customer name.

SearchableEventFilterInput.paymentMethodMethod ● SearchableStringFilterInput input​

Filter by PaymentMethods value.

SearchableEventFilterInput.paymentMethodCardBrand ● SearchableStringFilterInput input​

Filter by card brand.

SearchableEventFilterInput.paymentMethodCardLast4 ● SearchableStringFilterInput input​

Filter by card last 4 digits.

SearchableEventFilterInput.paymentMethodCardType ● SearchableStringFilterInput input​

Filter by card funding type (debit/credit).

SearchableEventFilterInput.paymentMethodCardThreeDSecure ● SearchableBooleanFilterInput input​

Filter by whether 3DS authentication ran.

SearchableEventFilterInput.paymentMethodCardThreeDSecureVersion ● SearchableStringFilterInput input​

Filter by 3DS protocol version (e.g. 2.2.0).

SearchableEventFilterInput.paymentMethodCardTokenizationMethod ● SearchableStringFilterInput input​

Filter by network token wallet.

SearchableEventFilterInput.paymentMethodCardFingerprint ● SearchableStringFilterInput input​

Filter by card fingerprint. On the events query this matches online card events only; to include in-person/card-present charges, use the charges query.

SearchableEventFilterInput.shopCountry ● SearchableStringFilterInput input​

Filter by shop country (ISO 3166-1 alpha-2).

SearchableEventFilterInput.shopName ● SearchableStringFilterInput input​

Filter by shop name.

SearchableEventFilterInput.sessionIp ● SearchableStringFilterInput input​

Filter by checkout session IP.

SearchableEventFilterInput.sessionFingerprint ● SearchableStringFilterInput input​

Filter by checkout session device fingerprint.

SearchableEventFilterInput.sessionCountry ● SearchableStringFilterInput input​

Filter by checkout session country (geolocated from IP, ISO 3166-1 alpha-2).

SearchableEventFilterInput.fraudDetectorScore ● SearchableIntFilterInput input​

Filter by fraud detector score (0-1000). range = two values.

SearchableEventFilterInput.and ● [SearchableEventFilterInput] list input​

AND combinator.

SearchableEventFilterInput.or ● [SearchableEventFilterInput] list input​

OR combinator.

SearchableEventFilterInput.not ● SearchableEventFilterInput input​

NOT combinator.

Member Of​

events query ● SearchableEventFilterInput input