PaymentPlanSession
Mutations
createPaymentPlanSessionAuthenticatedCreates a payment plan session used by the checkout process to create and authorize a payment plan.updatePaymentPlanSessionAuthenticatedUpdates a payment plan session used by the checkout process to create and authorize a payment plan.sendPaymentPlanSessionLinkAuthenticatedSends the payment plan session's link to the customer via the requested channel. The session must be Active. Fails when no recipient is available — either the contact lacks an email/phone for the chosen channel and no `to` override was provided.
Types
AmountA monetary amount with up to two decimal places. Ex. 111.11ContactContactIdvDocumentA 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.CreatePaymentPlanSessionInputCurrencyThree letter ISO 4217 currency code. Ex. USDDateISO 8601 formatted date in the format YYYY-MM-DDDateTimeISO 8601 formatted date time. Ex. 2023-11-23T14:30:00ZEmailAn email addressIdvFacialComparisonStatusHow 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.OperationSuccessOperational return type representing success or failure with a message.PaymentPlanFrequencyPaymentPlanSessionPaymentPlanSessionStatusPaymentSessionLinkChannelChannel used to deliver a session link to the merchant's customer.PhoneE.164 formatted phone number. Ex. +14155554345SendPaymentPlanSessionLinkInputUpdatePaymentPlanSessionInputURLA URL with protocol and port. ex. https://example.com