List payment methods

Returns a paginated list of payment methods for a member or company, or for the authenticated user when neither is given, with optional filtering by creation date. A payment method is a stored representation of how a customer intends to pay, such as a card, bank account, or digital wallet.

Required permissions:

• member:payment_methods:read

GET /payment_methods

JavaScript

JavaScript

import Whop from '@whop/sdk';

const client = new Whop({
  apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const paymentMethodListResponse of client.paymentMethods.list()) {
  console.log(paymentMethodListResponse);
}

200

{
  "data": [
    {
      "created_at": "2023-12-01T05:00:00.401Z",
      "icons": {
        "card": {
          "dark": {
            "png_1x": "<string>",
            "png_2x": "<string>",
            "png_4x": "<string>",
            "svg": "<string>"
          },
          "light": {
            "png_1x": "<string>",
            "png_2x": "<string>",
            "png_4x": "<string>",
            "svg": "<string>"
          }
        },
        "square": {
          "dark": {
            "png_1x": "<string>",
            "png_2x": "<string>",
            "png_4x": "<string>",
            "svg": "<string>"
          },
          "light": {
            "png_1x": "<string>",
            "png_2x": "<string>",
            "png_4x": "<string>",
            "svg": "<string>"
          }
        }
      },
      "id": "payt_xxxxxxxxxxxxx",
      "payment_method_type": "acss_debit",
      "typename": "BasePaymentMethod"
    }
  ],
  "page_info": {
    "end_cursor": "<string>",
    "has_next_page": true,
    "has_previous_page": true,
    "start_cursor": "<string>"
  }
}

Authorizations

Authorization · string · header · required

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Query Parameters

after · string

Returns the elements in the list that come after the specified cursor.

before · string

Returns the elements in the list that come before the specified cursor.

first · integer

Returns the first n elements from the list.

Example:

42

last · integer

Returns the last n elements from the list.

Example:

42

member_id · string

The unique identifier of the member to list payment methods for. Omit this and company_id to list your own saved payment methods.

Example:

"mber_xxxxxxxxxxxxx"

company_id · string

The unique identifier of the company. Provide either this or member_id, not both. Omit both to address your own saved payment methods.

Example:

"biz_xxxxxxxxxxxxxx"

direction · enum<string>

The sort direction for ordering results, either ascending or descending.

Available options: asc, desc

created_before · string<date-time>

Only return payment methods created before this timestamp.

Example:

"2023-12-01T05:00:00.401Z"

created_after · string<date-time>

Only return payment methods created after this timestamp.

Example:

"2023-12-01T05:00:00.401Z"

future_usage · enum<string>

Only return methods that can be charged this way after the buyer leaves. A checkout that renews should pass off_session, which drops the buyer's platform balance — a balance settles against the ledger at the time of purchase and cannot be charged later.

Available options: off_session, on_session

payment_method_types · enum<string>[]

Only return payment methods of these types. Pass the eligible type values from the payment method types catalogue so the list holds nothing the purchase cannot take. An empty list returns no payment methods.

The different types of payment methods that can be used.

Available options: acss_debit, addi, affirm, afterpay_clearpay, alipay, alma, amazon_pay, apple, apple_pay, au_bank_transfer, au_becs_debit, bacs_debit, bancolombia, bancontact, bank_wire, billie, bizum, blik, boleto, bre_b, ca_bank_transfer, capchase_pay, card, card_installments_three, card_installments_six, card_installments_twelve, cashapp, claritypay, coinbase, crypto, custom, customer_balance, demo_pay, efecty, eps, eu_bank_transfer, fpx, gb_bank_transfer, giropay, google_pay, gopay, grabpay, id_bank_transfer, ideal, interac, kakao_pay, klarna, klarna_pay_now, konbini, kr_card, kr_market, kriya, kueski, link, mb_way, m_pesa, mercado_pago, mobilepay, modo, mondu, multibanco, naver_pay, nequi, netbanking, ng_bank, ng_bank_transfer, ng_card, ng_market, ng_ussd, ng_wallet, nz_bank_account, oxxo, p24, pago_efectivo, pse, pay_by_bank, payco, paynow, paypal, paypay, payto, pix, platform_balance, promptpay, qris, rapipago, rechnung, revolut_pay, samsung_pay, satispay, scalapay, sencillito, sepa_debit, sequra, servipag, sezzle, shop_pay, shopeepay, sofort, south_korea_market, spei, splitit, sunbit, swish, tamara, twint, upi, us_bank_account, us_bank_transfer, venmo, vipps, webpay, wechat_pay, yape, zip, coinflow, unknown

card_brands · enum<string>[]

Only return cards on these networks, such as the networks the seller accepts. Payment methods that are not cards are unaffected.

Possible card brands that a payment token can have

Available options: mastercard, visa, amex, discover, unionpay, jcb, diners, link, troy, visadankort, visabancontact, china_union_pay, rupay, jcbrupay, elo, maestro, tarjeta_naranja, cirrus, nspk_mir, verve, ebt, private_label, local_brand, uatp, wexcard, uzcard, meeza, hrg_store_card, girocard, fuel_card, dankort, carnet, atm_card, china_union_payuzcard, codensa, cabal, hipercard, jcblankapay, cmi, aura, unknown

card_funding_types · enum<string>[]

Only return cards funded this way. A card whose funding could not be determined is excluded, and payment methods that are not cards are unaffected.

The funding types of a card

Available options: credit, debit, prepaid

has_payer_document · boolean

Filter cards by whether they carry the payer identity document their payment provider requires. Payment methods that are not cards are unaffected.

expired · boolean

Filter by expiry. Only a card can expire, so false keeps every payment method that is not past its expiration month and true returns expired cards alone.

broken · boolean

Filter by whether the stored credential has permanently stopped charging, such as a vault entry its provider closed.

Response

200

application/json

A successful response

The connection type for PaymentMethodInterface.

data · (BasePaymentMethod · object | CardPaymentMethod · object | UsBankAccountPaymentMethod · object | CashappPaymentMethod · object | IdealPaymentMethod · object | SepaDebitPaymentMethod · object | PlatformBalancePaymentMethod · object)[] · required

A list of nodes.

A saved payment method with no type-specific details available.

BasePaymentMethod

CardPaymentMethod

UsBankAccountPaymentMethod

CashappPaymentMethod

IdealPaymentMethod

SepaDebitPaymentMethod

PlatformBalancePaymentMethod

Show child attributes

page_info · object · required

Information to aid in pagination.

Show child attributes