PaymentIntent

A payment intent.

type PaymentIntent {
  id: GlobalID!
  adjustments: [PaymentIntentAdjustment!]
  amount: Money
  amountPaid: Money
  amountRefunded: Money
  balanceOwing: Money
  charges(id: GlobalID): [Charge!]
  createdAt: ISO8601DateTime!
  customer: Customer!
  exchangeRate: Float
  finalisedAt: ISO8601DateTime
  flexible: Boolean
  metadata: Metadata
  paymentMethod: PaymentMethod!
  refunds: [Refund!]
  settlementAmount: Money
  status: PaymentIntentStatus
  updatedAt: ISO8601DateTime
}

Fields

PaymentIntent.id ● GlobalID! non-null scalar types

The payment intent's ID.

PaymentIntent.adjustments ● [PaymentIntentAdjustment!] list object types

The adjustments made to the payment intent's amount.

PaymentIntent.amount ● Money object types

The payment intent's amount, including any adjustments.

PaymentIntent.amountPaid ● Money object types

The total of the payment intent's successful capture and sale charges, less successful refunds.

PaymentIntent.amountRefunded ● Money object types

The total of the payment intent's successful refunds.

PaymentIntent.balanceOwing ● Money object types

The amount still to be paid on the payment intent. Always zero once the payment intent is cancelled.

PaymentIntent.charges ● [Charge!] list object types

The charges made against the payment intent.

PaymentIntent.charges.id ● GlobalID scalar types

The ID of a charge to return. Omit it to return all the payment intent's charges.

PaymentIntent.createdAt ● ISO8601DateTime! non-null scalar types

The date and time when the payment intent was created.

PaymentIntent.customer ● Customer! non-null object types

The customer the payment intent belongs to.

PaymentIntent.exchangeRate ● Float scalar types

The exchange rate from the settlement currency to the payment intent's currency. Set when the payment intent is finalised with a settlement amount.

PaymentIntent.finalisedAt ● ISO8601DateTime scalar types

The date and time when the payment intent was finalised.

PaymentIntent.flexible ● Boolean scalar types

Whether the payment intent's amount can be increased after it has succeeded or been cancelled.

PaymentIntent.metadata ● Metadata scalar types

Key/value pairs for storing extra information about the payment intent.

PaymentIntent.paymentMethod ● PaymentMethod! non-null object types

The payment method used to pay the payment intent.

PaymentIntent.refunds ● [Refund!] list object types

The refunds made against the payment intent.

PaymentIntent.settlementAmount ● Money object types

The payment intent's amount in the settlement currency, when known.

PaymentIntent.status ● PaymentIntentStatus enum types

The payment intent's status.

PaymentIntent.updatedAt ● ISO8601DateTime scalar types

The date and time when the payment intent was last updated.

Returned By

paymentIntent query

Member Of

CampaignOrder object ● CampaignOrderGroup object ● Charge object ● PaymentIntentAdjustment object ● PaymentIntentConnection object ● PaymentIntentEdge object ● Refund object ● SubscriptionEvent object ● SubscriptionOrder object