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


This page contains


    id: ID!

    Payment method identifier

    paymentMethodType: String!

    Payment method type, e.g. CARD, BANK_ACCOUNT

    accountDisplay: String

    Account display text, such as the last 4 digits of the credit card number.

    isDefault: Boolean!

    Identifier if payment method is default

    billingAddress: PaymentBillingAddress PREVIEW

    Billing address for end user

    properties: [PaymentMethodProperty] PREVIEW

    Payment method properties depending on the payment method type e.g. For CARD cardHolderName: "Bob Dylan" expirationMonth: "5" expirationYear: "2025" brand: "VISA"

    Parent objects of PaymentMethod

    Payment PREVIEW

    Definition of a payment

    Queries for PaymentMethod

    payment PREVIEW

    Retrieve a payment by id

    paymentByPaymentNumber PREVIEW

    Retrieve a payment by payment number

    paymentMethods PREVIEW

    Retrieve payment methods by party type, party id, company uuid, user uuid