> ## 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. Addresses a member's wallet when member_id or company_id is given, otherwise your own. Required permissions: - `member:payment_methods:read` ## OpenAPI ````yaml /openapi/api-v1-stable.json get /payment_methods/{id} openapi: 3.1.0 info: 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/ title: Whop API version: 1.0.0 x-api-version-date: '2026-08-21' servers: - description: Production Whop API url: https://api.whop.com/api/v1 - description: Sandbox Whop API url: https://sandbox-api.whop.com/api/v1 security: [] tags: - description: Products name: Products - description: Payments name: Payments - description: Refunds name: Refunds - description: Disputes name: Disputes - description: Dispute alerts name: Dispute alerts - description: Resolution center cases name: Resolution center cases - description: Checkout configurations name: Checkout configurations - description: Setup intents name: Setup intents - description: Payment methods name: Payment methods - description: Invoices name: Invoices - description: Promo codes name: Promo codes - description: Card transactions name: Card transactions - description: Ledger accounts name: Ledger accounts - description: Withdrawals name: Withdrawals - description: Payout methods name: Payout methods - description: Verifications name: Verifications - description: Identity profiles name: Identity profiles - description: Payout accounts name: Payout accounts - description: Topups name: Topups - description: Companies name: Companies - description: Authorized users name: Authorized users - description: Fee markups name: Fee markups - description: Members name: Members - description: Memberships name: Memberships - description: Leads name: Leads - description: Entries name: Entries - description: Shipments name: Shipments - description: Reviews name: Reviews - description: Company token transactions name: Company token transactions - description: Affiliates name: Affiliates - description: Experiences name: Experiences - description: Forums name: Forums - description: Forum posts name: Forum posts - description: Chat channels name: Chat channels - description: Support channels name: Support channels - description: Messages name: Messages - description: Reactions name: Reactions - description: Dm members name: Dm members - description: Dm channels name: Dm channels - description: Notifications name: Notifications - description: Courses name: Courses - description: Course chapters name: Course chapters - description: Course lessons name: Course lessons - description: Course students name: Course students - description: Course lesson interactions name: Course lesson interactions - description: Apps name: Apps - description: Webhooks name: Webhooks - description: App builds name: App builds - description: Access tokens name: Access tokens - description: Account links name: Account links - description: Files name: Files - description: Ai chats name: Ai chats - description: Bounties name: Bounties - description: Stats name: Stats - description: Conversions name: Conversions - description: Ad reports name: Ad reports paths: /payment_methods/{id}: get: tags: - Payment methods summary: Retrieve payment method description: >- Retrieves the details of an existing payment method. Addresses a member's wallet when member_id or company_id is given, otherwise your own. Required permissions: - `member:payment_methods:read` operationId: retrievePaymentMethod parameters: - description: The unique identifier of the payment method. in: path name: id required: true schema: example: payt_xxxxxxxxxxxxx type: string - explode: true in: query name: company_id required: false schema: description: >- 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 type: string style: form - explode: true in: query name: member_id required: false schema: description: >- The unique identifier of the member. Provide either this or company_id, not both. Omit both to address your own saved payment methods. example: mber_xxxxxxxxxxxxx type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaymentMethod' description: A successful response '400': content: application/json: example: error: code: parameter_missing message: 'Missing required parameter: amount.' param: amount type: invalid_request_error schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Bad request '401': content: application/json: example: error: message: Invalid or missing API key type: unauthorized schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Unauthorized '403': content: application/json: example: error: message: You do not have permission to access this resource type: forbidden schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Forbidden '404': content: application/json: example: error: message: Resource not found type: not_found schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Not found '422': content: application/json: example: error: null schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Verification required '429': content: application/json: example: error: null schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Too many requests '500': content: application/json: example: error: message: An unexpected error occurred type: internal_server_error schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Internal server error 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); components: schemas: PaymentMethod: discriminator: propertyName: typename oneOf: - description: A saved payment method with no type-specific details available. properties: created_at: description: >- The time of the event in ISO 8601 UTC format with millisecond precision example: '2023-12-01T05:00:00.401Z' format: date-time type: string icons: description: >- Every rendition of the icon to display this payment method with. A saved card carries its brand's icon (Visa, Mastercard, ...) rather than the generic card art. properties: card: description: The credit-card-proportioned tile (48x30). properties: dark: description: The colorway for dark surfaces. properties: png_1x: description: Raster fallback at the shape's native size. type: string png_2x: description: Raster fallback at double density. type: string png_4x: description: Raster fallback at quadruple density. type: string svg: description: The vector file. Prefer this everywhere SVG renders. type: string required: - svg - png_1x - png_2x - png_4x type: object light: description: The colorway for light surfaces. properties: png_1x: description: Raster fallback at the shape's native size. type: string png_2x: description: Raster fallback at double density. type: string png_4x: description: Raster fallback at quadruple density. type: string svg: description: The vector file. Prefer this everywhere SVG renders. type: string required: - svg - png_1x - png_2x - png_4x type: object required: - light - dark type: object square: description: The square tile (32x32). properties: dark: description: The colorway for dark surfaces. properties: png_1x: description: Raster fallback at the shape's native size. type: string png_2x: description: Raster fallback at double density. type: string png_4x: description: Raster fallback at quadruple density. type: string svg: description: The vector file. Prefer this everywhere SVG renders. type: string required: - svg - png_1x - png_2x - png_4x type: object light: description: The colorway for light surfaces. properties: png_1x: description: Raster fallback at the shape's native size. type: string png_2x: description: Raster fallback at double density. type: string png_4x: description: Raster fallback at quadruple density. type: string svg: description: The vector file. Prefer this everywhere SVG renders. type: string required: - svg - png_1x - png_2x - png_4x type: object required: - light - dark type: object required: - square - card type: object id: 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 type: string 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). typename: const: BasePaymentMethod description: The typename of this object type: string required: - typename - id - created_at - payment_method_type - icons title: BasePaymentMethod type: object - description: >- A saved card payment method, including brand, last four digits, and expiration details. properties: card: description: >- The card-specific details for this payment method, including brand, last four digits, and expiration. properties: brand: description: >- The card network (e.g., visa, mastercard, amex). Null if the brand could not be determined. oneOf: - $ref: '#/components/schemas/CardBrands' - type: 'null' exp_month: description: >- The two-digit expiration month of the card (1-12). Null if not available. example: 42 type: - integer - 'null' exp_year: description: >- The two-digit expiration year of the card (e.g., 27 for 2027). Null if not available. example: 42 type: - integer - 'null' expired: description: >- Whether the card is past its expiration month. An expired card cannot take a new charge. type: boolean fingerprint: description: >- A stable identifier for the underlying card. Two payment methods with the same fingerprint are the same card. Null if not available. type: - string - 'null' funding_type: description: >- How the card is funded by the issuer. Null if the funding type could not be determined. oneOf: - $ref: '#/components/schemas/CardFundingTypes' - type: 'null' last4: description: >- The last four digits of the card number. Null if not available. example: '4242' type: - string - 'null' three_ds_verified: description: >- Whether this card was verified with 3D Secure, either when it was saved or on a payment that used it. type: boolean required: - brand - fingerprint - last4 - exp_month - exp_year - funding_type - expired - three_ds_verified type: object created_at: description: >- The time of the event in ISO 8601 UTC format with millisecond precision example: '2023-12-01T05:00:00.401Z' format: date-time type: string has_payer_document: description: >- Whether this card has the payer identity document required by its payment provider. type: boolean icons: description: >- Every rendition of the icon to display this payment method with. A saved card carries its brand's icon (Visa, Mastercard, ...) rather than the generic card art. properties: card: description: The credit-card-proportioned tile (48x30). properties: dark: description: The colorway for dark surfaces. properties: png_1x: description: Raster fallback at the shape's native size. type: string png_2x: description: Raster fallback at double density. type: string png_4x: description: Raster fallback at quadruple density. type: string svg: description: The vector file. Prefer this everywhere SVG renders. type: string required: - svg - png_1x - png_2x - png_4x type: object light: description: The colorway for light surfaces. properties: png_1x: description: Raster fallback at the shape's native size. type: string png_2x: description: Raster fallback at double density. type: string png_4x: description: Raster fallback at quadruple density. type: string svg: description: The vector file. Prefer this everywhere SVG renders. type: string required: - svg - png_1x - png_2x - png_4x type: object required: - light - dark type: object square: description: The square tile (32x32). properties: dark: description: The colorway for dark surfaces. properties: png_1x: description: Raster fallback at the shape's native size. type: string png_2x: description: Raster fallback at double density. type: string png_4x: description: Raster fallback at quadruple density. type: string svg: description: The vector file. Prefer this everywhere SVG renders. type: string required: - svg - png_1x - png_2x - png_4x type: object light: description: The colorway for light surfaces. properties: png_1x: description: Raster fallback at the shape's native size. type: string png_2x: description: Raster fallback at double density. type: string png_4x: description: Raster fallback at quadruple density. type: string svg: description: The vector file. Prefer this everywhere SVG renders. type: string required: - svg - png_1x - png_2x - png_4x type: object required: - light - dark type: object required: - square - card type: object id: 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. type: string 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). typename: const: CardPaymentMethod description: The typename of this object type: string required: - typename - id - created_at - payment_method_type - icons - has_payer_document - card title: CardPaymentMethod type: object - description: >- A saved US bank account payment method, including bank name, last four digits, and account type. properties: created_at: description: >- The time of the event in ISO 8601 UTC format with millisecond precision example: '2023-12-01T05:00:00.401Z' format: date-time type: string icons: description: >- Every rendition of the icon to display this payment method with. A saved card carries its brand's icon (Visa, Mastercard, ...) rather than the generic card art. properties: card: description: The credit-card-proportioned tile (48x30). properties: dark: description: The colorway for dark surfaces. properties: png_1x: description: Raster fallback at the shape's native size. type: string png_2x: description: Raster fallback at double density. type: string png_4x: description: Raster fallback at quadruple density. type: string svg: description: The vector file. Prefer this everywhere SVG renders. type: string required: - svg - png_1x - png_2x - png_4x type: object light: description: The colorway for light surfaces. properties: png_1x: description: Raster fallback at the shape's native size. type: string png_2x: description: Raster fallback at double density. type: string png_4x: description: Raster fallback at quadruple density. type: string svg: description: The vector file. Prefer this everywhere SVG renders. type: string required: - svg - png_1x - png_2x - png_4x type: object required: - light - dark type: object square: description: The square tile (32x32). properties: dark: description: The colorway for dark surfaces. properties: png_1x: description: Raster fallback at the shape's native size. type: string png_2x: description: Raster fallback at double density. type: string png_4x: description: Raster fallback at quadruple density. type: string svg: description: The vector file. Prefer this everywhere SVG renders. type: string required: - svg - png_1x - png_2x - png_4x type: object light: description: The colorway for light surfaces. properties: png_1x: description: Raster fallback at the shape's native size. type: string png_2x: description: Raster fallback at double density. type: string png_4x: description: Raster fallback at quadruple density. type: string svg: description: The vector file. Prefer this everywhere SVG renders. type: string required: - svg - png_1x - png_2x - png_4x type: object required: - light - dark type: object required: - square - card type: object id: 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. type: string 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). typename: const: UsBankAccountPaymentMethod description: The typename of this object type: string us_bank_account: description: >- The bank account-specific details for this payment method, including bank name and last four digits. properties: account_type: description: The type of bank account (e.g., checking, savings). example: checking type: string bank_name: description: The name of the financial institution holding the account. example: Chase type: string last4: description: The last four digits of the bank account number. example: '6789' type: string required: - bank_name - last4 - account_type type: object required: - typename - id - created_at - payment_method_type - icons - us_bank_account title: UsBankAccountPaymentMethod type: object - description: >- A saved Cash App payment method, including the buyer's cashtag and unique identifier. properties: cashapp: description: >- The Cash App-specific details for this payment method, including cashtag and buyer ID. properties: buyer_id: description: >- The unique and immutable identifier assigned by Cash App to the buyer. Null if not available. example: BUYER_abc123 type: - string - 'null' cashtag: description: >- The public cashtag handle of the buyer on Cash App. Null if not available. example: $jacksmith type: - string - 'null' required: - buyer_id - cashtag type: object created_at: description: >- The time of the event in ISO 8601 UTC format with millisecond precision example: '2023-12-01T05:00:00.401Z' format: date-time type: string icons: description: >- Every rendition of the icon to display this payment method with. A saved card carries its brand's icon (Visa, Mastercard, ...) rather than the generic card art. properties: card: description: The credit-card-proportioned tile (48x30). properties: dark: description: The colorway for dark surfaces. properties: png_1x: description: Raster fallback at the shape's native size. type: string png_2x: description: Raster fallback at double density. type: string png_4x: description: Raster fallback at quadruple density. type: string svg: description: The vector file. Prefer this everywhere SVG renders. type: string required: - svg - png_1x - png_2x - png_4x type: object light: description: The colorway for light surfaces. properties: png_1x: description: Raster fallback at the shape's native size. type: string png_2x: description: Raster fallback at double density. type: string png_4x: description: Raster fallback at quadruple density. type: string svg: description: The vector file. Prefer this everywhere SVG renders. type: string required: - svg - png_1x - png_2x - png_4x type: object required: - light - dark type: object square: description: The square tile (32x32). properties: dark: description: The colorway for dark surfaces. properties: png_1x: description: Raster fallback at the shape's native size. type: string png_2x: description: Raster fallback at double density. type: string png_4x: description: Raster fallback at quadruple density. type: string svg: description: The vector file. Prefer this everywhere SVG renders. type: string required: - svg - png_1x - png_2x - png_4x type: object light: description: The colorway for light surfaces. properties: png_1x: description: Raster fallback at the shape's native size. type: string png_2x: description: Raster fallback at double density. type: string png_4x: description: Raster fallback at quadruple density. type: string svg: description: The vector file. Prefer this everywhere SVG renders. type: string required: - svg - png_1x - png_2x - png_4x type: object required: - light - dark type: object required: - square - card type: object id: 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. type: string 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). typename: const: CashappPaymentMethod description: The typename of this object type: string required: - typename - id - created_at - payment_method_type - icons - cashapp title: CashappPaymentMethod type: object - description: >- A saved iDEAL payment method, including the customer's bank name and BIC code. properties: created_at: description: >- The time of the event in ISO 8601 UTC format with millisecond precision example: '2023-12-01T05:00:00.401Z' format: date-time type: string icons: description: >- Every rendition of the icon to display this payment method with. A saved card carries its brand's icon (Visa, Mastercard, ...) rather than the generic card art. properties: card: description: The credit-card-proportioned tile (48x30). properties: dark: description: The colorway for dark surfaces. properties: png_1x: description: Raster fallback at the shape's native size. type: string png_2x: description: Raster fallback at double density. type: string png_4x: description: Raster fallback at quadruple density. type: string svg: description: The vector file. Prefer this everywhere SVG renders. type: string required: - svg - png_1x - png_2x - png_4x type: object light: description: The colorway for light surfaces. properties: png_1x: description: Raster fallback at the shape's native size. type: string png_2x: description: Raster fallback at double density. type: string png_4x: description: Raster fallback at quadruple density. type: string svg: description: The vector file. Prefer this everywhere SVG renders. type: string required: - svg - png_1x - png_2x - png_4x type: object required: - light - dark type: object square: description: The square tile (32x32). properties: dark: description: The colorway for dark surfaces. properties: png_1x: description: Raster fallback at the shape's native size. type: string png_2x: description: Raster fallback at double density. type: string png_4x: description: Raster fallback at quadruple density. type: string svg: description: The vector file. Prefer this everywhere SVG renders. type: string required: - svg - png_1x - png_2x - png_4x type: object light: description: The colorway for light surfaces. properties: png_1x: description: Raster fallback at the shape's native size. type: string png_2x: description: Raster fallback at double density. type: string png_4x: description: Raster fallback at quadruple density. type: string svg: description: The vector file. Prefer this everywhere SVG renders. type: string required: - svg - png_1x - png_2x - png_4x type: object required: - light - dark type: object required: - square - card type: object id: 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. type: string ideal: description: >- The iDEAL-specific details for this payment method, including bank name and BIC. properties: bank: description: >- The name of the customer's bank used for the iDEAL transaction. Null if not available. example: ing type: - string - 'null' bic: description: >- The Bank Identifier Code (BIC/SWIFT) of the customer's bank. Null if not available. example: INGBNL2A type: - string - 'null' required: - bank - bic type: object 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). typename: const: IdealPaymentMethod description: The typename of this object type: string required: - typename - id - created_at - payment_method_type - icons - ideal title: IdealPaymentMethod type: object - description: >- A saved SEPA Direct Debit payment method, including the bank code, country, and last four IBAN digits. properties: created_at: description: >- The time of the event in ISO 8601 UTC format with millisecond precision example: '2023-12-01T05:00:00.401Z' format: date-time type: string icons: description: >- Every rendition of the icon to display this payment method with. A saved card carries its brand's icon (Visa, Mastercard, ...) rather than the generic card art. properties: card: description: The credit-card-proportioned tile (48x30). properties: dark: description: The colorway for dark surfaces. properties: png_1x: description: Raster fallback at the shape's native size. type: string png_2x: description: Raster fallback at double density. type: string png_4x: description: Raster fallback at quadruple density. type: string svg: description: The vector file. Prefer this everywhere SVG renders. type: string required: - svg - png_1x - png_2x - png_4x type: object light: description: The colorway for light surfaces. properties: png_1x: description: Raster fallback at the shape's native size. type: string png_2x: description: Raster fallback at double density. type: string png_4x: description: Raster fallback at quadruple density. type: string svg: description: The vector file. Prefer this everywhere SVG renders. type: string required: - svg - png_1x - png_2x - png_4x type: object required: - light - dark type: object square: description: The square tile (32x32). properties: dark: description: The colorway for dark surfaces. properties: png_1x: description: Raster fallback at the shape's native size. type: string png_2x: description: Raster fallback at double density. type: string png_4x: description: Raster fallback at quadruple density. type: string svg: description: The vector file. Prefer this everywhere SVG renders. type: string required: - svg - png_1x - png_2x - png_4x type: object light: description: The colorway for light surfaces. properties: png_1x: description: Raster fallback at the shape's native size. type: string png_2x: description: Raster fallback at double density. type: string png_4x: description: Raster fallback at quadruple density. type: string svg: description: The vector file. Prefer this everywhere SVG renders. type: string required: - svg - png_1x - png_2x - png_4x type: object required: - light - dark type: object required: - square - card type: object id: 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. type: string 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: description: >- The SEPA Direct Debit-specific details for this payment method, including bank code and last four IBAN digits. properties: bank_code: description: >- The bank code of the financial institution associated with this SEPA account. Null if not available. example: '37040044' type: - string - 'null' branch_code: description: >- The branch code of the financial institution associated with this SEPA account. Null if not available. example: '0532' type: - string - 'null' country: description: >- The two-letter ISO country code where the bank account is located. Null if not available. example: DE type: - string - 'null' last4: description: >- The last four digits of the IBAN associated with this SEPA account. Null if not available. example: '3000' type: - string - 'null' required: - bank_code - branch_code - country - last4 type: object typename: const: SepaDebitPaymentMethod description: The typename of this object type: string required: - typename - id - created_at - payment_method_type - icons - sepa_debit title: SepaDebitPaymentMethod type: object - description: >- A Whop balance the buyer can pay with — their own, or an account's they hold permission to spend. Charged by naming its ledger id on a `saved` confirmation token — it is a live wallet, not a stored credential, so it cannot be vaulted or charged off-session. properties: created_at: description: >- The time of the event in ISO 8601 UTC format with millisecond precision example: '2023-12-01T05:00:00.401Z' format: date-time type: string icons: description: >- Every rendition of the icon to display this payment method with. A saved card carries its brand's icon (Visa, Mastercard, ...) rather than the generic card art. properties: card: description: The credit-card-proportioned tile (48x30). properties: dark: description: The colorway for dark surfaces. properties: png_1x: description: Raster fallback at the shape's native size. type: string png_2x: description: Raster fallback at double density. type: string png_4x: description: Raster fallback at quadruple density. type: string svg: description: The vector file. Prefer this everywhere SVG renders. type: string required: - svg - png_1x - png_2x - png_4x type: object light: description: The colorway for light surfaces. properties: png_1x: description: Raster fallback at the shape's native size. type: string png_2x: description: Raster fallback at double density. type: string png_4x: description: Raster fallback at quadruple density. type: string svg: description: The vector file. Prefer this everywhere SVG renders. type: string required: - svg - png_1x - png_2x - png_4x type: object required: - light - dark type: object square: description: The square tile (32x32). properties: dark: description: The colorway for dark surfaces. properties: png_1x: description: Raster fallback at the shape's native size. type: string png_2x: description: Raster fallback at double density. type: string png_4x: description: Raster fallback at quadruple density. type: string svg: description: The vector file. Prefer this everywhere SVG renders. type: string required: - svg - png_1x - png_2x - png_4x type: object light: description: The colorway for light surfaces. properties: png_1x: description: Raster fallback at the shape's native size. type: string png_2x: description: Raster fallback at double density. type: string png_4x: description: Raster fallback at quadruple density. type: string svg: description: The vector file. Prefer this everywhere SVG renders. type: string required: - svg - png_1x - png_2x - png_4x type: object required: - light - dark type: object required: - square - card type: object id: 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. type: string 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). platform_balance: description: >- What is available to spend, and whether the account may spend it. properties: account: description: >- The account whose wallet this is. Null for the buyer's own personal wallet. A buyer sees an account's balance here when they hold permission to spend it, so a list can hold several — their own and one per account they are on. properties: id: description: The unique identifier for the company. example: biz_xxxxxxxxxxxxxx type: string logo: description: The company's logo. properties: url: description: >- A pre-optimized URL for rendering this attachment on the client. This should be used for displaying attachments in apps. example: https://media.whop.com/abc123/optimized.jpg type: - string - 'null' required: - url type: - object - 'null' title: description: The display name of the company shown to customers. example: Pickaxe type: string required: - id - title - logo type: - object - 'null' balances: description: >- Available amount per currency. Read from the balance cache, so it is indicative — the charge revalidates against settled funds and may still refuse. items: description: >- An amount of money. Never a bare number, because a bare number cannot answer the two questions a client has to answer to render it: what currency is this, and how many digits do I write? The second is stated twice rather than derived, because the digits the amount CARRIES and the digits to SHOW differ in COP — charged in centavos, written in whole pesos. Formatting is deliberately left to the caller: the number belongs in the buyer's locale, and this API does not know it. properties: amount: description: >- The amount in major units, as an exact decimal string — `"10.00"` is ten dollars. A string so no float rounds it in transit. example: '52.10' type: string currency: $ref: '#/components/schemas/Currencies' description: Three-letter ISO 4217 currency code, lowercase. decimals: description: >- How many decimal places the amount CARRIES — the precision the charge itself runs at. example: 2 type: integer display_decimals: description: >- How many decimal places to SHOW. Usually equal to `decimals`, and deliberately not always: COP is charged in centavos but written in whole pesos, so it is `2` and `0`. Format the number in your own locale using this. example: 2 type: integer required: - currency - amount - decimals - display_decimals type: object type: array spendable: description: >- Whether this balance can pay right now, which here means only whether it holds funds — an account blocked from spending is not listed at all. A zero balance is still returned so a client can show it as an option the buyer could top up. type: boolean required: - spendable - account - balances type: object typename: const: PlatformBalancePaymentMethod description: The typename of this object type: string required: - typename - id - created_at - payment_method_type - icons - platform_balance title: PlatformBalancePaymentMethod type: object type: object PaymentMethodTypes: description: The different types of payment methods that can be used. enum: - 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 type: string CardBrands: description: Possible card brands that a payment token can have 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 - aura - unknown type: string CardFundingTypes: description: The funding types of a card enum: - credit - debit - prepaid type: string Currencies: description: The available currencies on the platform enum: - usd - sgd - inr - aud - brl - cad - dkk - eur - nok - gbp - sek - chf - hkd - huf - jpy - mxn - myr - pln - czk - nzd - aed - eth - ape - cop - ron - thb - bgn - idr - dop - php - try - krw - twd - vnd - pkr - clp - uyu - ars - zar - dzd - tnd - mad - kes - kwd - jod - all - xcd - amd - bsd - bhd - bob - bam - khr - crc - xof - egp - etb - gmd - ghs - gtq - gyd - ils - jmd - mop - mga - mur - mdl - mnt - nad - ngn - mkd - omr - pyg - pen - qar - rwf - sar - rsd - lkr - tzs - ttd - uzs - rub - btc - cny - usdt - kzt - awg - whop_usd - xau type: string securitySchemes: bearerAuth: bearerFormat: auth-scheme description: >- An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with `Bearer`, for example `Bearer ***************************`. scheme: bearer type: http ````