paymentMethodTokens

QUERY

Returns payment method tokens.

Arguments

query

SqlQuery

The query to filter the payment_method_tokens with based on Pay Theory defined data. Detailed information about the query object can be found here.

limit

Int

The number of payment_method_tokens to return.

offset

String

The value of the offset item for which the list is being sorted.

direction

MoveDirection

The direction of the pagination. Makes sure the results are returned in the correct order.

Values

BACKWARDFORWARD

offset_id

String

The payment_method_id of the offset item.

Nested field arguments

Pass these arguments when selecting the corresponding response fields.

items.payor.query_list

[QueryPair]

When selected, filters payment method token rows by payor fields such as email.

Response

PaymentMethodTokens

items

[PaymentMethodToken]| null

List of Payment Method Tokens.

total_row_count

Int| null

Total number of rows matching the query.

Examples

List saved payment methods

Filters by merchant and returns up to two matching methods with their brand, last four digits, and active status.

SUCCESS 200

GRAPHQL

query PaymentMethodTokens($query: SqlQuery, $limit: Int) {
    paymentMethodTokens(query: $query, limit: $limit) {
      items {
        payment_method_id
        merchant_uid
        payment_type
        last_four
        card_brand
        card_type
        exp_date
        full_name
        is_active
        wallet_type
      }
      total_row_count
    }
  }