Payment

View normalized Markdown

Payment data available to a scoped Management API integration.

graphql
type Payment {
  createdAt: DateTime!
  currency: String
  discardedAt: DateTime
  effectiveValueCents: BigInt
  id: ID!
  invoiceId: ID
  name: String
  number: String
  paymentMethod: String
  refunds: [Refund!]!
  state: String
  stateLastChangedAt: DateTime
  tombstone: Boolean!
  updatedAt: DateTime!
  valueCents: BigInt
}

Fields

Payment.createdAt · DateTime! non-null scalar

Record creation timestamp.

Payment.currency · String scalar

Currency.

Payment.discardedAt · DateTime scalar

When the record was discarded; null for an active record.

Payment.effectiveValueCents · BigInt scalar

Effective value cents.

Payment.id · ID! non-null scalar

Stable record identifier.

Payment.invoiceId · ID scalar

Invoice id.

Payment.name · String scalar

Display name when the resource provides one.

Payment.number · String scalar

External-facing record number when the resource provides one.

Payment.paymentMethod · String scalar

Payment method.

Payment.refunds · [Refund!]! non-null object

Recorded refunds and pending confirmation state.

Payment.state · String scalar

State.

Payment.stateLastChangedAt · DateTime scalar

State last changed at.

Payment.tombstone · Boolean! non-null scalar

True when the discarded record represents a removal to propagate locally.

Payment.updatedAt · DateTime! non-null scalar

Timestamp used for incremental synchronization and cursor ordering.

Payment.valueCents · BigInt scalar

Value cents.

Returned By

payment query

Member Of

PaymentCollection object

Ready to Get Started?

Book a free demo or reach out — we’d love to hear from you.