Preview

paymentMethodConsentTerms is in Preview status and is subject to change without notice. For more information about Preview status, see the GraphQL API policy.

paymentMethodConsentTerms

Returns the currently-published consent terms for the caller-requested locale. A blank locale value returns a bad request.

When AppTerms has no document for that locale, or would serve a different locale via cascade fallback (X-Locale-Resolved differs from the request), the query fails with not-found — substitute-locale content is never returned.

Any authenticated user in the tenant may call this query; it does not require ownership of a payment method because it returns marketplace-wide published terms, not a specific consenter's acceptance state.

This page contains

    Arguments

    locale String!

    Required IETF BCP 47 language tag (underscores normalized to hyphens). Invalid or blank values return a bad request.

    Return Fields

    ConsentTerms! PREVIEW

    Currently-published consent terms for a scope in the caller-requested locale only. The locale field echoes the GraphQL argument; markdown is never returned for a substitute locale when AppTerms would cascade. Mirrors com.appdirect.payment.consent.ConsentTerms.

    Interactive example

    This is an example query. Use the embedded interactive tool below to edit the query.

    Hint: use Ctrl + Space for autocompleting fields.