PaymentMethod
Queries
Mutations
deletePaymentMethodAuthenticatedDeletes a stored payment method and releases the credential held at the provider. The method is retained in a deleted state so past payments made from it stay attributable, but it can no longer be charged and no longer appears in `Contact.paymentMethods` by default. Deleting an already-deleted method succeeds and returns it unchanged.chargePaymentMethodAuthenticatedCharges a stored payment method. A refusal by the provider is reported in the result rather than raised as an error, so check success before reading payment. The method must be Active — charging an Expired, Invalid or deleted method fails. Supply an idempotencyKey so a retried request does not charge the customer twice.
Types
AmountA monetary amount with up to two decimal places. Ex. 111.11ChargePaymentMethodInputDetails of a payment to run against a stored payment method. The currency must match the currency the method was stored under.ChargePaymentMethodResultOutcome of charging a stored payment method. A refusal is a normal result rather than an error: success is false, message carries the provider's reason, and payment is null.ContactContactIdvDocumentA captured identity document from a contact's Plaid documentary verification.ContactIdvDocumentImageA single captured image belonging to a ContactIdvDocument. Plaid-hosted and expiring.ContactIdvSessionDetailDetails of a contact's Plaid identity-verification session, fetched on demand from Plaid. The public graph exposes the timestamps, the captured selfie video, the captured identity documents, and the individual check outcomes; the remaining fields — including the raw Plaid pass-throughs they are derived from — are private-graph only.ContactIdvSessionStatusWhere a contact's verification stands. Mirrors the shared IdvSessionStatus but is declared separately so the contact graph's public surface does not depend on a type owned by the application module.CurrencyThree letter ISO 4217 currency code. Ex. USDDateTimeISO 8601 formatted date time. Ex. 2023-11-23T14:30:00ZDeletePaymentMethodInputEmailAn email addressGlobalAddressAddress of a physical locationGlobalAddressInputAddress of a physical locationIdvFacialComparisonStatusHow the captured selfie compared against the face on the captured identity document. NoInput means one of the two was never captured.IdvLivenessStatusWhether the captured selfie passed liveness detection — that a live person was present rather than a photograph or a screen.IdvMatchSummaryHow one value that the contact supplied compared against the data sources that Plaid checked it against. NoData means Plaid held nothing to compare with; NoInput means the contact supplied nothing to compare.PageInfoPageInfo type for cursor-based pagination following the Relay specification for cursor based pagination.PaymentPaymentMethodA 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.PaymentMethodBankAccountBank account detail for a stored payment method whose type is BankAccount.PaymentMethodBankAccountTypeThe kind of bank account a stored payment method debits.PaymentMethodCardCard detail for a stored payment method whose type is Card.PaymentMethodCardFundingHow a stored card funds a payment, when the provider reports it.PaymentMethodConnectionA page of payment methods following the [Relay Connection spec](https://relay.dev/graphql/connections.htm). edges holds the payment methods in this page (each with its cursor) and pageInfo describes whether more pages exist in each direction plus the cursors that bound this page.PaymentMethodEdgeA single element of a PaymentMethodConnection page: the payment method itself (node) plus the opaque cursor that points at it. Pass a cursor back as `after` (forward) or `before` (backward) to page relative to this row.PaymentMethodsInputFilter and pagination for a payment methods connection. Pagination is Relay cursor-based, not page/offset based — see the [Relay Connections spec](https://relay.dev/graphql/connections.htm). Page forward with first + after, or backward with last + before; never mix the two directions in a single call. Cursors are opaque strings taken from a previous response's pageInfo (or edges[].cursor) — treat them as black boxes, don't build or parse them yourself.PaymentMethodStatusWhether a stored payment method can still be charged.PaymentMethodTypeThe kind of instrument a stored payment method holds.PaymentProviderPaymentSessionRepresents a payment session a customer can use to make a payment. This session is used to configuration and setup the payment experience for an individual customer's session during checkout.PaymentSessionContactRefMerchant provide contact information for use during a payment session.PaymentSessionContactRefInputMerchant provide contact information to use when creating a payment session.PaymentSessionInvoiceLineItemRefMerchant provided invoice line item information for use during a payment session.PaymentSessionInvoiceLineItemRefInputMerchant provided invoice line item detail used to create a payment session.PaymentSessionInvoiceRefMerchant provided invoice information for use during a payment session.PaymentSessionInvoiceRefInputMerchant provided invoice detail used to create a payment session.PaymentSessionStatusPaymentSourceThe source of the payment. This is used to identify the integration and specific connection that facilitated the payment within the integration.PaymentStatusPhoneE.164 formatted phone number. Ex. +14155554345RecurringProcessingModelHow a stored payment method may be used for a later payment, following the card networks' stored-credential framework. The model is declared when a method is stored and again on every payment made from it, and it decides how that later payment is treated for Strong Customer Authentication: a Subscription or UnscheduledCardOnFile charge is one you initiate and falls outside SCA, while a CardOnFile charge does not. What separates the two models you initiate is the schedule, not the amount. A run of payments on a fixed interval is a Subscription even when the amount differs every time.StorePaymentMethodModeWhether a payment session stores the payment method the customer enters against its contact, and whether the customer gets a say in it.StorePaymentMethodResultWhat became of a payment session's request to store the payment method, once the session completed.URLA URL with protocol and port. ex. https://example.com