Skip to main content

PaymentInstrument

The means of payment behind a payment method, such as a card or PayPal billing agreement. A payment method has one active payment instrument at a time.

type PaymentInstrument {
  active: Boolean!
  createdAt: ISO8601DateTime!
  description: String
  externalId: String
  externalReference: String
  id: GlobalID!
  manuallyCapturable: Boolean!
  metadata: Metadata
  paymentInstrumentType: PaymentInstrumentType!
  paymentMethod: PaymentMethod!
  paymentProcessor: PaymentProcessor!
  paymentSource: PaymentSource
  updatedAt: ISO8601DateTime
}

Fields

`PaymentInstrument.active` ● `Boolean!` non-null scalar types

Whether the payment instrument is its payment method's active instrument.

`PaymentInstrument.createdAt` ● `ISO8601DateTime!` non-null scalar types

The date and time when the payment instrument was created.

`PaymentInstrument.description` ● `String` scalar types

A summary of the payment instrument for display, e.g. Visa 4242, expires 12/25.

`PaymentInstrument.externalId` ● `String` scalar types

The payment instrument's external ID.

`PaymentInstrument.externalReference` ● `String` scalar types

A reference to the payment instrument in the payment processor, such as a Shopify order ID.

`PaymentInstrument.id` ● `GlobalID!` non-null scalar types

The payment instrument's ID.

`PaymentInstrument.manuallyCapturable` ● `Boolean!` non-null scalar types

Whether the payment instrument's payments are captured manually. Charges recorded against it stay pending until they are captured.

`PaymentInstrument.metadata` ● `Metadata` scalar types

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

`PaymentInstrument.paymentInstrumentType` ● `PaymentInstrumentType!` non-null enum types

The payment instrument's type.

`PaymentInstrument.paymentMethod` ● `PaymentMethod!` non-null object types

The payment method the payment instrument belongs to.

`PaymentInstrument.paymentProcessor` ● `PaymentProcessor!` non-null object types

The payment processor that processes the payment instrument's payments.

`PaymentInstrument.paymentSource` ● `PaymentSource` union types

The payment instrument's details, such as its card or PayPal billing agreement.

`PaymentInstrument.updatedAt` ● `ISO8601DateTime` scalar types

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

Member Of

PaymentMethod object

Fields
Member Of