Skip to main content
GET
/
payment_methods
/
{id}
JavaScript
import Whop from '@whop/sdk';

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

const paymentMethod = await client.paymentMethods.retrieve('payt_xxxxxxxxxxxxx');

console.log(paymentMethod);
{
  "typename": "<string>",
  "id": "<string>",
  "created_at": "2023-12-01T05:00:00.401Z",
  "payment_method_type": "afterpay_clearpay"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

The ID of the PaymentMethod

Example:

"payt_xxxxxxxxxxxxx"

Query Parameters

​
company_id
string | null

The ID of the Company. Provide either this or member_id (not both).

Example:

"biz_xxxxxxxxxxxxxx"

​
member_id
string | null

The ID of the Member. Provide either this or company_id (not both).

Example:

"mber_xxxxxxxxxxxxx"

Response

A successful response

A payment method with no additional properties

​
typename
string
required

The typename of this object

Allowed value: "BasePaymentMethod"
​
id
string
required

The ID of the payment method

​
created_at
string<date-time>
required

When the payment method was created

Example:

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

​
payment_method_type
enum<string>
required

The type of the payment method

Available options:
afterpay_clearpay,
alipay,
amazon_pay,
apple_pay,
bancontact,
card,
cashapp,
crypto,
google_pay,
ideal,
klarna,
mobilepay,
sepa_debit,
swish,
twint,
us_bank_account,
zip,
vipps,
paypal,
sezzle,
coinbase,
splitit,
platform_balance,
apple,
venmo,
affirm,
multibanco,
wechat_pay,
naver_pay,
nz_bank_account,
oxxo,
p24,
pay_by_bank,
payco,
paynow,
pix,
promptpay,
revolut_pay,
samsung_pay,
satispay,
sofort,
konbini,
kr_card,
link,
grabpay,
kakao_pay,
billie,
blik,
boleto,
eps,
fpx,
giropay,
acss_debit,
alma,
au_becs_debit,
bacs_debit,
bizum,
capchase_pay,
kriya,
mondu,
ng_wallet,
paypay,
sequra,
scalapay,
custom,
customer_balance,
gopay,
mb_way,
ng_bank,
ng_bank_transfer,
ng_card,
ng_market,
ng_ussd,
payto,
qris,
rechnung,
south_korea_market,
kr_market,
shopeepay,
upi,
sunbit,
netbanking,
id_bank_transfer,
demo_pay,
shop_pay,
unknown