PaymentMethod · ClientLoop Docs

type PaymentMethod

A payment instrument stored against a contact so it can be charged again without the customer re-entering it.

A payment method is created by completing a payment session whose storePaymentMethod was not Disabled, and charged afterwards with chargePaymentMethod. Payment options that are unsuitable for storing are not offered during such a session — consumer financing such as FlexPay, for example, applies to a single purchase and cannot act as a method on file.

Field	Type	Description
`id`	`ID!`	Globally unique id of the payment method, a KSUID behind the `pmd` category prefix. Treat it as opaque: the prefix exists so the server can route the id to this type, and its format is not part of the contract. Refetchable through the Relay `node(id:)` query as well as `paymentMethod(id:)`.
`orgId`	`ID!`	Organization that owns this payment method.
`contactId`	`ID!`	ID of the contact this payment method is stored against.
`contact`	`Contact`	Contact this payment method is stored against.
`type`	`PaymentMethodType!`	Whether this method is a card or a bank account. Determines which of `card` and `bankAccount` is populated.
`status`	`PaymentMethodStatus!`	Whether the method can still be charged.
`provider`	`PaymentProvider!`	Payment provider holding the underlying credential.
`configurationId`	`ID`	ID of the provider configuration the credential is stored under. Charges against this method run through the same configuration.
`card`	`PaymentMethodCard`	Card detail. Populated when type is Card, otherwise null.
`bankAccount`	`PaymentMethodBankAccount`	Bank account detail. Populated when type is BankAccount, otherwise null.
`supportedRecurringProcessingModels`	`[RecurringProcessingModel!]!`	The ways this method may be used for a later payment. A method is stored under the model declared on its payment session, and the provider reports which models the resulting credential supports. Read it before offering a customer a subscription against a method that may not carry one.
`billingAddress`	`GlobalAddress`	Billing address captured alongside the instrument.
`paymentSessionId`	`ID`	ID of the payment session that stored this payment method.
`deletedAt`	`DateTime`	Set when the payment method has been deleted; null while it is usable. A deleted method is excluded from `Contact.paymentMethods` unless `includeDeleted` is set, and can no longer be charged.
`createdAt`	`DateTime!`	Date the payment method was stored.
`updatedAt`	`DateTime!`	Date the payment method was last updated.

type PaymentMethod

Used by

Queries

Mutations