Preview

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

paymentMethodConsentStatus

Returns the consent status for the owner of a payment method. The consenter identity is resolved from the payment method record, not the caller. A blank locale value returns a bad request.

Terms for the requested locale follow the same strict locale contract as paymentMethodConsentTerms: cascade fallback to another locale yields NO_PUBLISHED_VERSION with null currentTerms.

This page contains

    Arguments

    paymentMethodId ID!

    UUID of the payment method whose owner's consent status is queried.

    locale String!

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

    Return Fields

    ConsentStatusResult! PREVIEW

    Status of a consenter's acceptance for a scope, plus the optional current terms. Mirrors com.appdirect.payment.consent.ConsentStatusResult.

    Interactive example

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

    Hint: use Ctrl + Space for autocompleting fields.