> ## Documentation Index > Fetch the complete documentation index at: https://docs.whop.com/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve payment method > Retrieves the details of an existing payment method. Required permissions: - `member:payment_methods:read` ## OpenAPI ````yaml https://app.stainless.com/api/spec/documented/whopsdk/openapi.documented.yml get /payment_methods/{id} openapi: 3.1.0 info: title: Whop API description: >- The Whop REST API. Please see https://docs.whop.com/developer/api/getting-started for more details. termsOfService: https://whop.com/tos-developer-api/ version: 1.0.0 servers: - url: https://api.whop.com/api/v1 description: Production Whop API security: [] tags: - name: Products description: Products - name: Plans description: Plans - name: Payments description: Payments - name: Refunds description: Refunds - name: Disputes description: Disputes - name: Dispute alerts description: Dispute alerts - name: Resolution center cases description: Resolution center cases - name: Checkout configurations description: Checkout configurations - name: Setup intents description: Setup intents - name: Payment methods description: Payment methods - name: Invoices description: Invoices - name: Promo codes description: Promo codes - name: Card transactions description: Card transactions - name: Ledger accounts description: Ledger accounts - name: Transfers description: Transfers - name: Withdrawals description: Withdrawals - name: Payout methods description: Payout methods - name: Verifications description: Verifications - name: Payout accounts description: Payout accounts - name: Topups description: Topups - name: Users description: Users - name: Companies description: Companies - name: Authorized users description: Authorized users - name: Fee markups description: Fee markups - name: Members description: Members - name: Memberships description: Memberships - name: Leads description: Leads - name: Entries description: Entries - name: Shipments description: Shipments - name: Reviews description: Reviews - name: Company token transactions description: Company token transactions - name: Affiliates description: Affiliates - name: Experiences description: Experiences - name: Forums description: Forums - name: Forum posts description: Forum posts - name: Chat channels description: Chat channels - name: Support channels description: Support channels - name: Messages description: Messages - name: Reactions description: Reactions - name: Dm members description: Dm members - name: Dm channels description: Dm channels - name: Notifications description: Notifications - name: Courses description: Courses - name: Course chapters description: Course chapters - name: Course lessons description: Course lessons - name: Course students description: Course students - name: Course lesson interactions description: Course lesson interactions - name: Apps description: Apps - name: Webhooks description: Webhooks - name: App builds description: App builds - name: Access tokens description: Access tokens - name: Account links description: Account links - name: Files description: Files - name: Ai chats description: Ai chats - name: Bounties description: Bounties - name: Stats description: Stats - name: Ad campaigns description: Ad campaigns - name: Ad groups description: Ad groups - name: Ads description: Ads - name: Conversions description: Conversions paths: /payment_methods/{id}: get: tags: - Payment methods summary: Retrieve payment method description: |- Retrieves the details of an existing payment method. Required permissions: - `member:payment_methods:read` operationId: retrievePaymentMethod parameters: - name: id in: path required: true description: The unique identifier of the payment method. schema: type: string example: payt_xxxxxxxxxxxxx - name: company_id in: query required: false schema: type: - string - 'null' description: >- The unique identifier of the company. Provide either this or member_id, not both. example: biz_xxxxxxxxxxxxxx explode: true style: form - name: member_id in: query required: false schema: type: - string - 'null' description: >- The unique identifier of the member. Provide either this or company_id, not both. example: mber_xxxxxxxxxxxxx explode: true style: form responses: '200': description: A successful response content: application/json: schema: $ref: '#/components/schemas/PaymentMethod' '400': description: Bad request content: application/json: schema: type: object properties: error: type: object properties: type: type: string message: type: string code: type: - string - 'null' description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' param: type: - string - 'null' description: The parameter that caused the error, if applicable required: - type - message required: - error example: error: type: invalid_request_error code: parameter_missing message: 'Missing required parameter: amount.' param: amount '401': description: Unauthorized content: application/json: schema: type: object properties: error: type: object properties: type: type: string message: type: string code: type: - string - 'null' description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' param: type: - string - 'null' description: The parameter that caused the error, if applicable required: - type - message required: - error example: error: type: unauthorized message: Invalid or missing API key '403': description: Forbidden content: application/json: schema: type: object properties: error: type: object properties: type: type: string message: type: string code: type: - string - 'null' description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' param: type: - string - 'null' description: The parameter that caused the error, if applicable required: - type - message required: - error example: error: type: forbidden message: You do not have permission to access this resource '404': description: Not found content: application/json: schema: type: object properties: error: type: object properties: type: type: string message: type: string code: type: - string - 'null' description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' param: type: - string - 'null' description: The parameter that caused the error, if applicable required: - type - message required: - error example: error: type: not_found message: Resource not found '422': description: Verification required content: application/json: schema: type: object properties: error: type: object properties: type: type: string message: type: string code: type: - string - 'null' description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' param: type: - string - 'null' description: The parameter that caused the error, if applicable required: - type - message required: - error example: error: null '500': description: Internal server error content: application/json: schema: type: object properties: error: type: object properties: type: type: string message: type: string code: type: - string - 'null' description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' param: type: - string - 'null' description: The parameter that caused the error, if applicable required: - type - message required: - error example: error: type: internal_server_error message: An unexpected error occurred security: - bearerAuth: - member:payment_methods:read x-codeSamples: - lang: JavaScript source: >- 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); - lang: Python source: |- import os from whop_sdk import Whop client = Whop( api_key=os.environ.get("WHOP_API_KEY"), # This is the default and can be omitted ) payment_method = client.payment_methods.retrieve( id="payt_xxxxxxxxxxxxx", ) print(payment_method) - lang: Ruby source: |- require "whop_sdk" whop = WhopSDK::Client.new(api_key: "My API Key") payment_method = whop.payment_methods.retrieve("payt_xxxxxxxxxxxxx") puts(payment_method) components: schemas: PaymentMethod: type: object oneOf: - type: object properties: typename: type: string const: BasePaymentMethod description: The typename of this object id: type: string description: >- Represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`) input value will be accepted as an ID. example: payt_xxxxxxxxxxxxx created_at: type: string format: date-time description: >- The time of the event in ISO 8601 UTC format with millisecond precision example: '2023-12-01T05:00:00.401Z' payment_method_type: $ref: '#/components/schemas/PaymentMethodTypes' description: >- The type of payment instrument stored on file (e.g., card, us_bank_account, cashapp, ideal, sepa_debit). required: - typename - id - created_at - payment_method_type description: A saved payment method with no type-specific details available. title: BasePaymentMethod - type: object properties: typename: type: string const: CardPaymentMethod description: The typename of this object id: type: string description: >- Represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`) input value will be accepted as an ID. created_at: type: string format: date-time description: >- The time of the event in ISO 8601 UTC format with millisecond precision example: '2023-12-01T05:00:00.401Z' payment_method_type: $ref: '#/components/schemas/PaymentMethodTypes' description: >- The type of payment instrument stored on file (e.g., card, us_bank_account, cashapp, ideal, sepa_debit). card: type: object properties: brand: oneOf: - $ref: '#/components/schemas/CardBrands' - type: 'null' description: >- The card network (e.g., visa, mastercard, amex). Null if the brand could not be determined. last4: type: - string - 'null' description: >- The last four digits of the card number. Null if not available. example: '4242' exp_month: type: - integer - 'null' description: >- The two-digit expiration month of the card (1-12). Null if not available. example: 42 exp_year: type: - integer - 'null' description: >- The two-digit expiration year of the card (e.g., 27 for 2027). Null if not available. example: 42 required: - brand - last4 - exp_month - exp_year description: >- The card-specific details for this payment method, including brand, last four digits, and expiration. required: - typename - id - created_at - payment_method_type - card description: >- A saved card payment method, including brand, last four digits, and expiration details. title: CardPaymentMethod - type: object properties: typename: type: string const: UsBankAccountPaymentMethod description: The typename of this object id: type: string description: >- Represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`) input value will be accepted as an ID. created_at: type: string format: date-time description: >- The time of the event in ISO 8601 UTC format with millisecond precision example: '2023-12-01T05:00:00.401Z' payment_method_type: $ref: '#/components/schemas/PaymentMethodTypes' description: >- The type of payment instrument stored on file (e.g., card, us_bank_account, cashapp, ideal, sepa_debit). us_bank_account: type: object properties: bank_name: type: string description: The name of the financial institution holding the account. example: Chase last4: type: string description: The last four digits of the bank account number. example: '6789' account_type: type: string description: The type of bank account (e.g., checking, savings). example: checking required: - bank_name - last4 - account_type description: >- The bank account-specific details for this payment method, including bank name and last four digits. required: - typename - id - created_at - payment_method_type - us_bank_account description: >- A saved US bank account payment method, including bank name, last four digits, and account type. title: UsBankAccountPaymentMethod - type: object properties: typename: type: string const: CashappPaymentMethod description: The typename of this object id: type: string description: >- Represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`) input value will be accepted as an ID. created_at: type: string format: date-time description: >- The time of the event in ISO 8601 UTC format with millisecond precision example: '2023-12-01T05:00:00.401Z' payment_method_type: $ref: '#/components/schemas/PaymentMethodTypes' description: >- The type of payment instrument stored on file (e.g., card, us_bank_account, cashapp, ideal, sepa_debit). cashapp: type: object properties: buyer_id: type: - string - 'null' description: >- The unique and immutable identifier assigned by Cash App to the buyer. Null if not available. example: BUYER_abc123 cashtag: type: - string - 'null' description: >- The public cashtag handle of the buyer on Cash App. Null if not available. example: $jacksmith required: - buyer_id - cashtag description: >- The Cash App-specific details for this payment method, including cashtag and buyer ID. required: - typename - id - created_at - payment_method_type - cashapp description: >- A saved Cash App payment method, including the buyer's cashtag and unique identifier. title: CashappPaymentMethod - type: object properties: typename: type: string const: IdealPaymentMethod description: The typename of this object id: type: string description: >- Represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`) input value will be accepted as an ID. created_at: type: string format: date-time description: >- The time of the event in ISO 8601 UTC format with millisecond precision example: '2023-12-01T05:00:00.401Z' payment_method_type: $ref: '#/components/schemas/PaymentMethodTypes' description: >- The type of payment instrument stored on file (e.g., card, us_bank_account, cashapp, ideal, sepa_debit). ideal: type: object properties: bank: type: - string - 'null' description: >- The name of the customer's bank used for the iDEAL transaction. Null if not available. example: ing bic: type: - string - 'null' description: >- The Bank Identifier Code (BIC/SWIFT) of the customer's bank. Null if not available. example: INGBNL2A required: - bank - bic description: >- The iDEAL-specific details for this payment method, including bank name and BIC. required: - typename - id - created_at - payment_method_type - ideal description: >- A saved iDEAL payment method, including the customer's bank name and BIC code. title: IdealPaymentMethod - type: object properties: typename: type: string const: SepaDebitPaymentMethod description: The typename of this object id: type: string description: >- Represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`) input value will be accepted as an ID. created_at: type: string format: date-time description: >- The time of the event in ISO 8601 UTC format with millisecond precision example: '2023-12-01T05:00:00.401Z' payment_method_type: $ref: '#/components/schemas/PaymentMethodTypes' description: >- The type of payment instrument stored on file (e.g., card, us_bank_account, cashapp, ideal, sepa_debit). sepa_debit: type: object properties: bank_code: type: - string - 'null' description: >- The bank code of the financial institution associated with this SEPA account. Null if not available. example: '37040044' branch_code: type: - string - 'null' description: >- The branch code of the financial institution associated with this SEPA account. Null if not available. example: '0532' country: type: - string - 'null' description: >- The two-letter ISO country code where the bank account is located. Null if not available. example: DE last4: type: - string - 'null' description: >- The last four digits of the IBAN associated with this SEPA account. Null if not available. example: '3000' required: - bank_code - branch_code - country - last4 description: >- The SEPA Direct Debit-specific details for this payment method, including bank code and last four IBAN digits. required: - typename - id - created_at - payment_method_type - sepa_debit description: >- A saved SEPA Direct Debit payment method, including the bank code, country, and last four IBAN digits. title: SepaDebitPaymentMethod discriminator: propertyName: typename PaymentMethodTypes: type: string enum: - acss_debit - affirm - afterpay_clearpay - alipay - alma - amazon_pay - apple - apple_pay - au_bank_transfer - au_becs_debit - bacs_debit - bancolombia - bancontact - 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 - 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 - 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 description: The different types of payment methods that can be used. CardBrands: type: string enum: - 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 - unknown description: Possible card brands that a payment token can have securitySchemes: bearerAuth: type: http description: >- A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like `Bearer ***************************` scheme: bearer bearerFormat: auth-scheme ````