List payment methods

JavaScript

import Whop from '@whop/sdk';

const client = new Whop({
  apiKey: 'My API Key',
});

// Automatically fetches more pages as needed.
for await (const paymentMethodListResponse of client.paymentMethods.list({
  member_id: 'mber_xxxxxxxxxxxxx',
})) {
  console.log(paymentMethodListResponse.id);
}

{
  "data": [
    {
      "id": "payt_xxxxxxxxxxxxx",
      "created_at": "2023-12-01T05:00:00.401Z",
      "payment_method_type": "acss_debit",
      "card": {
        "brand": "mastercard",
        "last4": "<string>",
        "exp_month": 42,
        "exp_year": 42
      }
    }
  ],
  "page_info": {
    "end_cursor": "<string>",
    "start_cursor": "<string>",
    "has_next_page": true,
    "has_previous_page": true
  }
}

GET

payment_methods

JavaScript

import Whop from '@whop/sdk';

const client = new Whop({
  apiKey: 'My API Key',
});

// Automatically fetches more pages as needed.
for await (const paymentMethodListResponse of client.paymentMethods.list({
  member_id: 'mber_xxxxxxxxxxxxx',
})) {
  console.log(paymentMethodListResponse.id);
}

{
  "data": [
    {
      "id": "payt_xxxxxxxxxxxxx",
      "created_at": "2023-12-01T05:00:00.401Z",
      "payment_method_type": "acss_debit",
      "card": {
        "brand": "mastercard",
        "last4": "<string>",
        "exp_month": 42,
        "exp_year": 42
      }
    }
  ],
  "page_info": {
    "end_cursor": "<string>",
    "start_cursor": "<string>",
    "has_next_page": true,
    "has_previous_page": true
  }
}

Authorizations

Authorization

string

header

required

The app API key from an app from the /dashboard/developer page

Query Parameters

after

string | null

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

before

string | null

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

first

integer | null

Returns the first n elements from the list.

Example:

42

last

integer | null

Returns the last n elements from the list.

Example:

42

member_id

string

required

The ID of the Member to list payment methods for

Example:

"mber_xxxxxxxxxxxxx"

direction

enum<string> | null

The direction to sort the payment methods by

Available options:

asc,

desc

created_before

string<date-time> | null

The maximum creation date to filter by

Example:

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

created_after

string<date-time> | null

The minimum creation date to filter by

Example:

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

Response

A successful response

The connection type for PaymentToken.

data

object[]

required

A list of nodes.

Show child attributes

data.id

string

required

The ID of the payment method

Example:

"payt_xxxxxxxxxxxxx"

data.created_at

string<date-time>

required

The date and time the payment method was created

Example:

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

data.payment_method_type

enum<string>

required

The payment method type of the payment method

Available options:

acss_debit,

affirm,

afterpay_clearpay,

alipay,

alma,

amazon_pay,

apple_pay,

au_becs_debit,

bacs_debit,

bancontact,

billie,

blik,

boleto,

card,

cashapp,

crypto,

eps,

fpx,

giropay,

google_pay,

grabpay,

ideal,

kakao_pay,

klarna,

konbini,

kr_card,

link,

mobilepay,

multibanco,

naver_pay,

nz_bank_account,

oxxo,

p24,

pay_by_bank,

payco,

paynow,

pix,

promptpay,

revolut_pay,

samsung_pay,

satispay,

sepa_debit,

sofort,

swish,

twint,

us_bank_account,

wechat_pay,

zip,

bizum,

capchase_pay,

kriya,

mondu,

ng_wallet,

paypay,

sequra,

scalapay,

vipps,

custom,

customer_balance,

gopay,

mb_way,

ng_bank,

ng_bank_transfer,

ng_card,

ng_market,

ng_ussd,

paypal,

payto,

qris,

rechnung,

south_korea_market,

kr_market,

shopeepay,

upi,

sunbit,

netbanking,

id_bank_transfer,

demo_pay,

shop_pay,

sezzle,

coinbase,

splitit,

platform_balance,

apple,

venmo,

unknown

data.card

object

required

The card data associated with the payment method, if its a debit or credit card.

Show child attributes

data.card.brand

enum<string> | null

required

Card brand (e.g., VISA, MASTERCARD).

Available options:

mastercard,

visa,

amex,

discover,

unionpay,

jcb,

diners,

link,

troy,

visadankort,

visabancontact,

china_union_pay,

rupay,

jcbrupay,

elo,

maestro,

unknown

data.card.last4

string | null

required

Last four digits of the card.

data.card.exp_month

integer | null

required

Card expiration month, like 03 for March.

Example:

42

data.card.exp_year

integer | null

required

Card expiration year, like 27 for 2027.

Example:

42

page_info

object

required

Information to aid in pagination.

Show child attributes

page_info.end_cursor

string | null

required

When paginating forwards, the cursor to continue.

page_info.start_cursor

string | null

required

When paginating backwards, the cursor to continue.

page_info.has_next_page

boolean

required

When paginating forwards, are there more items?

page_info.has_previous_page

boolean

required

When paginating backwards, are there more items?

Setupintent canceled Retrieve payment method

⌘I

Introduction

Payins

Payouts

Identity

CRM

Engagement

Courses

Developer

List payment methods

Authorizations

Query Parameters

Response