Payment
Queries
paymentAuthenticatedFetches a single payment by its id. Returns null when no payment matches.paymentsAuthenticatedLists payments as a Relay-style, cursor-paginated connection. Page forward by starting with first: N, then passing the previous response's pageInfo.endCursor back as after (repeat while pageInfo.hasNextPage); page backward with last + before. Scope the results with one of orgId / agencyId / configurationId and/or a start/end date range via PaymentsInput. See PaymentConnection for the response shape. Results are ordered newest first.
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.CurrencyThree letter ISO 4217 currency code. Ex. USDDateTimeISO 8601 formatted date time. Ex. 2023-11-23T14:30:00ZEmailAn email addressGlobalAddressAddress 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.PaymentPaymentConnectionA page of payments following the [Relay Connection spec](https://relay.dev/graphql/connections.htm). edges holds the payments in this page (each with its cursor) and pageInfo describes whether more pages exist in each direction plus the cursors that bound this page. Typical "load more" loop: read edges[].node for the data, then if pageInfo.hasNextPage is true request the next page with payments(input: { first: N, after: pageInfo.endCursor, ...same filters }).PaymentEdgeA single element of a PaymentConnection page: the payment 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.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.PaymentSessionInvoiceLineItemRefMerchant provided invoice line item information for use during a payment session.PaymentSessionInvoiceRefMerchant provided invoice information for use during a payment session.PaymentSessionStatusPaymentsInputFilter and pagination for the payments 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. Scope the list by supplying at most one of orgId, agencyId, or configurationId (omit all three to list every payment), and optionally a start/end payment-date range. Results are ordered newest first.PaymentSourceThe 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. +14155554345URLA URL with protocol and port. ex. https://example.com